@openui5/ts-types 1.96.2 → 1.98.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.96.2
1
+ // For Library Version: 1.98.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -10,6 +10,26 @@ declare namespace sap {
10
10
  * SAPUI5 library with controls based on UI5 Web Components
11
11
  */
12
12
  namespace fiori {
13
+ /**
14
+ * @SINCE 1.97.0
15
+ * @EXPERIMENTAL (since 1.97.0)
16
+ *
17
+ * Interface for components that may be slotted inside `ui5-view-settings-dialog` as filter items
18
+ */
19
+ interface IFilterItem {
20
+ __implements__sap_ui_webc_fiori_IFilterItem: boolean;
21
+ }
22
+
23
+ /**
24
+ * @SINCE 1.97.0
25
+ * @EXPERIMENTAL (since 1.97.0)
26
+ *
27
+ * Interface for components that may be slotted inside `ui5-filter-item` as values
28
+ */
29
+ interface IFilterItemOption {
30
+ __implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
31
+ }
32
+
13
33
  /**
14
34
  * @SINCE 1.92.0
15
35
  * @EXPERIMENTAL (since 1.92.0)
@@ -70,6 +90,16 @@ declare namespace sap {
70
90
  __implements__sap_ui_webc_fiori_ISideNavigationSubItem: boolean;
71
91
  }
72
92
 
93
+ /**
94
+ * @SINCE 1.97.0
95
+ * @EXPERIMENTAL (since 1.97.0)
96
+ *
97
+ * Interface for components that may be slotted inside `ui5-view-settings-dialog` as sort items
98
+ */
99
+ interface ISortItem {
100
+ __implements__sap_ui_webc_fiori_ISortItem: boolean;
101
+ }
102
+
73
103
  /**
74
104
  * @SINCE 1.92.0
75
105
  * @EXPERIMENTAL (since 1.92.0)
@@ -162,10 +192,39 @@ declare namespace sap {
162
192
  scanSuccess?: (oEvent: sap.ui.base.Event) => void;
163
193
  }
164
194
 
195
+ interface $FilterItemSettings
196
+ extends sap.ui.webc.common.$WebComponentSettings {
197
+ /**
198
+ * Defines the text of the component.
199
+ */
200
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
201
+
202
+ /**
203
+ * Defines the `values` list.
204
+ */
205
+ values?:
206
+ | sap.ui.webc.fiori.IFilterItemOption[]
207
+ | sap.ui.webc.fiori.IFilterItemOption
208
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
209
+ }
210
+
211
+ interface $FilterItemOptionSettings
212
+ extends sap.ui.webc.common.$WebComponentSettings {
213
+ /**
214
+ * Defines whether the option is selected
215
+ */
216
+ selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
217
+
218
+ /**
219
+ * Defines the text of the component.
220
+ */
221
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
222
+ }
223
+
165
224
  interface $FlexibleColumnLayoutSettings
166
225
  extends sap.ui.webc.common.$WebComponentSettings {
167
226
  /**
168
- * On object of strings that defines several additional accessibility texts for even further customization.
227
+ * An object of strings that defines several additional accessibility texts for even further customization.
169
228
  *
170
229
  * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
171
230
  * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
@@ -778,7 +837,7 @@ declare namespace sap {
778
837
  /**
779
838
  * Fired, when the item is pressed.
780
839
  */
781
- itemClick?: (oEvent: sap.ui.base.Event) => void;
840
+ click?: (oEvent: sap.ui.base.Event) => void;
782
841
  }
783
842
 
784
843
  interface $SideNavigationSettings
@@ -898,6 +957,19 @@ declare namespace sap {
898
957
  text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
899
958
  }
900
959
 
960
+ interface $SortItemSettings
961
+ extends sap.ui.webc.common.$WebComponentSettings {
962
+ /**
963
+ * Defines if the component is selected.
964
+ */
965
+ selected?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
966
+
967
+ /**
968
+ * Defines the text of the component.
969
+ */
970
+ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
971
+ }
972
+
901
973
  interface $TimelineSettings
902
974
  extends sap.ui.webc.common.$WebComponentSettings {
903
975
  /**
@@ -988,6 +1060,13 @@ declare namespace sap {
988
1060
 
989
1061
  interface $UploadCollectionSettings
990
1062
  extends sap.ui.webc.common.$WebComponentSettings {
1063
+ /**
1064
+ * Sets the accessible aria name of the component.
1065
+ */
1066
+ accessibleName?:
1067
+ | string
1068
+ | sap.ui.base.ManagedObject.PropertyBindingInfo;
1069
+
991
1070
  /**
992
1071
  * Defines the height of the control
993
1072
  */
@@ -1042,6 +1121,9 @@ declare namespace sap {
1042
1121
 
1043
1122
  /**
1044
1123
  * Defines the `sap.ui.webc.fiori.UploadCollection` header.
1124
+ *
1125
+ * **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
1126
+ * of the application developer. `accessibleName` should be used.
1045
1127
  */
1046
1128
  header?:
1047
1129
  | sap.ui.core.Control[]
@@ -1189,12 +1271,14 @@ declare namespace sap {
1189
1271
  | boolean
1190
1272
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
1191
1273
 
1192
- /**
1193
- * Defines the `sortItems` list.
1194
- */
1274
+ filterItems?:
1275
+ | sap.ui.webc.fiori.IFilterItem[]
1276
+ | sap.ui.webc.fiori.IFilterItem
1277
+ | sap.ui.base.ManagedObject.AggregationBindingInfo;
1278
+
1195
1279
  sortItems?:
1196
- | sap.ui.webc.main.IListItem[]
1197
- | sap.ui.webc.main.IListItem
1280
+ | sap.ui.webc.fiori.ISortItem[]
1281
+ | sap.ui.webc.fiori.ISortItem
1198
1282
  | sap.ui.base.ManagedObject.AggregationBindingInfo;
1199
1283
 
1200
1284
  /**
@@ -1210,13 +1294,6 @@ declare namespace sap {
1210
1294
 
1211
1295
  interface $WizardSettings
1212
1296
  extends sap.ui.webc.common.$WebComponentSettings {
1213
- /**
1214
- * Sets the accessible aria name of the component.
1215
- */
1216
- accessibleName?:
1217
- | string
1218
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1219
-
1220
1297
  /**
1221
1298
  * Defines the height of the control
1222
1299
  */
@@ -1243,20 +1320,6 @@ declare namespace sap {
1243
1320
 
1244
1321
  interface $WizardStepSettings
1245
1322
  extends sap.ui.webc.common.$WebComponentSettings {
1246
- /**
1247
- * Sets the accessible aria name of the component.
1248
- */
1249
- accessibleName?:
1250
- | string
1251
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1252
-
1253
- /**
1254
- * Defines the aria-labelledby of the step.
1255
- */
1256
- accessibleNameRef?:
1257
- | string
1258
- | sap.ui.base.ManagedObject.PropertyBindingInfo;
1259
-
1260
1323
  /**
1261
1324
  * When `branching` is enabled a dashed line would be displayed after the step, meant to indicate that the
1262
1325
  * next step is not yet known and depends on user choice in the current step.
@@ -1284,7 +1347,7 @@ declare namespace sap {
1284
1347
  *
1285
1348
  *
1286
1349
  *
1287
- * **Note:** the icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
1350
+ * **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
1288
1351
  *
1289
1352
  *
1290
1353
  *
@@ -1308,7 +1371,6 @@ declare namespace sap {
1308
1371
  *
1309
1372
  *
1310
1373
  * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
1311
- * **Note:** the text will hide on small sizes (about 559 px).
1312
1374
  */
1313
1375
  subtitleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1314
1376
 
@@ -1317,8 +1379,7 @@ declare namespace sap {
1317
1379
  *
1318
1380
  *
1319
1381
  *
1320
- * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
1321
- * **Note:** the text will hide on small sizes (about 559 px).
1382
+ * **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
1322
1383
  */
1323
1384
  titleText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1324
1385
 
@@ -1649,8 +1710,8 @@ declare namespace sap {
1649
1710
  ): this;
1650
1711
  }
1651
1712
  /**
1652
- * @SINCE 1.92.0
1653
- * @EXPERIMENTAL (since 1.92.0)
1713
+ * @SINCE 1.95.0
1714
+ * @EXPERIMENTAL (since 1.95.0)
1654
1715
  *
1655
1716
  * Overview:
1656
1717
  *
@@ -1883,6 +1944,272 @@ declare namespace sap {
1883
1944
  */
1884
1945
  show(): void;
1885
1946
  }
1947
+ /**
1948
+ * @SINCE 1.97.0
1949
+ * @EXPERIMENTAL (since 1.97.0)
1950
+ *
1951
+ * Overview:
1952
+ *
1953
+ * Usage:
1954
+ */
1955
+ class FilterItem
1956
+ extends sap.ui.webc.common.WebComponent
1957
+ implements sap.ui.webc.fiori.IFilterItem {
1958
+ __implements__sap_ui_webc_fiori_IFilterItem: boolean;
1959
+ /**
1960
+ * Constructor for a new `FilterItem`.
1961
+ *
1962
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1963
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1964
+ * of the syntax of the settings object.
1965
+ */
1966
+ constructor(
1967
+ /**
1968
+ * Initial settings for the new control
1969
+ */
1970
+ mSettings?: sap.ui.webc.fiori.$FilterItemSettings
1971
+ );
1972
+ /**
1973
+ * Constructor for a new `FilterItem`.
1974
+ *
1975
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1976
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1977
+ * of the syntax of the settings object.
1978
+ */
1979
+ constructor(
1980
+ /**
1981
+ * ID for the new control, generated automatically if no ID is given
1982
+ */
1983
+ sId?: string,
1984
+ /**
1985
+ * Initial settings for the new control
1986
+ */
1987
+ mSettings?: sap.ui.webc.fiori.$FilterItemSettings
1988
+ );
1989
+
1990
+ /**
1991
+ * Creates a new subclass of class sap.ui.webc.fiori.FilterItem with name `sClassName` and enriches it with
1992
+ * the information contained in `oClassInfo`.
1993
+ *
1994
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
1995
+ */
1996
+ static extend<T extends Record<string, unknown>>(
1997
+ /**
1998
+ * Name of the class being created
1999
+ */
2000
+ sClassName: string,
2001
+ /**
2002
+ * Object literal with information about the class
2003
+ */
2004
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItem>,
2005
+ /**
2006
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2007
+ * used by this class
2008
+ */
2009
+ FNMetaImpl?: Function
2010
+ ): Function;
2011
+ /**
2012
+ * Returns a metadata object for class sap.ui.webc.fiori.FilterItem.
2013
+ */
2014
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2015
+ /**
2016
+ * Adds some value to the aggregation {@link #getValues values}.
2017
+ */
2018
+ addValue(
2019
+ /**
2020
+ * The value to add; if empty, nothing is inserted
2021
+ */
2022
+ oValue: sap.ui.webc.fiori.IFilterItemOption
2023
+ ): this;
2024
+ /**
2025
+ * Destroys all the values in the aggregation {@link #getValues values}.
2026
+ */
2027
+ destroyValues(): this;
2028
+ /**
2029
+ * Gets current value of property {@link #getText text}.
2030
+ *
2031
+ * Defines the text of the component.
2032
+ *
2033
+ * Default value is `empty string`.
2034
+ */
2035
+ getText(): string;
2036
+ /**
2037
+ * Gets content of aggregation {@link #getValues values}.
2038
+ *
2039
+ * Defines the `values` list.
2040
+ */
2041
+ getValues(): sap.ui.webc.fiori.IFilterItemOption[];
2042
+ /**
2043
+ * Checks for the provided `sap.ui.webc.fiori.IFilterItemOption` in the aggregation {@link #getValues values}.
2044
+ * and returns its index if found or -1 otherwise.
2045
+ */
2046
+ indexOfValue(
2047
+ /**
2048
+ * The value whose index is looked for
2049
+ */
2050
+ oValue: sap.ui.webc.fiori.IFilterItemOption
2051
+ ): int;
2052
+ /**
2053
+ * Inserts a value into the aggregation {@link #getValues values}.
2054
+ */
2055
+ insertValue(
2056
+ /**
2057
+ * The value to insert; if empty, nothing is inserted
2058
+ */
2059
+ oValue: sap.ui.webc.fiori.IFilterItemOption,
2060
+ /**
2061
+ * The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
2062
+ * at position 0; for a value greater than the current size of the aggregation, the value is inserted at
2063
+ * the last position
2064
+ */
2065
+ iIndex: int
2066
+ ): this;
2067
+ /**
2068
+ * Removes all the controls from the aggregation {@link #getValues values}.
2069
+ *
2070
+ * Additionally, it unregisters them from the hosting UIArea.
2071
+ */
2072
+ removeAllValues(): sap.ui.webc.fiori.IFilterItemOption[];
2073
+ /**
2074
+ * Removes a value from the aggregation {@link #getValues values}.
2075
+ */
2076
+ removeValue(
2077
+ /**
2078
+ * The value to remove or its index or id
2079
+ */
2080
+ vValue: int | string | sap.ui.webc.fiori.IFilterItemOption
2081
+ ): sap.ui.webc.fiori.IFilterItemOption;
2082
+ /**
2083
+ * Sets a new value for property {@link #getText text}.
2084
+ *
2085
+ * Defines the text of the component.
2086
+ *
2087
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2088
+ *
2089
+ * Default value is `empty string`.
2090
+ */
2091
+ setText(
2092
+ /**
2093
+ * New value for property `text`
2094
+ */
2095
+ sText?: string
2096
+ ): this;
2097
+ }
2098
+ /**
2099
+ * @SINCE 1.97.0
2100
+ * @EXPERIMENTAL (since 1.97.0)
2101
+ *
2102
+ * Overview:
2103
+ *
2104
+ * Usage:
2105
+ */
2106
+ class FilterItemOption
2107
+ extends sap.ui.webc.common.WebComponent
2108
+ implements sap.ui.webc.fiori.IFilterItemOption {
2109
+ __implements__sap_ui_webc_fiori_IFilterItemOption: boolean;
2110
+ /**
2111
+ * Constructor for a new `FilterItemOption`.
2112
+ *
2113
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2114
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2115
+ * of the syntax of the settings object.
2116
+ */
2117
+ constructor(
2118
+ /**
2119
+ * Initial settings for the new control
2120
+ */
2121
+ mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2122
+ );
2123
+ /**
2124
+ * Constructor for a new `FilterItemOption`.
2125
+ *
2126
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2127
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2128
+ * of the syntax of the settings object.
2129
+ */
2130
+ constructor(
2131
+ /**
2132
+ * ID for the new control, generated automatically if no ID is given
2133
+ */
2134
+ sId?: string,
2135
+ /**
2136
+ * Initial settings for the new control
2137
+ */
2138
+ mSettings?: sap.ui.webc.fiori.$FilterItemOptionSettings
2139
+ );
2140
+
2141
+ /**
2142
+ * Creates a new subclass of class sap.ui.webc.fiori.FilterItemOption with name `sClassName` and enriches
2143
+ * it with the information contained in `oClassInfo`.
2144
+ *
2145
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
2146
+ */
2147
+ static extend<T extends Record<string, unknown>>(
2148
+ /**
2149
+ * Name of the class being created
2150
+ */
2151
+ sClassName: string,
2152
+ /**
2153
+ * Object literal with information about the class
2154
+ */
2155
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.FilterItemOption>,
2156
+ /**
2157
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2158
+ * used by this class
2159
+ */
2160
+ FNMetaImpl?: Function
2161
+ ): Function;
2162
+ /**
2163
+ * Returns a metadata object for class sap.ui.webc.fiori.FilterItemOption.
2164
+ */
2165
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
2166
+ /**
2167
+ * Gets current value of property {@link #getSelected selected}.
2168
+ *
2169
+ * Defines whether the option is selected
2170
+ *
2171
+ * Default value is `false`.
2172
+ */
2173
+ getSelected(): boolean;
2174
+ /**
2175
+ * Gets current value of property {@link #getText text}.
2176
+ *
2177
+ * Defines the text of the component.
2178
+ *
2179
+ * Default value is `empty string`.
2180
+ */
2181
+ getText(): string;
2182
+ /**
2183
+ * Sets a new value for property {@link #getSelected selected}.
2184
+ *
2185
+ * Defines whether the option is selected
2186
+ *
2187
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2188
+ *
2189
+ * Default value is `false`.
2190
+ */
2191
+ setSelected(
2192
+ /**
2193
+ * New value for property `selected`
2194
+ */
2195
+ bSelected?: boolean
2196
+ ): this;
2197
+ /**
2198
+ * Sets a new value for property {@link #getText text}.
2199
+ *
2200
+ * Defines the text of the component.
2201
+ *
2202
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2203
+ *
2204
+ * Default value is `empty string`.
2205
+ */
2206
+ setText(
2207
+ /**
2208
+ * New value for property `text`
2209
+ */
2210
+ sText?: string
2211
+ ): this;
2212
+ }
1886
2213
  /**
1887
2214
  * @SINCE 1.92.0
1888
2215
  * @EXPERIMENTAL (since 1.92.0)
@@ -2056,7 +2383,7 @@ declare namespace sap {
2056
2383
  /**
2057
2384
  * The current layout
2058
2385
  */
2059
- layout?: FCLLayout;
2386
+ layout?: sap.ui.webc.fiori.FCLLayout;
2060
2387
  /**
2061
2388
  * The effective column layout, f.e [67%, 33%, 0]
2062
2389
  */
@@ -2086,7 +2413,7 @@ declare namespace sap {
2086
2413
  /**
2087
2414
  * Gets current value of property {@link #getAccessibilityTexts accessibilityTexts}.
2088
2415
  *
2089
- * On object of strings that defines several additional accessibility texts for even further customization.
2416
+ * An object of strings that defines several additional accessibility texts for even further customization.
2090
2417
  *
2091
2418
  * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
2092
2419
  * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
@@ -2189,7 +2516,7 @@ declare namespace sap {
2189
2516
  /**
2190
2517
  * Sets a new value for property {@link #getAccessibilityTexts accessibilityTexts}.
2191
2518
  *
2192
- * On object of strings that defines several additional accessibility texts for even further customization.
2519
+ * An object of strings that defines several additional accessibility texts for even further customization.
2193
2520
  *
2194
2521
  * It supports the following fields: - `startColumnAccessibleName`: the accessibility name for the `startColumn`
2195
2522
  * region - `midColumnAccessibleName`: the accessibility name for the `midColumn` region - `endColumnAccessibleName`:
@@ -2312,8 +2639,8 @@ declare namespace sap {
2312
2639
  ): this;
2313
2640
  }
2314
2641
  /**
2315
- * @SINCE 1.92.0
2316
- * @EXPERIMENTAL (since 1.92.0)
2642
+ * @SINCE 1.95.0
2643
+ * @EXPERIMENTAL (since 1.95.0)
2317
2644
  *
2318
2645
  * Overview: An IllustratedMessage is a recommended combination of a solution-oriented message, an engaging
2319
2646
  * illustration, and conversational tone to better communicate an empty or a success state than just show
@@ -4646,10 +4973,6 @@ declare namespace sap {
4646
4973
  * - profile
4647
4974
  * - product-switch
4648
4975
  *
4649
- * In the context of `sap.ui.webc.fiori.ShellBar`, you can provide a custom stable DOM refs for:
4650
- * - Every `sap.ui.webc.fiori.ShellBarItem` that you provide. Example: `
4651
- * `
4652
- *
4653
4976
  * CSS Shadow Parts:
4654
4977
  *
4655
4978
  * CSS Shadow Parts
@@ -5198,6 +5521,10 @@ declare namespace sap {
5198
5521
  targetRef?: HTMLElement;
5199
5522
  }
5200
5523
  ): this;
5524
+ /**
5525
+ * Returns the `copilot` DOM ref.
5526
+ */
5527
+ getCopilotDomRef(): void;
5201
5528
  /**
5202
5529
  * Gets content of aggregation {@link #getItems items}.
5203
5530
  *
@@ -5213,6 +5540,10 @@ declare namespace sap {
5213
5540
  * or `img` elements as logo.
5214
5541
  */
5215
5542
  getLogo(): sap.ui.webc.main.IAvatar;
5543
+ /**
5544
+ * Returns the `logo` DOM ref.
5545
+ */
5546
+ getLogoDomRef(): void;
5216
5547
  /**
5217
5548
  * Gets content of aggregation {@link #getMenuItems menuItems}.
5218
5549
  *
@@ -5229,6 +5560,14 @@ declare namespace sap {
5229
5560
  * Default value is `empty string`.
5230
5561
  */
5231
5562
  getNotificationsCount(): string;
5563
+ /**
5564
+ * Returns the `notifications` icon DOM ref.
5565
+ */
5566
+ getNotificationsDomRef(): void;
5567
+ /**
5568
+ * Returns the `overflow` icon DOM ref.
5569
+ */
5570
+ getOverflowDomRef(): void;
5232
5571
  /**
5233
5572
  * Gets current value of property {@link #getPrimaryTitle primaryTitle}.
5234
5573
  *
@@ -5239,6 +5578,10 @@ declare namespace sap {
5239
5578
  * Default value is `empty string`.
5240
5579
  */
5241
5580
  getPrimaryTitle(): string;
5581
+ /**
5582
+ * Returns the `product-switch` icon DOM ref.
5583
+ */
5584
+ getProductSwitchDomRef(): void;
5242
5585
  /**
5243
5586
  * Gets content of aggregation {@link #getProfile profile}.
5244
5587
  *
@@ -5249,6 +5592,10 @@ declare namespace sap {
5249
5592
  * specific size by design in the context of `sap.ui.webc.fiori.ShellBar` profile.
5250
5593
  */
5251
5594
  getProfile(): sap.ui.webc.main.IAvatar;
5595
+ /**
5596
+ * Returns the `profile` icon DOM ref.
5597
+ */
5598
+ getProfileDomRef(): void;
5252
5599
  /**
5253
5600
  * Gets content of aggregation {@link #getSearchField searchField}.
5254
5601
  *
@@ -5576,14 +5923,14 @@ declare namespace sap {
5576
5923
  */
5577
5924
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
5578
5925
  /**
5579
- * Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
5926
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5580
5927
  *
5581
5928
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5582
5929
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
5583
5930
  *
5584
5931
  * Fired, when the item is pressed.
5585
5932
  */
5586
- attachItemClick(
5933
+ attachClick(
5587
5934
  /**
5588
5935
  * An application-specific payload object that will be passed to the event handler along with the event
5589
5936
  * object when firing the event
@@ -5599,14 +5946,14 @@ declare namespace sap {
5599
5946
  oListener?: object
5600
5947
  ): this;
5601
5948
  /**
5602
- * Attaches event handler `fnFunction` to the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
5949
+ * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5603
5950
  *
5604
5951
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5605
5952
  * otherwise it will be bound to this `sap.ui.webc.fiori.ShellBarItem` itself.
5606
5953
  *
5607
5954
  * Fired, when the item is pressed.
5608
5955
  */
5609
- attachItemClick(
5956
+ attachClick(
5610
5957
  /**
5611
5958
  * The function to be called when the event occurs
5612
5959
  */
@@ -5617,11 +5964,11 @@ declare namespace sap {
5617
5964
  oListener?: object
5618
5965
  ): this;
5619
5966
  /**
5620
- * Detaches event handler `fnFunction` from the {@link #event:itemClick itemClick} event of this `sap.ui.webc.fiori.ShellBarItem`.
5967
+ * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.webc.fiori.ShellBarItem`.
5621
5968
  *
5622
5969
  * The passed function and listener object must match the ones used for event registration.
5623
5970
  */
5624
- detachItemClick(
5971
+ detachClick(
5625
5972
  /**
5626
5973
  * The function to be called, when the event occurs
5627
5974
  */
@@ -5632,12 +5979,12 @@ declare namespace sap {
5632
5979
  oListener?: object
5633
5980
  ): this;
5634
5981
  /**
5635
- * Fires event {@link #event:itemClick itemClick} to attached listeners.
5982
+ * Fires event {@link #event:click click} to attached listeners.
5636
5983
  *
5637
5984
  * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
5638
5985
  * event object. The return value of this method indicates whether the default action should be executed.
5639
5986
  */
5640
- fireItemClick(
5987
+ fireClick(
5641
5988
  /**
5642
5989
  * Parameters to pass along with the event
5643
5990
  */
@@ -6262,16 +6609,186 @@ declare namespace sap {
6262
6609
  *
6263
6610
  * Defines if the item is expanded
6264
6611
  *
6265
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6612
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6613
+ *
6614
+ * Default value is `false`.
6615
+ */
6616
+ setExpanded(
6617
+ /**
6618
+ * New value for property `expanded`
6619
+ */
6620
+ bExpanded?: boolean
6621
+ ): this;
6622
+ /**
6623
+ * Sets a new value for property {@link #getIcon icon}.
6624
+ *
6625
+ * Defines the icon of the item.
6626
+ *
6627
+ *
6628
+ *
6629
+ * The SAP-icons font provides numerous options.
6630
+ * See all the available icons in the Icon Explorer.
6631
+ *
6632
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6633
+ *
6634
+ * Default value is `empty string`.
6635
+ */
6636
+ setIcon(
6637
+ /**
6638
+ * New value for property `icon`
6639
+ */
6640
+ sIcon?: string
6641
+ ): this;
6642
+ /**
6643
+ * Sets a new value for property {@link #getSelected selected}.
6644
+ *
6645
+ * Defines whether the subitem is selected
6646
+ *
6647
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6648
+ *
6649
+ * Default value is `false`.
6650
+ */
6651
+ setSelected(
6652
+ /**
6653
+ * New value for property `selected`
6654
+ */
6655
+ bSelected?: boolean
6656
+ ): this;
6657
+ /**
6658
+ * Sets a new value for property {@link #getText text}.
6659
+ *
6660
+ * Defines the text of the item.
6661
+ *
6662
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6663
+ *
6664
+ * Default value is `empty string`.
6665
+ */
6666
+ setText(
6667
+ /**
6668
+ * New value for property `text`
6669
+ */
6670
+ sText?: string
6671
+ ): this;
6672
+ /**
6673
+ * Sets a new value for property {@link #getWholeItemToggleable wholeItemToggleable}.
6674
+ *
6675
+ * Defines whether pressing the whole item or only pressing the icon will show/hide the items's sub items(if
6676
+ * present). If set to true, pressing the whole item will toggle the sub items, and it won't fire the `click`
6677
+ * event. By default, only pressing the arrow icon will toggle the sub items & the click event will be fired
6678
+ * if the item is pressed outside of the icon.
6679
+ *
6680
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6681
+ *
6682
+ * Default value is `false`.
6683
+ */
6684
+ setWholeItemToggleable(
6685
+ /**
6686
+ * New value for property `wholeItemToggleable`
6687
+ */
6688
+ bWholeItemToggleable?: boolean
6689
+ ): this;
6690
+ }
6691
+ /**
6692
+ * @SINCE 1.92.0
6693
+ * @EXPERIMENTAL (since 1.92.0)
6694
+ *
6695
+ * Overview:
6696
+ *
6697
+ * The `sap.ui.webc.fiori.SideNavigationSubItem` is intended to be used inside a `sap.ui.webc.fiori.SideNavigationItem`
6698
+ * only.
6699
+ */
6700
+ class SideNavigationSubItem
6701
+ extends sap.ui.webc.common.WebComponent
6702
+ implements sap.ui.webc.fiori.ISideNavigationSubItem {
6703
+ __implements__sap_ui_webc_fiori_ISideNavigationSubItem: boolean;
6704
+ /**
6705
+ * Constructor for a new `SideNavigationSubItem`.
6706
+ *
6707
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6708
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
6709
+ * of the syntax of the settings object.
6710
+ */
6711
+ constructor(
6712
+ /**
6713
+ * Initial settings for the new control
6714
+ */
6715
+ mSettings?: sap.ui.webc.fiori.$SideNavigationSubItemSettings
6716
+ );
6717
+ /**
6718
+ * Constructor for a new `SideNavigationSubItem`.
6719
+ *
6720
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6721
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
6722
+ * of the syntax of the settings object.
6723
+ */
6724
+ constructor(
6725
+ /**
6726
+ * ID for the new control, generated automatically if no ID is given
6727
+ */
6728
+ sId?: string,
6729
+ /**
6730
+ * Initial settings for the new control
6731
+ */
6732
+ mSettings?: sap.ui.webc.fiori.$SideNavigationSubItemSettings
6733
+ );
6734
+
6735
+ /**
6736
+ * Creates a new subclass of class sap.ui.webc.fiori.SideNavigationSubItem with name `sClassName` and enriches
6737
+ * it with the information contained in `oClassInfo`.
6738
+ *
6739
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
6740
+ */
6741
+ static extend<T extends Record<string, unknown>>(
6742
+ /**
6743
+ * Name of the class being created
6744
+ */
6745
+ sClassName: string,
6746
+ /**
6747
+ * Object literal with information about the class
6748
+ */
6749
+ oClassInfo?: sap.ClassInfo<
6750
+ T,
6751
+ sap.ui.webc.fiori.SideNavigationSubItem
6752
+ >,
6753
+ /**
6754
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
6755
+ * used by this class
6756
+ */
6757
+ FNMetaImpl?: Function
6758
+ ): Function;
6759
+ /**
6760
+ * Returns a metadata object for class sap.ui.webc.fiori.SideNavigationSubItem.
6761
+ */
6762
+ static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
6763
+ /**
6764
+ * Gets current value of property {@link #getIcon icon}.
6765
+ *
6766
+ * Defines the icon of the item.
6767
+ *
6768
+ *
6769
+ *
6770
+ * The SAP-icons font provides numerous options.
6771
+ * See all the available icons in the Icon Explorer.
6772
+ *
6773
+ * Default value is `empty string`.
6774
+ */
6775
+ getIcon(): string;
6776
+ /**
6777
+ * Gets current value of property {@link #getSelected selected}.
6778
+ *
6779
+ * Defines whether the subitem is selected.
6266
6780
  *
6267
6781
  * Default value is `false`.
6268
6782
  */
6269
- setExpanded(
6270
- /**
6271
- * New value for property `expanded`
6272
- */
6273
- bExpanded?: boolean
6274
- ): this;
6783
+ getSelected(): boolean;
6784
+ /**
6785
+ * Gets current value of property {@link #getText text}.
6786
+ *
6787
+ * Defines the text of the item.
6788
+ *
6789
+ * Default value is `empty string`.
6790
+ */
6791
+ getText(): string;
6275
6792
  /**
6276
6793
  * Sets a new value for property {@link #getIcon icon}.
6277
6794
  *
@@ -6295,7 +6812,7 @@ declare namespace sap {
6295
6812
  /**
6296
6813
  * Sets a new value for property {@link #getSelected selected}.
6297
6814
  *
6298
- * Defines whether the subitem is selected
6815
+ * Defines whether the subitem is selected.
6299
6816
  *
6300
6817
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6301
6818
  *
@@ -6322,40 +6839,21 @@ declare namespace sap {
6322
6839
  */
6323
6840
  sText?: string
6324
6841
  ): this;
6325
- /**
6326
- * Sets a new value for property {@link #getWholeItemToggleable wholeItemToggleable}.
6327
- *
6328
- * Defines whether pressing the whole item or only pressing the icon will show/hide the items's sub items(if
6329
- * present). If set to true, pressing the whole item will toggle the sub items, and it won't fire the `click`
6330
- * event. By default, only pressing the arrow icon will toggle the sub items & the click event will be fired
6331
- * if the item is pressed outside of the icon.
6332
- *
6333
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6334
- *
6335
- * Default value is `false`.
6336
- */
6337
- setWholeItemToggleable(
6338
- /**
6339
- * New value for property `wholeItemToggleable`
6340
- */
6341
- bWholeItemToggleable?: boolean
6342
- ): this;
6343
6842
  }
6344
6843
  /**
6345
- * @SINCE 1.92.0
6346
- * @EXPERIMENTAL (since 1.92.0)
6844
+ * @SINCE 1.97.0
6845
+ * @EXPERIMENTAL (since 1.97.0)
6347
6846
  *
6348
6847
  * Overview:
6349
6848
  *
6350
- * The `sap.ui.webc.fiori.SideNavigationSubItem` is intended to be used inside a `sap.ui.webc.fiori.SideNavigationItem`
6351
- * only.
6849
+ * Usage:
6352
6850
  */
6353
- class SideNavigationSubItem
6851
+ class SortItem
6354
6852
  extends sap.ui.webc.common.WebComponent
6355
- implements sap.ui.webc.fiori.ISideNavigationSubItem {
6356
- __implements__sap_ui_webc_fiori_ISideNavigationSubItem: boolean;
6853
+ implements sap.ui.webc.fiori.ISortItem {
6854
+ __implements__sap_ui_webc_fiori_ISortItem: boolean;
6357
6855
  /**
6358
- * Constructor for a new `SideNavigationSubItem`.
6856
+ * Constructor for a new `SortItem`.
6359
6857
  *
6360
6858
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6361
6859
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -6365,10 +6863,10 @@ declare namespace sap {
6365
6863
  /**
6366
6864
  * Initial settings for the new control
6367
6865
  */
6368
- mSettings?: sap.ui.webc.fiori.$SideNavigationSubItemSettings
6866
+ mSettings?: sap.ui.webc.fiori.$SortItemSettings
6369
6867
  );
6370
6868
  /**
6371
- * Constructor for a new `SideNavigationSubItem`.
6869
+ * Constructor for a new `SortItem`.
6372
6870
  *
6373
6871
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
6374
6872
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -6382,12 +6880,12 @@ declare namespace sap {
6382
6880
  /**
6383
6881
  * Initial settings for the new control
6384
6882
  */
6385
- mSettings?: sap.ui.webc.fiori.$SideNavigationSubItemSettings
6883
+ mSettings?: sap.ui.webc.fiori.$SortItemSettings
6386
6884
  );
6387
6885
 
6388
6886
  /**
6389
- * Creates a new subclass of class sap.ui.webc.fiori.SideNavigationSubItem with name `sClassName` and enriches
6390
- * it with the information contained in `oClassInfo`.
6887
+ * Creates a new subclass of class sap.ui.webc.fiori.SortItem with name `sClassName` and enriches it with
6888
+ * the information contained in `oClassInfo`.
6391
6889
  *
6392
6890
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.webc.common.WebComponent.extend}.
6393
6891
  */
@@ -6399,10 +6897,7 @@ declare namespace sap {
6399
6897
  /**
6400
6898
  * Object literal with information about the class
6401
6899
  */
6402
- oClassInfo?: sap.ClassInfo<
6403
- T,
6404
- sap.ui.webc.fiori.SideNavigationSubItem
6405
- >,
6900
+ oClassInfo?: sap.ClassInfo<T, sap.ui.webc.fiori.SortItem>,
6406
6901
  /**
6407
6902
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
6408
6903
  * used by this class
@@ -6410,26 +6905,13 @@ declare namespace sap {
6410
6905
  FNMetaImpl?: Function
6411
6906
  ): Function;
6412
6907
  /**
6413
- * Returns a metadata object for class sap.ui.webc.fiori.SideNavigationSubItem.
6908
+ * Returns a metadata object for class sap.ui.webc.fiori.SortItem.
6414
6909
  */
6415
6910
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
6416
- /**
6417
- * Gets current value of property {@link #getIcon icon}.
6418
- *
6419
- * Defines the icon of the item.
6420
- *
6421
- *
6422
- *
6423
- * The SAP-icons font provides numerous options.
6424
- * See all the available icons in the Icon Explorer.
6425
- *
6426
- * Default value is `empty string`.
6427
- */
6428
- getIcon(): string;
6429
6911
  /**
6430
6912
  * Gets current value of property {@link #getSelected selected}.
6431
6913
  *
6432
- * Defines whether the subitem is selected.
6914
+ * Defines if the component is selected.
6433
6915
  *
6434
6916
  * Default value is `false`.
6435
6917
  */
@@ -6437,35 +6919,15 @@ declare namespace sap {
6437
6919
  /**
6438
6920
  * Gets current value of property {@link #getText text}.
6439
6921
  *
6440
- * Defines the text of the item.
6922
+ * Defines the text of the component.
6441
6923
  *
6442
6924
  * Default value is `empty string`.
6443
6925
  */
6444
6926
  getText(): string;
6445
- /**
6446
- * Sets a new value for property {@link #getIcon icon}.
6447
- *
6448
- * Defines the icon of the item.
6449
- *
6450
- *
6451
- *
6452
- * The SAP-icons font provides numerous options.
6453
- * See all the available icons in the Icon Explorer.
6454
- *
6455
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6456
- *
6457
- * Default value is `empty string`.
6458
- */
6459
- setIcon(
6460
- /**
6461
- * New value for property `icon`
6462
- */
6463
- sIcon?: string
6464
- ): this;
6465
6927
  /**
6466
6928
  * Sets a new value for property {@link #getSelected selected}.
6467
6929
  *
6468
- * Defines whether the subitem is selected.
6930
+ * Defines if the component is selected.
6469
6931
  *
6470
6932
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6471
6933
  *
@@ -6480,7 +6942,7 @@ declare namespace sap {
6480
6942
  /**
6481
6943
  * Sets a new value for property {@link #getText text}.
6482
6944
  *
6483
- * Defines the text of the item.
6945
+ * Defines the text of the component.
6484
6946
  *
6485
6947
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
6486
6948
  *
@@ -7339,10 +7801,21 @@ declare namespace sap {
7339
7801
  selectedItems?: any[];
7340
7802
  }
7341
7803
  ): this;
7804
+ /**
7805
+ * Gets current value of property {@link #getAccessibleName accessibleName}.
7806
+ *
7807
+ * Sets the accessible aria name of the component.
7808
+ *
7809
+ * Default value is `empty string`.
7810
+ */
7811
+ getAccessibleName(): string;
7342
7812
  /**
7343
7813
  * Gets content of aggregation {@link #getHeader header}.
7344
7814
  *
7345
7815
  * Defines the `sap.ui.webc.fiori.UploadCollection` header.
7816
+ *
7817
+ * **Note:** If `header` slot is provided, the labelling of the `UploadCollection` is a responsibility
7818
+ * of the application developer. `accessibleName` should be used.
7346
7819
  */
7347
7820
  getHeader(): sap.ui.core.Control[];
7348
7821
  /**
@@ -7488,6 +7961,21 @@ declare namespace sap {
7488
7961
  */
7489
7962
  vItem: int | string | sap.ui.webc.fiori.IUploadCollectionItem
7490
7963
  ): sap.ui.webc.fiori.IUploadCollectionItem;
7964
+ /**
7965
+ * Sets a new value for property {@link #getAccessibleName accessibleName}.
7966
+ *
7967
+ * Sets the accessible aria name of the component.
7968
+ *
7969
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7970
+ *
7971
+ * Default value is `empty string`.
7972
+ */
7973
+ setAccessibleName(
7974
+ /**
7975
+ * New value for property `accessibleName`
7976
+ */
7977
+ sAccessibleName?: string
7978
+ ): this;
7491
7979
  /**
7492
7980
  * Sets a new value for property {@link #getHeight height}.
7493
7981
  *
@@ -8213,12 +8701,13 @@ declare namespace sap {
8213
8701
  ): this;
8214
8702
  }
8215
8703
  /**
8216
- * @SINCE 1.92.0
8217
- * @EXPERIMENTAL (since 1.92.0)
8704
+ * @SINCE 1.95.0
8705
+ * @EXPERIMENTAL (since 1.95.0)
8218
8706
  *
8219
8707
  * Overview: The `sap.ui.webc.fiori.ViewSettingsDialog` component helps the user to sort data within a list
8220
- * or a table. It consists of several lists like `Sort order` which is built-in and `Sort By` which must
8221
- * be provided by the developer. The selected options can be used to create sorters for the table.
8708
+ * or a table. It consists of several lists like `Sort order` which is built-in and `Sort By` and `Filter
8709
+ * By` lists, for which you must be provide items(`sap.ui.webc.fiori.SortItem` & `sap.ui.webc.fiori.FilterItem`
8710
+ * respectively) These options can be used to create sorters for a table.
8222
8711
  *
8223
8712
  * The `sap.ui.webc.fiori.ViewSettingsDialog` interrupts the current application processing as it is the
8224
8713
  * only focused UI element and the main screen is dimmed/blocked. The `sap.ui.webc.fiori.ViewSettingsDialog`
@@ -8286,6 +8775,15 @@ declare namespace sap {
8286
8775
  * Returns a metadata object for class sap.ui.webc.fiori.ViewSettingsDialog.
8287
8776
  */
8288
8777
  static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
8778
+ /**
8779
+ * Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
8780
+ */
8781
+ addFilterItem(
8782
+ /**
8783
+ * The filterItem to add; if empty, nothing is inserted
8784
+ */
8785
+ oFilterItem: sap.ui.webc.fiori.IFilterItem
8786
+ ): this;
8289
8787
  /**
8290
8788
  * Adds some sortItem to the aggregation {@link #getSortItems sortItems}.
8291
8789
  */
@@ -8293,7 +8791,7 @@ declare namespace sap {
8293
8791
  /**
8294
8792
  * The sortItem to add; if empty, nothing is inserted
8295
8793
  */
8296
- oSortItem: sap.ui.webc.main.IListItem
8794
+ oSortItem: sap.ui.webc.fiori.ISortItem
8297
8795
  ): this;
8298
8796
  /**
8299
8797
  * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.webc.fiori.ViewSettingsDialog`.
@@ -8381,6 +8879,10 @@ declare namespace sap {
8381
8879
  */
8382
8880
  oListener?: object
8383
8881
  ): this;
8882
+ /**
8883
+ * Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
8884
+ */
8885
+ destroyFilterItems(): this;
8384
8886
  /**
8385
8887
  * Destroys all the sortItems in the aggregation {@link #getSortItems sortItems}.
8386
8888
  */
@@ -8428,7 +8930,7 @@ declare namespace sap {
8428
8930
  */
8429
8931
  sortOrder?: string;
8430
8932
  /**
8431
- * The current sort by selected.
8933
+ * The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
8432
8934
  */
8433
8935
  sortBy?: string;
8434
8936
  }
@@ -8446,11 +8948,15 @@ declare namespace sap {
8446
8948
  */
8447
8949
  sortOrder?: string;
8448
8950
  /**
8449
- * The current sort by selected.
8951
+ * The currently selected `sap.ui.webc.fiori.SortItem` text attribute.
8450
8952
  */
8451
8953
  sortBy?: string;
8452
8954
  }
8453
8955
  ): this;
8956
+ /**
8957
+ * Gets content of aggregation {@link #getFilterItems filterItems}.
8958
+ */
8959
+ getFilterItems(): sap.ui.webc.fiori.IFilterItem[];
8454
8960
  /**
8455
8961
  * Gets current value of property {@link #getSortDescending sortDescending}.
8456
8962
  *
@@ -8461,20 +8967,43 @@ declare namespace sap {
8461
8967
  getSortDescending(): boolean;
8462
8968
  /**
8463
8969
  * Gets content of aggregation {@link #getSortItems sortItems}.
8464
- *
8465
- * Defines the `sortItems` list.
8466
8970
  */
8467
- getSortItems(): sap.ui.webc.main.IListItem[];
8971
+ getSortItems(): sap.ui.webc.fiori.ISortItem[];
8972
+ /**
8973
+ * Checks for the provided `sap.ui.webc.fiori.IFilterItem` in the aggregation {@link #getFilterItems filterItems}.
8974
+ * and returns its index if found or -1 otherwise.
8975
+ */
8976
+ indexOfFilterItem(
8977
+ /**
8978
+ * The filterItem whose index is looked for
8979
+ */
8980
+ oFilterItem: sap.ui.webc.fiori.IFilterItem
8981
+ ): int;
8468
8982
  /**
8469
- * Checks for the provided `sap.ui.webc.main.IListItem` in the aggregation {@link #getSortItems sortItems}.
8983
+ * Checks for the provided `sap.ui.webc.fiori.ISortItem` in the aggregation {@link #getSortItems sortItems}.
8470
8984
  * and returns its index if found or -1 otherwise.
8471
8985
  */
8472
8986
  indexOfSortItem(
8473
8987
  /**
8474
8988
  * The sortItem whose index is looked for
8475
8989
  */
8476
- oSortItem: sap.ui.webc.main.IListItem
8990
+ oSortItem: sap.ui.webc.fiori.ISortItem
8477
8991
  ): int;
8992
+ /**
8993
+ * Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
8994
+ */
8995
+ insertFilterItem(
8996
+ /**
8997
+ * The filterItem to insert; if empty, nothing is inserted
8998
+ */
8999
+ oFilterItem: sap.ui.webc.fiori.IFilterItem,
9000
+ /**
9001
+ * The `0`-based index the filterItem should be inserted at; for a negative value of `iIndex`, the filterItem
9002
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem
9003
+ * is inserted at the last position
9004
+ */
9005
+ iIndex: int
9006
+ ): this;
8478
9007
  /**
8479
9008
  * Inserts a sortItem into the aggregation {@link #getSortItems sortItems}.
8480
9009
  */
@@ -8482,7 +9011,7 @@ declare namespace sap {
8482
9011
  /**
8483
9012
  * The sortItem to insert; if empty, nothing is inserted
8484
9013
  */
8485
- oSortItem: sap.ui.webc.main.IListItem,
9014
+ oSortItem: sap.ui.webc.fiori.ISortItem,
8486
9015
  /**
8487
9016
  * The `0`-based index the sortItem should be inserted at; for a negative value of `iIndex`, the sortItem
8488
9017
  * is inserted at position 0; for a value greater than the current size of the aggregation, the sortItem
@@ -8490,12 +9019,27 @@ declare namespace sap {
8490
9019
  */
8491
9020
  iIndex: int
8492
9021
  ): this;
9022
+ /**
9023
+ * Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
9024
+ *
9025
+ * Additionally, it unregisters them from the hosting UIArea.
9026
+ */
9027
+ removeAllFilterItems(): sap.ui.webc.fiori.IFilterItem[];
8493
9028
  /**
8494
9029
  * Removes all the controls from the aggregation {@link #getSortItems sortItems}.
8495
9030
  *
8496
9031
  * Additionally, it unregisters them from the hosting UIArea.
8497
9032
  */
8498
- removeAllSortItems(): sap.ui.webc.main.IListItem[];
9033
+ removeAllSortItems(): sap.ui.webc.fiori.ISortItem[];
9034
+ /**
9035
+ * Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
9036
+ */
9037
+ removeFilterItem(
9038
+ /**
9039
+ * The filterItem to remove or its index or id
9040
+ */
9041
+ vFilterItem: int | string | sap.ui.webc.fiori.IFilterItem
9042
+ ): sap.ui.webc.fiori.IFilterItem;
8499
9043
  /**
8500
9044
  * Removes a sortItem from the aggregation {@link #getSortItems sortItems}.
8501
9045
  */
@@ -8503,8 +9047,8 @@ declare namespace sap {
8503
9047
  /**
8504
9048
  * The sortItem to remove or its index or id
8505
9049
  */
8506
- vSortItem: int | string | sap.ui.webc.main.IListItem
8507
- ): sap.ui.webc.main.IListItem;
9050
+ vSortItem: int | string | sap.ui.webc.fiori.ISortItem
9051
+ ): sap.ui.webc.fiori.ISortItem;
8508
9052
  /**
8509
9053
  * Sets a new value for property {@link #getSortDescending sortDescending}.
8510
9054
  *
@@ -8531,16 +9075,16 @@ declare namespace sap {
8531
9075
  *
8532
9076
  * Overview:
8533
9077
  *
8534
- * The `sap.ui.webc.fiori.Wizard` helps users complete a complex task by dividing it into sections and guiding
8535
- * the user through it. It has two main areas - a navigation area at the top showing the step sequence and
8536
- * a content area below it.
9078
+ * The `sap.ui.webc.fiori.Wizard` helps users to complete a complex task by dividing it into sections and
9079
+ * guiding them through it. It has two main areas - a navigation area at the top showing the step sequence
9080
+ * and a content area below it.
8537
9081
  *
8538
9082
  * Structure: Navigation area: The top most area of the `sap.ui.webc.fiori.Wizard` is occupied by the navigation
8539
9083
  * area. It shows the sequence of steps, where the recommended number of steps is between 3 and 8 steps.
8540
9084
  *
8541
9085
  * - Steps can have different visual representations - numbers or icons. Steps might have labels
8542
9086
  * for better readability - titleText and subTitleText.
8543
- * - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`
9087
+ * - Steps are defined by using the `sap.ui.webc.fiori.WizardStep` as slotted element within the `sap.ui.webc.fiori.Wizard`.
8544
9088
  *
8545
9089
  *
8546
9090
  * **Note:** If no selected step is defined, the first step will be auto selected.
@@ -8567,7 +9111,7 @@ declare namespace sap {
8567
9111
  *
8568
9112
  * Moving to next step: The `sap.ui.webc.fiori.WizardStep` provides the necessary API and it's up to the
8569
9113
  * user of the component to use it to move to the next step. You have to set its `selected` property (and
8570
- * remove the `disabled` one if set) to `true`. And, the `sap.ui.webc.fiori.Wizard` will automatically scroll
9114
+ * remove the `disabled` one if set) to `true`. The `sap.ui.webc.fiori.Wizard` will automatically scroll
8571
9115
  * to the content of the newly selected step.
8572
9116
  *
8573
9117
  *
@@ -8576,13 +9120,14 @@ declare namespace sap {
8576
9120
  * or any other type of element to trigger step change, inside the `sap.ui.webc.fiori.WizardStep`, and show/hide
8577
9121
  * it when certain fields are filled or user defined criteria is met.
8578
9122
  *
8579
- * Usage: When to use:: When the user has to accomplish a long set of tasks.
9123
+ * Usage: When to use:: When the user has to accomplish a long or unfamiliar task.
8580
9124
  *
8581
9125
  * When not to use:: When the task has less than 3 steps.
8582
9126
  *
8583
9127
  * Responsive Behavior: On small widths the step's titleText, subtitleText and separators in the navigation
8584
- * area will start truncate and shrink and from particular point they will hide to free as much space as
8585
- * possible.
9128
+ * area shrink and from particular point the steps are grouped together and overlap. Tapping on them will
9129
+ * show a popover to select the step to navigate to. On mobile device, the grouped steps are presented within
9130
+ * a dialog.
8586
9131
  */
8587
9132
  class Wizard extends sap.ui.webc.common.WebComponent {
8588
9133
  /**
@@ -8721,27 +9266,19 @@ declare namespace sap {
8721
9266
  */
8722
9267
  mParameters?: {
8723
9268
  /**
8724
- * the new step
9269
+ * The new step.
8725
9270
  */
8726
9271
  step?: HTMLElement;
8727
9272
  /**
8728
- * the previous step
9273
+ * The previous step.
8729
9274
  */
8730
9275
  previousStep?: HTMLElement;
8731
9276
  /**
8732
- * the step change occurs due to user's click or 'Enter'/'Space' key press on step within the navigation
9277
+ * The step change occurs due to user's click or 'Enter'/'Space' key press on step within the navigation.
8733
9278
  */
8734
9279
  changeWithClick?: boolean;
8735
9280
  }
8736
9281
  ): this;
8737
- /**
8738
- * Gets current value of property {@link #getAccessibleName accessibleName}.
8739
- *
8740
- * Sets the accessible aria name of the component.
8741
- *
8742
- * Default value is `undefined`.
8743
- */
8744
- getAccessibleName(): string;
8745
9282
  /**
8746
9283
  * Gets current value of property {@link #getHeight height}.
8747
9284
  *
@@ -8796,21 +9333,6 @@ declare namespace sap {
8796
9333
  */
8797
9334
  vStep: int | string | sap.ui.webc.fiori.IWizardStep
8798
9335
  ): sap.ui.webc.fiori.IWizardStep;
8799
- /**
8800
- * Sets a new value for property {@link #getAccessibleName accessibleName}.
8801
- *
8802
- * Sets the accessible aria name of the component.
8803
- *
8804
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8805
- *
8806
- * Default value is `undefined`.
8807
- */
8808
- setAccessibleName(
8809
- /**
8810
- * New value for property `accessibleName`
8811
- */
8812
- sAccessibleName?: string
8813
- ): this;
8814
9336
  /**
8815
9337
  * Sets a new value for property {@link #getHeight height}.
8816
9338
  *
@@ -8832,13 +9354,13 @@ declare namespace sap {
8832
9354
  * Overview:
8833
9355
  *
8834
9356
  * A component that represents a logical step as part of the `sap.ui.webc.fiori.Wizard`. It is meant to
8835
- * aggregate arbitrary HTML elements that forms the content of a single step.
9357
+ * aggregate arbitrary HTML elements that form the content of a single step.
8836
9358
  *
8837
9359
  * Structure:
8838
- * - Each wizard step has arbitrary content
8839
- * - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties
8840
- * - Each wizard step might have an icon - defined by the `icon` property
8841
- * - Each wizard step might display a number in place of the `icon`, when it's missing
9360
+ * - Each wizard step has arbitrary content.
9361
+ * - Each wizard step might have texts - defined by the `titleText` and `subtitleText` properties.
9362
+ * - Each wizard step might have an icon - defined by the `icon` property.
9363
+ * - Each wizard step might display a number in place of the `icon`, when it's missing.
8842
9364
  *
8843
9365
  * Usage: The `sap.ui.webc.fiori.WizardStep` component should be used only as slot of the `sap.ui.webc.fiori.Wizard`
8844
9366
  * component and should not be used standalone.
@@ -8916,22 +9438,6 @@ declare namespace sap {
8916
9438
  * Destroys all the content in the aggregation {@link #getContent content}.
8917
9439
  */
8918
9440
  destroyContent(): this;
8919
- /**
8920
- * Gets current value of property {@link #getAccessibleName accessibleName}.
8921
- *
8922
- * Sets the accessible aria name of the component.
8923
- *
8924
- * Default value is `empty string`.
8925
- */
8926
- getAccessibleName(): string;
8927
- /**
8928
- * Gets current value of property {@link #getAccessibleNameRef accessibleNameRef}.
8929
- *
8930
- * Defines the aria-labelledby of the step.
8931
- *
8932
- * Default value is `empty string`.
8933
- */
8934
- getAccessibleNameRef(): string;
8935
9441
  /**
8936
9442
  * Gets current value of property {@link #getBranching branching}.
8937
9443
  *
@@ -8973,7 +9479,7 @@ declare namespace sap {
8973
9479
  *
8974
9480
  *
8975
9481
  *
8976
- * **Note:** the icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9482
+ * **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
8977
9483
  *
8978
9484
  *
8979
9485
  *
@@ -9003,7 +9509,6 @@ declare namespace sap {
9003
9509
  *
9004
9510
  *
9005
9511
  * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9006
- * **Note:** the text will hide on small sizes (about 559 px).
9007
9512
  *
9008
9513
  * Default value is `empty string`.
9009
9514
  */
@@ -9015,8 +9520,7 @@ declare namespace sap {
9015
9520
  *
9016
9521
  *
9017
9522
  *
9018
- * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9019
- * **Note:** the text will hide on small sizes (about 559 px).
9523
+ * **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9020
9524
  *
9021
9525
  * Default value is `empty string`.
9022
9526
  */
@@ -9061,36 +9565,6 @@ declare namespace sap {
9061
9565
  */
9062
9566
  vContent: int | string | sap.ui.core.Control
9063
9567
  ): sap.ui.core.Control;
9064
- /**
9065
- * Sets a new value for property {@link #getAccessibleName accessibleName}.
9066
- *
9067
- * Sets the accessible aria name of the component.
9068
- *
9069
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9070
- *
9071
- * Default value is `empty string`.
9072
- */
9073
- setAccessibleName(
9074
- /**
9075
- * New value for property `accessibleName`
9076
- */
9077
- sAccessibleName?: string
9078
- ): this;
9079
- /**
9080
- * Sets a new value for property {@link #getAccessibleNameRef accessibleNameRef}.
9081
- *
9082
- * Defines the aria-labelledby of the step.
9083
- *
9084
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9085
- *
9086
- * Default value is `empty string`.
9087
- */
9088
- setAccessibleNameRef(
9089
- /**
9090
- * New value for property `accessibleNameRef`
9091
- */
9092
- sAccessibleNameRef?: string
9093
- ): this;
9094
9568
  /**
9095
9569
  * Sets a new value for property {@link #getBranching branching}.
9096
9570
  *
@@ -9140,7 +9614,7 @@ declare namespace sap {
9140
9614
  *
9141
9615
  *
9142
9616
  *
9143
- * **Note:** the icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9617
+ * **Note:** The icon is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9144
9618
  *
9145
9619
  *
9146
9620
  *
@@ -9184,7 +9658,6 @@ declare namespace sap {
9184
9658
  *
9185
9659
  *
9186
9660
  * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9187
- * **Note:** the text will hide on small sizes (about 559 px).
9188
9661
  *
9189
9662
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9190
9663
  *
@@ -9203,8 +9676,7 @@ declare namespace sap {
9203
9676
  *
9204
9677
  *
9205
9678
  *
9206
- * **Note:** the text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9207
- * **Note:** the text will hide on small sizes (about 559 px).
9679
+ * **Note:** The text is displayed in the `sap.ui.webc.fiori.Wizard` navigation header.
9208
9680
  *
9209
9681
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
9210
9682
  *
@@ -9315,8 +9787,8 @@ declare namespace sap {
9315
9787
  TwoColumnsStartExpanded = "TwoColumnsStartExpanded",
9316
9788
  }
9317
9789
  /**
9318
- * @SINCE 1.92.0
9319
- * @EXPERIMENTAL (since 1.92.0)
9790
+ * @SINCE 1.95.0
9791
+ * @EXPERIMENTAL (since 1.95.0)
9320
9792
  *
9321
9793
  * Different illustration types of Illustrated Message.
9322
9794
  */
@@ -9357,6 +9829,78 @@ declare namespace sap {
9357
9829
  * "NoTasks" illustration type.
9358
9830
  */
9359
9831
  NoTasks = "NoTasks",
9832
+ /**
9833
+ * "TntCodePlaceholder" illustration type.
9834
+ */
9835
+ TntCodePlaceholder = "TntCodePlaceholder",
9836
+ /**
9837
+ * "TntCompany" illustration type.
9838
+ */
9839
+ TntCompany = "TntCompany",
9840
+ /**
9841
+ * "TntExternalLink" illustration type.
9842
+ */
9843
+ TntExternalLink = "TntExternalLink",
9844
+ /**
9845
+ * "TntFaceID" illustration type.
9846
+ */
9847
+ TntFaceID = "TntFaceID",
9848
+ /**
9849
+ * "TntFingerprint" illustration type.
9850
+ */
9851
+ TntFingerprint = "TntFingerprint",
9852
+ /**
9853
+ * "TntLock" illustration type.
9854
+ */
9855
+ TntLock = "TntLock",
9856
+ /**
9857
+ * "TntMission" illustration type.
9858
+ */
9859
+ TntMission = "TntMission",
9860
+ /**
9861
+ * "TntNoApplications" illustration type.
9862
+ */
9863
+ TntNoApplications = "TntNoApplications",
9864
+ /**
9865
+ * "TntNoFlows" illustration type.
9866
+ */
9867
+ TntNoFlows = "TntNoFlows",
9868
+ /**
9869
+ * "TntNoUsers" illustration type.
9870
+ */
9871
+ TntNoUsers = "TntNoUsers",
9872
+ /**
9873
+ * "TntRadar" illustration type.
9874
+ */
9875
+ TntRadar = "TntRadar",
9876
+ /**
9877
+ * "TntServices" illustration type.
9878
+ */
9879
+ TntServices = "TntServices",
9880
+ /**
9881
+ * "TntSessionExpired" illustration type.
9882
+ */
9883
+ TntSessionExpired = "TntSessionExpired",
9884
+ /**
9885
+ * "TntSessionExpiring" illustration type.
9886
+ */
9887
+ TntSessionExpiring = "TntSessionExpiring",
9888
+ /**
9889
+ * "TntSuccess" illustration type.
9890
+ */
9891
+ TntSuccess = "TntSuccess",
9892
+ /**
9893
+ * "TntSuccessfulAuth" illustration type.
9894
+ */
9895
+ TntSuccessfulAuth = "TntSuccessfulAuth",
9896
+ /**
9897
+ * "TntUnlock" illustration type.
9898
+ */
9899
+ TntUnlock = "TntUnlock",
9900
+ /**
9901
+ * "TntUnsuccessfulAuth" illustration type.
9902
+ */
9903
+ TntUnsuccessfulAuth = "TntUnsuccessfulAuth",
9360
9904
  /**
9361
9905
  * "UnableToLoad" illustration type.
9362
9906
  */
@@ -9435,6 +9979,10 @@ declare namespace sap {
9435
9979
 
9436
9980
  "sap/ui/webc/fiori/BarcodeScannerDialog": undefined;
9437
9981
 
9982
+ "sap/ui/webc/fiori/FilterItem": undefined;
9983
+
9984
+ "sap/ui/webc/fiori/FilterItemOption": undefined;
9985
+
9438
9986
  "sap/ui/webc/fiori/FlexibleColumnLayout": undefined;
9439
9987
 
9440
9988
  "sap/ui/webc/fiori/IllustratedMessage": undefined;
@@ -9463,6 +10011,8 @@ declare namespace sap {
9463
10011
 
9464
10012
  "sap/ui/webc/fiori/SideNavigationSubItem": undefined;
9465
10013
 
10014
+ "sap/ui/webc/fiori/SortItem": undefined;
10015
+
9466
10016
  "sap/ui/webc/fiori/Timeline": undefined;
9467
10017
 
9468
10018
  "sap/ui/webc/fiori/TimelineItem": undefined;