@openui5/ts-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 namespace sap {
4
4
  /**
@@ -185,8 +185,17 @@ declare namespace sap {
185
185
  | `{${string}}`;
186
186
 
187
187
  /**
188
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
189
- * `href` is also used.
188
+ * Specifies if the item can be selected. By default all items are selectable.
189
+ *
190
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
191
+ * its sub-items.
192
+ *
193
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
194
+ * a single side navigation.
195
+ *
196
+ * **Guidelines:**
197
+ * - External links should not be selectable.
198
+ * - Items that trigger actions (with design "Action") should not be selectable.
190
199
  *
191
200
  * @since 1.116
192
201
  * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
@@ -332,6 +341,19 @@ declare namespace sap {
332
341
  */
333
342
  ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
334
343
 
344
+ /**
345
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
346
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
347
+ * to achieve a Side Navigation Overlay Mode.
348
+ *
349
+ * @since 1.134
350
+ * @experimental
351
+ */
352
+ design?:
353
+ | sap.tnt.SideNavigationDesign
354
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
355
+ | `{${string}}`;
356
+
335
357
  /**
336
358
  * Defines the content inside the flexible part.
337
359
  */
@@ -1561,8 +1583,17 @@ declare namespace sap {
1561
1583
  /**
1562
1584
  * Gets current value of property {@link #getSelectable selectable}.
1563
1585
  *
1564
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1565
- * `href` is also used.
1586
+ * Specifies if the item can be selected. By default all items are selectable.
1587
+ *
1588
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
1589
+ * its sub-items.
1590
+ *
1591
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
1592
+ * a single side navigation.
1593
+ *
1594
+ * **Guidelines:**
1595
+ * - External links should not be selectable.
1596
+ * - Items that trigger actions (with design "Action") should not be selectable.
1566
1597
  *
1567
1598
  * Default value is `true`.
1568
1599
  *
@@ -1728,8 +1759,17 @@ declare namespace sap {
1728
1759
  /**
1729
1760
  * Sets a new value for property {@link #getSelectable selectable}.
1730
1761
  *
1731
- * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1732
- * `href` is also used.
1762
+ * Specifies if the item can be selected. By default all items are selectable.
1763
+ *
1764
+ * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse
1765
+ * its sub-items.
1766
+ *
1767
+ * To improve user experience do not mix selectable parent items with not selectable parent items within
1768
+ * a single side navigation.
1769
+ *
1770
+ * **Guidelines:**
1771
+ * - External links should not be selectable.
1772
+ * - Items that trigger actions (with design "Action") should not be selectable.
1733
1773
  *
1734
1774
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1735
1775
  *
@@ -2044,6 +2084,9 @@ declare namespace sap {
2044
2084
  * - The flexible part adapts its size to the fixed one.
2045
2085
  * - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
2046
2086
  * In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
2087
+ * **Note:** If used outside the intended parent layout `sap.tnt.ToolPage`, for example inside a `sap.m.ResponsivePopover`
2088
+ * to achieve a Side Navigation Overlay Mode, the application developer should set the `design` property
2089
+ * to `Plain`.
2047
2090
  *
2048
2091
  * @since 1.34
2049
2092
  */
@@ -2235,6 +2278,21 @@ declare namespace sap {
2235
2278
  * @returns Value of property `ariaLabel`
2236
2279
  */
2237
2280
  getAriaLabel(): string;
2281
+ /**
2282
+ * Gets current value of property {@link #getDesign design}.
2283
+ *
2284
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
2285
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
2286
+ * to achieve a Side Navigation Overlay Mode.
2287
+ *
2288
+ * Default value is `Decorated`.
2289
+ *
2290
+ * @since 1.134
2291
+ * @experimental
2292
+ *
2293
+ * @returns Value of property `design`
2294
+ */
2295
+ getDesign(): sap.tnt.SideNavigationDesign;
2238
2296
  /**
2239
2297
  * Gets current value of property {@link #getExpanded expanded}.
2240
2298
  *
@@ -2313,6 +2371,28 @@ declare namespace sap {
2313
2371
  */
2314
2372
  sAriaLabel?: string
2315
2373
  ): this;
2374
+ /**
2375
+ * Sets a new value for property {@link #getDesign design}.
2376
+ *
2377
+ * Specifies whether the control should have own container styling, such as a box-shadow and border, or
2378
+ * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover`
2379
+ * to achieve a Side Navigation Overlay Mode.
2380
+ *
2381
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2382
+ *
2383
+ * Default value is `Decorated`.
2384
+ *
2385
+ * @since 1.134
2386
+ * @experimental
2387
+ *
2388
+ * @returns Reference to `this` in order to allow method chaining
2389
+ */
2390
+ setDesign(
2391
+ /**
2392
+ * New value for property `design`
2393
+ */
2394
+ sDesign?: sap.tnt.SideNavigationDesign
2395
+ ): this;
2316
2396
  /**
2317
2397
  * Sets if the control is in expanded or collapsed mode.
2318
2398
  *
@@ -3112,6 +3192,24 @@ declare namespace sap {
3112
3192
  */
3113
3193
  Narrow = "Narrow",
3114
3194
  }
3195
+ /**
3196
+ * Available options for the Side Navigation design.
3197
+ *
3198
+ * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'.
3199
+ *
3200
+ * @since 1.134.0
3201
+ * @experimental Behavior might change.
3202
+ */
3203
+ enum SideNavigationDesign {
3204
+ /**
3205
+ * Side Navigation has a shadow and border.
3206
+ */
3207
+ Decorated = "Decorated",
3208
+ /**
3209
+ * Side Navigation without any shadow or border.
3210
+ */
3211
+ Plain = "Plain",
3212
+ }
3115
3213
  /**
3116
3214
  * Event object of the NavigationList#itemSelect event.
3117
3215
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -92,12 +92,13 @@ declare namespace sap {
92
92
  /**
93
93
  * Sets the editor color theme. Possible values are:
94
94
  * - default: best fitting to the current UI5 theme
95
- * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
96
- * iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
95
+ * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
96
+ * github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
97
+ *
97
98
  * - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
98
99
  * cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
99
100
  * one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
100
- * tomorrow_night_eighties, twilight, vibrant_ink, github_dark
101
+ * tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
101
102
  */
102
103
  colorTheme?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
103
104
 
@@ -409,12 +410,13 @@ declare namespace sap {
409
410
  *
410
411
  * Sets the editor color theme. Possible values are:
411
412
  * - default: best fitting to the current UI5 theme
412
- * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github,
413
- * iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver
413
+ * - any light theme from the list: chrome, clouds, crimson_editor, dawn, dreamweaver, eclipse, github_light_default,
414
+ * github, iplastic, solarized_light, textmate, tomorrow, xcode, kuroir, katzenmilch, sqlserver, cloud_editor
415
+ *
414
416
  * - any dark theme from the list: hcb, hcb_bright, hcb_blue, ambiance, chaos, clouds_midnight, dracula,
415
417
  * cobalt, gruvbox, gob, idle_fingers, kr_theme, merbivore, merbivore_soft, mono_industrial, monokai, nord_dark,
416
418
  * one_dark, pastel_on_dark, solarized_dark, terminal, tomorrow_night, tomorrow_night_blue, tomorrow_night_bright,
417
- * tomorrow_night_eighties, twilight, vibrant_ink, github_dark
419
+ * tomorrow_night_eighties, twilight, vibrant_ink, github_dark, cloud_editor_dark
418
420
  *
419
421
  * Default value is `"default"`.
420
422
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.133.0
1
+ // For Library Version: 1.134.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {