@openui5/ts-types 1.132.1 → 1.133.1

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.132.1
1
+ // For Library Version: 1.133.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -189,7 +189,7 @@ declare namespace sap {
189
189
  * `href` is also used.
190
190
  *
191
191
  * @since 1.116
192
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
192
+ * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
193
193
  * may be done before its official public release.
194
194
  */
195
195
  selectable?:
@@ -215,6 +215,28 @@ declare namespace sap {
215
215
  */
216
216
  target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
217
217
 
218
+ /**
219
+ * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
220
+ * sub-items can't be added.
221
+ *
222
+ * @since 1.133.0
223
+ * @experimental Behavior might change.
224
+ */
225
+ design?:
226
+ | sap.tnt.NavigationListItemDesign
227
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
228
+ | `{${string}}`;
229
+
230
+ /**
231
+ * Specifies the value of the `aria-haspopup` attribute
232
+ *
233
+ * @since 1.133.0
234
+ */
235
+ ariaHasPopup?:
236
+ | sap.ui.core.aria.HasPopup
237
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
238
+ | `{${string}}`;
239
+
218
240
  /**
219
241
  * The sub items.
220
242
  */
@@ -262,6 +284,13 @@ declare namespace sap {
262
284
  | boolean
263
285
  | sap.ui.base.ManagedObject.PropertyBindingInfo
264
286
  | `{${string}}`;
287
+
288
+ /**
289
+ * Fired when an item is pressed.
290
+ *
291
+ * @since 1.133
292
+ */
293
+ press?: (oEvent: NavigationListItemBase$PressEvent) => void;
265
294
  }
266
295
 
267
296
  /**
@@ -316,7 +345,7 @@ declare namespace sap {
316
345
  /**
317
346
  * Defines the content inside the footer.
318
347
  *
319
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
348
+ * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead.
320
349
  */
321
350
  footer?: sap.tnt.NavigationList;
322
351
 
@@ -413,6 +442,16 @@ declare namespace sap {
413
442
  item?: sap.ui.core.Item;
414
443
  }
415
444
 
445
+ /**
446
+ * Parameters of the NavigationListItemBase#press event.
447
+ */
448
+ interface NavigationListItemBase$PressEventParameters {
449
+ /**
450
+ * The pressed item.
451
+ */
452
+ item?: sap.ui.core.Item;
453
+ }
454
+
416
455
  /**
417
456
  * Parameters of the SideNavigation#itemSelect event.
418
457
  */
@@ -1466,6 +1505,32 @@ declare namespace sap {
1466
1505
  */
1467
1506
  mParameters?: sap.tnt.NavigationListItem$SelectEventParameters
1468
1507
  ): this;
1508
+ /**
1509
+ * Gets current value of property {@link #getAriaHasPopup ariaHasPopup}.
1510
+ *
1511
+ * Specifies the value of the `aria-haspopup` attribute
1512
+ *
1513
+ * Default value is `None`.
1514
+ *
1515
+ * @since 1.133.0
1516
+ *
1517
+ * @returns Value of property `ariaHasPopup`
1518
+ */
1519
+ getAriaHasPopup(): sap.ui.core.aria.HasPopup;
1520
+ /**
1521
+ * Gets current value of property {@link #getDesign design}.
1522
+ *
1523
+ * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
1524
+ * sub-items can't be added.
1525
+ *
1526
+ * Default value is `Default`.
1527
+ *
1528
+ * @since 1.133.0
1529
+ * @experimental Behavior might change.
1530
+ *
1531
+ * @returns Value of property `design`
1532
+ */
1533
+ getDesign(): sap.tnt.NavigationListItemDesign;
1469
1534
  /**
1470
1535
  * Gets current value of property {@link #getHref href}.
1471
1536
  *
@@ -1502,7 +1567,7 @@ declare namespace sap {
1502
1567
  * Default value is `true`.
1503
1568
  *
1504
1569
  * @since 1.116
1505
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1570
+ * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
1506
1571
  * may be done before its official public release.
1507
1572
  *
1508
1573
  * @returns Value of property `selectable`
@@ -1585,6 +1650,46 @@ declare namespace sap {
1585
1650
  */
1586
1651
  vItem: int | string | sap.tnt.NavigationListItem
1587
1652
  ): sap.tnt.NavigationListItem | null;
