@openui5/ts-types 1.144.0 → 1.146.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.146.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -175,6 +175,8 @@ declare namespace sap {
175
175
  extends sap.tnt.$NavigationListItemBaseSettings {
176
176
  /**
177
177
  * Specifies the icon for the item.
178
+ *
179
+ * **Note:** By design, icons on second-level (child) navigation items are not rendered.
178
180
  */
179
181
  icon?:
180
182
  | sap.ui.core.URI
@@ -205,8 +207,6 @@ declare namespace sap {
205
207
  * - Items that trigger actions (with design "Action") should not be selectable.
206
208
  *
207
209
  * @since 1.116
208
- * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
209
- * may be done before its official public release.
210
210
  */
211
211
  selectable?:
212
212
  | boolean
@@ -236,11 +236,10 @@ declare namespace sap {
236
236
  target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
237
237
 
238
238
  /**
239
- * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
240
- * sub-items can't be added.
239
+ * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`,
240
+ * sub-items cannot be added.
241
241
  *
242
242
  * @since 1.133.0
243
- * @experimental Behavior might change.
244
243
  */
245
244
  design?:
246
245
  | sap.tnt.NavigationListItemDesign
@@ -417,8 +416,9 @@ declare namespace sap {
417
416
  interface $ToolPageSettings extends sap.ui.core.$ControlSettings {
418
417
  /**
419
418
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
420
- * **Note:** By default, on small screens, the side content is collapsed to provide more space for the main
421
- * content. On larger screens, it is expanded. This behavior can be overridden by setting this property.
419
+ * **Note:** By default, on mobile phone devices and small screens, the side content is collapsed to provide
420
+ * more space for the main content. On larger screens, excluding mobile phone devices, it is expanded. This
421
+ * behavior can be overridden by setting this property.
422
422
  */
423
423
  sideExpanded?:
424
424
  | boolean
@@ -1727,13 +1727,12 @@ declare namespace sap {
1727
1727
  /**
1728
1728
  * Gets current value of property {@link #getDesign design}.
1729
1729
  *
1730
- * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
1731
- * sub-items can't be added.
1730
+ * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`,
1731
+ * sub-items cannot be added.
1732
1732
  *
1733
1733
  * Default value is `Default`.
1734
1734
  *
1735
1735
  * @since 1.133.0
1736
- * @experimental Behavior might change.
1737
1736
  *
1738
1737
  * @returns Value of property `design`
1739
1738
  */
@@ -1753,6 +1752,8 @@ declare namespace sap {
1753
1752
  *
1754
1753
  * Specifies the icon for the item.
1755
1754
  *
1755
+ * **Note:** By design, icons on second-level (child) navigation items are not rendered.
1756
+ *
1756
1757
  * Default value is `empty string`.
1757
1758
  *
1758
1759
  *
@@ -1783,8 +1784,6 @@ declare namespace sap {
1783
1784
  * Default value is `true`.
1784
1785
  *
1785
1786
  * @since 1.116
1786
- * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
1787
- * may be done before its official public release.
1788
1787
  *
1789
1788
  * @returns Value of property `selectable`
1790
1789
  */
@@ -1892,15 +1891,14 @@ declare namespace sap {
1892
1891
  /**
1893
1892
  * Sets a new value for property {@link #getDesign design}.
1894
1893
  *
1895
- * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
1896
- * sub-items can't be added.
1894
+ * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`,
1895
+ * sub-items cannot be added.
1897
1896
  *
1898
1897
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1899
1898
  *
1900
1899
  * Default value is `Default`.
1901
1900
  *
1902
1901
  * @since 1.133.0
1903
- * @experimental Behavior might change.
1904
1902
  *
1905
1903
  * @returns Reference to `this` in order to allow method chaining
1906
1904
  */
@@ -1932,6 +1930,8 @@ declare namespace sap {
1932
1930
  *
1933
1931
  * Specifies the icon for the item.
1934
1932
  *
1933
+ * **Note:** By design, icons on second-level (child) navigation items are not rendered.
1934
+ *
1935
1935
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1936
1936
  *
1937
1937
  * Default value is `empty string`.
@@ -1965,8 +1965,6 @@ declare namespace sap {
1965
1965
  * Default value is `true`.
1966
1966
  *
1967
1967
  * @since 1.116
1968
- * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
1969
- * may be done before its official public release.
1970
1968
  *
1971
1969
  * @returns Reference to `this` in order to allow method chaining
1972
1970
  */
@@ -2781,10 +2779,14 @@ declare namespace sap {
2781
2779
  * - If an app implements side navigation in addition to the tool header menu, the menu icon must be the
2782
2780
  * first item on the left-hand side of the tool header.
2783
2781
  * - The app menu and the side navigation must not have any dependencies and must work independently.
2784
- * Horizon theme specifics: Only the following controls are supported: sap.m.Button, sap.m.Image,
2785
- * sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori 3 Default
2786
- * theme the ToolHeader is with dark design unlike most of the other controls. This defines the usage of
2787
- * limited controls inside it, which will result in good design combination.
2782
+ *
2783
+ * - Not recommended: In accordance with the UX Consistency initiative, it is recommended to use the seamlessly
2784
+ * integrated UI5 Web Components' ui5-shellbar, as demonstrated in this UXC
2785
+ * integration sample app with UXC integration
2786
+ * sample source code. Horizon theme specifics: Only the following controls are supported: sap.m.Button,
2787
+ * sap.m.Image, sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori
2788
+ * 3 Default theme the ToolHeader is with dark design unlike most of the other controls. This defines the
2789
+ * usage of limited controls inside it, which will result in good design combination.
2788
2790
  * The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design
2789
2791
  * requirement. However, that's not a dark theme.
2790
2792
  *
@@ -3102,8 +3104,9 @@ declare namespace sap {
3102
3104
  * Gets current value of property {@link #getSideExpanded sideExpanded}.
3103
3105
  *
3104
3106
  * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation.
3105
- * *Note:** By default, on small screens, the side content is collapsed to provide more space for the main
3106
- * content. On larger screens, it is expanded. This behavior can be overridden by setting this property.
3107
+ * *Note:** By default, on mobile phone devices and small screens, the side content is collapsed to provide
3108
+ * more space for the main content. On larger screens, excluding mobile phone devices, it is expanded. This
3109
+ * behavior can be overridden by setting this property.
3107
3110
  *
3108
3111
  * Default value is `true`.
3109
3112
  *
@@ -3444,7 +3447,6 @@ declare namespace sap {
3444
3447
  * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'NavigationListItemDesign'.
3445
3448
  *
3446
3449
  * @since 1.133.0
3447
- * @experimental Behavior might change.
3448
3450
  */
3449
3451
  enum NavigationListItemDesign {
3450
3452
  /**
@@ -3477,7 +3479,6 @@ declare namespace sap {
3477
3479
  * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'.
3478
3480
  *
3479
3481
  * @since 1.134.0
3480
- * @experimental Behavior might change.
3481
3482
  */
3482
3483
  enum SideNavigationDesign {
3483
3484
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.146.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.146.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {