@openui5/types 1.133.0 → 1.134.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.133.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  /**
@@ -43,6 +43,24 @@ declare module "sap/tnt/library" {
43
43
  */
44
44
  Narrow = "Narrow",
45
45
  }
46
+ /**
47
+ * Available options for the Side Navigation design.
48
+ *
49
+ * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'.
50
+ *
51
+ * @since 1.134.0
52
+ * @experimental Behavior might change.
53
+ */
54
+ export enum SideNavigationDesign {
55
+ /**
56
+ * Side Navigation has a shadow and border.
57
+ */
58
+ Decorated = "Decorated",
59
+ /**
60
+ * Side Navigation without any shadow or border.
61
+ */
62
+ Plain = "Plain",
63
+ }
46
64
  }
47
65
 
48
66
  declare module "sap/tnt/IllustratedMessageType" {
@@ -1549,8 +1567,17 @@ declare module "sap/tnt/NavigationListItem" {
1549
1567
  /**
1550
1568
  * Gets current value of property {@link #getSelectable selectable}.
1551
1569
  *
1552
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1553
- * `href` is also used.
1570
+ * Specifies if the item can be selected. By default all items are selectable.
1571
+ *
1572
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
1573
+ * its sub-items.
1574
+ *
1575
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
1576
+ * a single side navigation.
1577
+ *
1578
+ * **Guidelines:**
1579
+ * - External links should not be selectable.
1580
+ * - Items that trigger actions (with design "Action") should not be selectable.
1554
1581
  *
1555
1582
  * Default value is `true`.
1556
1583
  *
@@ -1716,8 +1743,17 @@ declare module "sap/tnt/NavigationListItem" {
1716
1743
  /**
1717
1744
  * Sets a new value for property {@link #getSelectable selectable}.
1718
1745
  *
1719
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1720
- * `href` is also used.
1746
+ * Specifies if the item can be selected. By default all items are selectable.
1747
+ *
1748
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
1749
+ * its sub-items.
1750
+ *
1751
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
1752
+ * a single side navigation.
1753
+ *
1754
+ * **Guidelines:**
1755
+ * - External links should not be selectable.
1756
+ * - Items that trigger actions (with design "Action") should not be selectable.
1721
1757
  *
1722
1758
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1723
1759
  *
@@ -1793,8 +1829,17 @@ declare module "sap/tnt/NavigationListItem" {
1793
1829
  visible?: boolean | PropertyBindingInfo | `{${string}}`;
1794
1830
 
1795
1831
  /**
1796
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1797
- * `href` is also used.
1832
+ * Specifies if the item can be selected. By default all items are selectable.
1833
+ *
1834
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
1835
+ * its sub-items.
1836
+ *
1837
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
1838
+ * a single side navigation.
1839
+ *
1840
+ * **Guidelines:**
1841
+ * - External links should not be selectable.
1842
+ * - Items that trigger actions (with design "Action") should not be selectable.
1798
1843
  *
1799
1844
  * @since 1.116
1800
1845
  * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
@@ -2191,6 +2236,8 @@ declare module "sap/tnt/SideNavigation" {
2191
2236
  PropertyBindingInfo,
2192
2237
  } from "sap/ui/base/ManagedObject";
2193
2238
 
2239
+ import { SideNavigationDesign } from "sap/tnt/library";
2240
+
2194
2241
  import NavigationList from "sap/tnt/NavigationList";
2195
2242
 
2196
2243
  import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -2209,6 +2256,9 @@ declare module "sap/tnt/SideNavigation" {
2209
2256
  * - The flexible part adapts its size to the fixed one.
2210
2257
  * - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
2211
2258
  * In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
2259
+ * **Note:** If used outside the intended parent layout `sap.tnt.ToolPage`, for example inside a `sap.m.ResponsivePopover`
2260
+ * to achieve a Side Navigation Overlay Mode, the application developer should set the `design` property
2261
+ * to `Plain`.
2212
2262
  *
2213
2263
  * @since 1.34
2214
2264
  */
@@ -2400,6 +2450,21 @@ declare module "sap/tnt/SideNavigation" {
2400
2450
  * @returns Value of property `ariaLabel`
2401
2451
  */
2402
2452
  getAriaLabel(): string;
2453
+ /**
2454
+ * Gets current value of property {@link #getDesign design}.
2455
+ *
2456
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
2457
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
2458
+ * to achieve a Side Navigation Overlay Mode.
2459
+ *
2460
+ * Default value is `Decorated`.
2461
+ *
2462
+ * @since 1.134
2463
+ * @experimental
2464
+ *
2465
+ * @returns Value of property `design`
2466
+ */
2467
+ getDesign(): SideNavigationDesign;
2403
2468
  /**
2404
2469
  * Gets current value of property {@link #getExpanded expanded}.
2405
2470
  *
@@ -2478,6 +2543,28 @@ declare module "sap/tnt/SideNavigation" {
2478
2543
  */
2479
2544
  sAriaLabel?: string
2480
2545
  ): this;
2546
+ /**
2547
+ * Sets a new value for property {@link #getDesign design}.
2548
+ *
2549
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
2550
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
2551
+ * to achieve a Side Navigation Overlay Mode.
2552
+ *
2553
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2554
+ *
2555
+ * Default value is `Decorated`.
2556
+ *
2557
+ * @since 1.134
2558
+ * @experimental
2559
+ *
2560
+ * @returns Reference to `this` in order to allow method chaining
2561
+ */
2562
+ setDesign(
2563
+ /**
2564
+ * New value for property `design`
2565
+ */
2566
+ sDesign?: SideNavigationDesign | keyof typeof SideNavigationDesign
2567
+ ): this;
2481
2568
  /**
2482
2569
  * Sets if the control is in expanded or collapsed mode.
2483
2570
  *
@@ -2612,6 +2699,19 @@ declare module "sap/tnt/SideNavigation" {
2612
2699
  */
2613
2700
  ariaLabel?: string | PropertyBindingInfo;
2614
2701
 
2702
+ /**
2703
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
2704
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
2705
+ * to achieve a Side Navigation Overlay Mode.
2706
+ *
2707
+ * @since 1.134
2708
+ * @experimental
2709
+ */
2710
+ design?:
2711
+ | (SideNavigationDesign | keyof typeof SideNavigationDesign)
2712
+ | PropertyBindingInfo
2713
+ | `{${string}}`;
2714
+
2615
2715
  /**
2616
2716
  * Defines the content inside the flexible part.
2617
2717
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -270,12 +270,13 @@ declare module "sap/ui/codeeditor/CodeEditor" {
270
270
  *
271
271
  * Sets the editor color theme. Possible values are:
272
272
  * - default: best fitting to the current UI5 theme
273
- * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
274
- * iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
273
+ * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
274
+ * github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
275
+ *
275
276
  * - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
276
277
  * cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
277
278
  * one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
278
- * tomorrow_night_eighties, twilight, vibrant_ink, github_dark
279
+ * tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
279
280
  *
280
281
  * Default value is `"default"`.
281
282
  *
@@ -688,12 +689,13 @@ declare module "sap/ui/codeeditor/CodeEditor" {
688
689
  /**
689
690
  * Sets the editor color theme. Possible values are:
690
691
  * - default: best fitting to the current UI5 theme
691
- * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
692
- * iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
692
+ * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
693
+ * github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
694
+ *
693
695
  * - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
694
696
  * cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
695
697
  * one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
696
- * tomorrow_night_eighties, twilight, vibrant_ink, github_dark
698
+ * tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
697
699
  */
698
700
  colorTheme?: string | PropertyBindingInfo;
699
701
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";