1653
+ /**
1654
+ * Sets a new value for property {@link #getAriaHasPopup ariaHasPopup}.
1655
+ *
1656
+ * Specifies the value of the `aria-haspopup` attribute
1657
+ *
1658
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1659
+ *
1660
+ * Default value is `None`.
1661
+ *
1662
+ * @since 1.133.0
1663
+ *
1664
+ * @returns Reference to `this` in order to allow method chaining
1665
+ */
1666
+ setAriaHasPopup(
1667
+ /**
1668
+ * New value for property `ariaHasPopup`
1669
+ */
1670
+ sAriaHasPopup?: sap.ui.core.aria.HasPopup
1671
+ ): this;
1672
+ /**
1673
+ * Sets a new value for property {@link #getDesign design}.
1674
+ *
1675
+ * Specifies if the item has a special design. NOTE: If `design` is not `NavigationListItemDesign.Default`
1676
+ * sub-items can't be added.
1677
+ *
1678
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1679
+ *
1680
+ * Default value is `Default`.
1681
+ *
1682
+ * @since 1.133.0
1683
+ * @experimental Behavior might change.
1684
+ *
1685
+ * @returns Reference to `this` in order to allow method chaining
1686
+ */
1687
+ setDesign(
1688
+ /**
1689
+ * New value for property `design`
1690
+ */
1691
+ sDesign?: sap.tnt.NavigationListItemDesign
1692
+ ): this;
1588
1693
  /**
1589
1694
  * Sets a new value for property {@link #getHref href}.
1590
1695
  *
@@ -1631,7 +1736,7 @@ declare namespace sap {
1631
1736
  * Default value is `true`.
1632
1737
  *
1633
1738
  * @since 1.116
1634
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1739
+ * @experimental As of version 1.116. Disclaimer: this property is in a beta state - incompatible API changes
1635
1740
  * may be done before its official public release.
1636
1741
  *
1637
1742
  * @returns Reference to `this` in order to allow method chaining
@@ -1751,6 +1856,88 @@ declare namespace sap {
1751
1856
  * @returns Metadata object describing this class
1752
1857
  */
1753
1858
  static getMetadata(): sap.ui.core.ElementMetadata;
1859
+ /**
1860
+ * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`.
1861
+ *
1862
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1863
+ * otherwise it will be bound to this `sap.tnt.NavigationListItemBase` itself.
1864
+ *
1865
+ * Fired when an item is pressed.
1866
+ *
1867
+ * @since 1.133
1868
+ *
1869
+ * @returns Reference to `this` in order to allow method chaining
1870
+ */
1871
+ attachPress(
1872
+ /**
1873
+ * An application-specific payload object that will be passed to the event handler along with the event
1874
+ * object when firing the event
1875
+ */
1876
+ oData: object,
1877
+ /**
1878
+ * The function to be called when the event occurs
1879
+ */
1880
+ fnFunction: (p1: NavigationListItemBase$PressEvent) => void,
1881
+ /**
1882
+ * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItemBase` itself
1883
+ */
1884
+ oListener?: object
1885
+ ): this;
1886
+ /**
1887
+ * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`.
1888
+ *
1889
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1890
+ * otherwise it will be bound to this `sap.tnt.NavigationListItemBase` itself.
1891
+ *
1892
+ * Fired when an item is pressed.
1893
+ *
1894
+ * @since 1.133
1895
+ *
1896
+ * @returns Reference to `this` in order to allow method chaining
1897
+ */
1898
+ attachPress(
1899
+ /**
1900
+ * The function to be called when the event occurs
1901
+ */
1902
+ fnFunction: (p1: NavigationListItemBase$PressEvent) => void,
1903
+ /**
1904
+ * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItemBase` itself
1905
+ */
1906
+ oListener?: object
1907
+ ): this;
1908
+ /**
1909
+ * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`.
1910
+ *
1911
+ * The passed function and listener object must match the ones used for event registration.
1912
+ *
1913
+ * @since 1.133
1914
+ *
1915
+ * @returns Reference to `this` in order to allow method chaining
1916
+ */
1917
+ detachPress(
1918
+ /**
1919
+ * The function to be called, when the event occurs
1920
+ */
1921
+ fnFunction: (p1: NavigationListItemBase$PressEvent) => void,
1922
+ /**
1923
+ * Context object on which the given function had to be called
1924
+ */
1925
+ oListener?: object
1926
+ ): this;
1927
+ /**
1928
+ * Fires event {@link #event:press press} to attached listeners.
1929
+ *
1930
+ * @since 1.133
1931
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1932
+ *
1933
+ * @returns Reference to `this` in order to allow method chaining
1934
+ */
1935
+ firePress(
1936
+ /**
1937
+ * Parameters to pass along with the event
1938
+ */
1939
+ mParameters?: sap.tnt.NavigationListItemBase$PressEventParameters
1940
+ ): this;
1754
1941
  /**
1755
1942
  * Gets current value of property {@link #getExpanded expanded}.
1756
1943
  *
@@ -1995,7 +2182,7 @@ declare namespace sap {
1995
2182
  /**
1996
2183
  * Destroys the footer in the aggregation {@link #getFooter footer}.
1997
2184
  *
1998
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2185
+ * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead.
1999
2186
  *
2000
2187
  * @returns Reference to `this` in order to allow method chaining
2001
2188
  */
@@ -2070,7 +2257,7 @@ declare namespace sap {
2070
2257
  *
2071
2258
  * Defines the content inside the footer.
2072
2259
  *
2073
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2260
+ * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead.
2074
2261
  */
2075
2262
  getFooter(): sap.tnt.NavigationList;
2076
2263
  /**
@@ -2153,7 +2340,7 @@ declare namespace sap {
2153
2340
  /**
2154
2341
  * Sets the aggregated {@link #getFooter footer}.
2155
2342
  *
2156
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2343
+ * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead.
2157
2344
  *
2158
2345
  * @returns Reference to `this` in order to allow method chaining
2159
2346
  */
@@ -2892,6 +3079,24 @@ declare namespace sap {
2892
3079
  */
2893
3080
  User2 = "tnt-User2",
2894
3081
  }
3082
+ /**
3083
+ * Available types for navigation list item.
3084
+ *
3085
+ * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'NavigationListItemDesign'.
3086
+ *
3087
+ * @since 1.133.0
3088
+ * @experimental Behavior might change.
3089
+ */
3090
+ enum NavigationListItemDesign {
3091
+ /**
3092
+ * Navigation list item type which provides access to frequent functionality.
3093
+ */
3094
+ Action = "Action",
3095
+ /**
3096
+ * Navigation list item type which enables navigation or contains navigation child items, or both.
3097
+ */
3098
+ Default = "Default",
3099
+ }
2895
3100
  /**
2896
3101
  * Predefined types of `InfoLabel`
2897
3102
  *
@@ -2923,6 +3128,14 @@ declare namespace sap {
2923
3128
  NavigationListItem
2924
3129
  >;
2925
3130
 
3131
+ /**
3132
+ * Event object of the NavigationListItemBase#press event.
3133
+ */
3134
+ type NavigationListItemBase$PressEvent = sap.ui.base.Event<
3135
+ NavigationListItemBase$PressEventParameters,
3136
+ NavigationListItemBase
3137
+ >;
3138
+
2926
3139
  /**
2927
3140
  * Event object of the SideNavigation#itemSelect event.
2928
3141
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.132.1
1
+ // For Library Version: 1.133.1
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {