@openui5/types 1.120.6 → 1.121.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,10 +1,10 @@
1
- // For Library Version: 1.120.6
1
+ // For Library Version: 1.121.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  /**
5
- * @since 1.68
6
- *
7
5
  * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}.
6
+ *
7
+ * @since 1.68
8
8
  */
9
9
  export interface IToolHeader {
10
10
  __implements__sap_tnt_IToolHeader: boolean;
@@ -12,6 +12,8 @@ declare module "sap/tnt/library" {
12
12
 
13
13
  /**
14
14
  * Predefined types of `InfoLabel`
15
+ *
16
+ * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'RenderMode'.
15
17
  */
16
18
  export enum RenderMode {
17
19
  /**
@@ -25,6 +27,197 @@ declare module "sap/tnt/library" {
25
27
  }
26
28
  }
27
29
 
30
+ declare module "sap/tnt/IllustratedMessageType" {
31
+ /**
32
+ * Available TNT `Illustration` types for the {@link sap.m.IllustratedMessage} control.
33
+ *
34
+ * @since 1.121
35
+ */
36
+ enum IllustratedMessageType {
37
+ /**
38
+ * "Avatar" illustration type.
39
+ */
40
+ Avatar = "tnt-Avatar",
41
+ /**
42
+ * "Calculator" illustration type.
43
+ */
44
+ Calculator = "tnt-Calculator",
45
+ /**
46
+ * "ChartArea" illustration type.
47
+ */
48
+ ChartArea = "tnt-ChartArea",
49
+ /**
50
+ * "ChartArea2" illustration type.
51
+ */
52
+ ChartArea2 = "tnt-ChartArea2",
53
+ /**
54
+ * "ChartBar" illustration type.
55
+ */
56
+ ChartBar = "tnt-ChartBar",
57
+ /**
58
+ * "ChartBPMNFlow" illustration type.
59
+ */
60
+ ChartBPMNFlow = "tnt-ChartBPMNFlow",
61
+ /**
62
+ * "ChartBullet" illustration type.
63
+ */
64
+ ChartBullet = "tnt-ChartBullet",
65
+ /**
66
+ * "ChartDoughnut" illustration type.
67
+ */
68
+ ChartDoughnut = "tnt-ChartDoughnut",
69
+ /**
70
+ * "ChartFlow" illustration type.
71
+ */
72
+ ChartFlow = "tnt-ChartFlow",
73
+ /**
74
+ * "ChartGantt" illustration type.
75
+ */
76
+ ChartGantt = "tnt-ChartGantt",
77
+ /**
78
+ * "ChartOrg" illustration type.
79
+ */
80
+ ChartOrg = "tnt-ChartOrg",
81
+ /**
82
+ * "ChartPie" illustration type.
83
+ */
84
+ ChartPie = "tnt-ChartPie",
85
+ /**
86
+ * "CodePlaceholder" illustration type.
87
+ */
88
+ CodePlaceholder = "tnt-CodePlaceholder",
89
+ /**
90
+ * "Company" illustration type.
91
+ */
92
+ Company = "tnt-Company",
93
+ /**
94
+ * "Compass" illustration type.
95
+ */
96
+ Compass = "tnt-Compass",
97
+ /**
98
+ * "Components" illustration type.
99
+ */
100
+ Components = "tnt-Components",
101
+ /**
102
+ * "Dialog" illustration type.
103
+ */
104
+ Dialog = "tnt-Dialog",
105
+ /**
106
+ * "ExternalLink" illustration type.
107
+ */
108
+ ExternalLink = "tnt-ExternalLink",
109
+ /**
110
+ * "FaceID" illustration type.
111
+ */
112
+ FaceID = "tnt-FaceID",
113
+ /**
114
+ * "Fingerprint" illustration type.
115
+ */
116
+ Fingerprint = "tnt-Fingerprint",
117
+ /**
118
+ * "Handshake" illustration type.
119
+ */
120
+ Handshake = "tnt-Handshake",
121
+ /**
122
+ * "Help" illustration type.
123
+ */
124
+ Help = "tnt-Help",
125
+ /**
126
+ * "Lock" illustration type.
127
+ */
128
+ Lock = "tnt-Lock",
129
+ /**
130
+ * "Mission" illustration type.
131
+ */
132
+ Mission = "tnt-Mission",
133
+ /**
134
+ * "MissionFailed" illustration type.
135
+ */
136
+ MissionFailed = "tnt-MissionFailed",
137
+ /**
138
+ * "NoApplications" illustration type.
139
+ */
140
+ NoApplications = "tnt-NoApplications",
141
+ /**
142
+ * "NoFlows" illustration type.
143
+ */
144
+ NoFlows = "tnt-NoFlows",
145
+ /**
146
+ * "NoUsers" illustration type.
147
+ */
148
+ NoUsers = "tnt-NoUsers",
149
+ /**
150
+ * "Radar" illustration type.
151
+ */
152
+ Radar = "tnt-Radar",
153
+ /**
154
+ * "RoadMap" illustration type.
155
+ */
156
+ RoadMap = "tnt-RoadMap",
157
+ /**
158
+ * "Secrets" illustration type.
159
+ */
160
+ Secrets = "tnt-Secrets",
161
+ /**
162
+ * "Services" illustration type.
163
+ */
164
+ Services = "tnt-Services",
165
+ /**
166
+ * "SessionExpired" illustration type.
167
+ */
168
+ SessionExpired = "tnt-SessionExpired",
169
+ /**
170
+ * "SessionExpiring" illustration type.
171
+ */
172
+ SessionExpiring = "tnt-SessionExpiring",
173
+ /**
174
+ * "Settings" illustration type.
175
+ */
176
+ Settings = "tnt-Settings",
177
+ /**
178
+ * "Success" illustration type.
179
+ */
180
+ Success = "tnt-Success",
181
+ /**
182
+ * "SuccessfulAuth" illustration type.
183
+ */
184
+ SuccessfulAuth = "tnt-SuccessfulAuth",
185
+ /**
186
+ * "Systems" illustration type.
187
+ */
188
+ Systems = "tnt-Systems",
189
+ /**
190
+ * "Teams" illustration type.
191
+ */
192
+ Teams = "tnt-Teams",
193
+ /**
194
+ * "Tools" illustration type.
195
+ */
196
+ Tools = "tnt-Tools",
197
+ /**
198
+ * "Tutorials" illustration type.
199
+ */
200
+ Tutorials = "tnt-Tutorials",
201
+ /**
202
+ * "UnableToLoad" illustration type.
203
+ */
204
+ UnableToLoad = "tnt-UnableToLoad",
205
+ /**
206
+ * "Unlock" illustration type.
207
+ */
208
+ Unlock = "tnt-Unlock",
209
+ /**
210
+ * "UnsuccessfulAuth" illustration type.
211
+ */
212
+ UnsuccessfulAuth = "tnt-UnsuccessfulAuth",
213
+ /**
214
+ * "User2" illustration type.
215
+ */
216
+ User2 = "tnt-User2",
217
+ }
218
+ export default IllustratedMessageType;
219
+ }
220
+
28
221
  declare module "sap/tnt/InfoLabel" {
29
222
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
30
223
 
@@ -42,8 +235,6 @@ declare module "sap/tnt/InfoLabel" {
42
235
  import { RenderMode } from "sap/tnt/library";
43
236
 
44
237
  /**
45
- * @since 1.54
46
- *
47
238
  * The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color
48
239
  * chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to
49
240
  * some piece of information (state, quantity, condition, etc.).
@@ -64,6 +255,8 @@ declare module "sap/tnt/InfoLabel" {
64
255
  * - Colors are not semantic and have no visual representation in sap_belize_hcb, sap_belize_hcw, sap_fiori_3_hcb
65
256
  * and sap_fiori_3_hcw themes.
66
257
  * - The control shows plain text only, formatting is not visualized.
258
+ *
259
+ * @since 1.54
67
260
  */
68
261
  export default class InfoLabel extends Control implements IFormContent {
69
262
  __implements__sap_ui_core_IFormContent: boolean;
@@ -104,6 +297,7 @@ declare module "sap/tnt/InfoLabel" {
104
297
  *
105
298
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
106
299
  *
300
+ *
107
301
  * @returns Created class / constructor function
108
302
  */
109
303
  static extend<T extends Record<string, unknown>>(
@@ -124,6 +318,7 @@ declare module "sap/tnt/InfoLabel" {
124
318
  /**
125
319
  * Returns a metadata object for class sap.tnt.InfoLabel.
126
320
  *
321
+ *
127
322
  * @returns Metadata object describing this class
128
323
  */
129
324
  static getMetadata(): ElementMetadata;
@@ -133,6 +328,7 @@ declare module "sap/tnt/InfoLabel" {
133
328
  * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
134
329
  * of the possible properties of `oBindingInfo`
135
330
  *
331
+ *
136
332
  * @returns Reference to `this` in order to allow method chaining
137
333
  */
138
334
  bindText(
@@ -151,6 +347,7 @@ declare module "sap/tnt/InfoLabel" {
151
347
  *
152
348
  * Default value is `7`.
153
349
  *
350
+ *
154
351
  * @returns Value of property `colorScheme`
155
352
  */
156
353
  getColorScheme(): int;
@@ -162,12 +359,11 @@ declare module "sap/tnt/InfoLabel" {
162
359
  *
163
360
  * Default value is `false`.
164
361
  *
362
+ *
165
363
  * @returns Value of property `displayOnly`
166
364
  */
167
365
  getDisplayOnly(): boolean;
168
366
  /**
169
- * @since 1.74
170
- *
171
367
  * Gets current value of property {@link #getIcon icon}.
172
368
  *
173
369
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
@@ -175,6 +371,8 @@ declare module "sap/tnt/InfoLabel" {
175
371
  *
176
372
  * Default value is `empty string`.
177
373
  *
374
+ * @since 1.74
375
+ *
178
376
  * @returns Value of property `icon`
179
377
  */
180
378
  getIcon(): URI;
@@ -187,6 +385,7 @@ declare module "sap/tnt/InfoLabel" {
187
385
  *
188
386
  * Default value is `Loose`.
189
387
  *
388
+ *
190
389
  * @returns Value of property `renderMode`
191
390
  */
192
391
  getRenderMode(): RenderMode | keyof typeof RenderMode;
@@ -197,6 +396,7 @@ declare module "sap/tnt/InfoLabel" {
197
396
  *
198
397
  * Default value is `empty string`.
199
398
  *
399
+ *
200
400
  * @returns Value of property `text`
201
401
  */
202
402
  getText(): string;
@@ -208,6 +408,7 @@ declare module "sap/tnt/InfoLabel" {
208
408
  *
209
409
  * Default value is `Inherit`.
210
410
  *
411
+ *
211
412
  * @returns Value of property `textDirection`
212
413
  */
213
414
  getTextDirection(): TextDirection | keyof typeof TextDirection;
@@ -217,6 +418,7 @@ declare module "sap/tnt/InfoLabel" {
217
418
  * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of
218
419
  * the content. Set this property to restrict the width to a custom value.
219
420
  *
421
+ *
220
422
  * @returns Value of property `width`
221
423
  */
222
424
  getWidth(): CSSSize;
@@ -232,6 +434,7 @@ declare module "sap/tnt/InfoLabel" {
232
434
  *
233
435
  * Default value is `7`.
234
436
  *
437
+ *
235
438
  * @returns Reference to `this` in order to allow method chaining
236
439
  */
237
440
  setColorScheme(
@@ -250,6 +453,7 @@ declare module "sap/tnt/InfoLabel" {
250
453
  *
251
454
  * Default value is `false`.
252
455
  *
456
+ *
253
457
  * @returns Reference to `this` in order to allow method chaining
254
458
  */
255
459
  setDisplayOnly(
@@ -259,8 +463,6 @@ declare module "sap/tnt/InfoLabel" {
259
463
  bDisplayOnly?: boolean
260
464
  ): this;
261
465
  /**
262
- * @since 1.74
263
- *
264
466
  * Sets a new value for property {@link #getIcon icon}.
265
467
  *
266
468
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
@@ -270,6 +472,8 @@ declare module "sap/tnt/InfoLabel" {
270
472
  *
271
473
  * Default value is `empty string`.
272
474
  *
475
+ * @since 1.74
476
+ *
273
477
  * @returns Reference to `this` in order to allow method chaining
274
478
  */
275
479
  setIcon(
@@ -289,6 +493,7 @@ declare module "sap/tnt/InfoLabel" {
289
493
  *
290
494
  * Default value is `Loose`.
291
495
  *
496
+ *
292
497
  * @returns Reference to `this` in order to allow method chaining
293
498
  */
294
499
  setRenderMode(
@@ -306,6 +511,7 @@ declare module "sap/tnt/InfoLabel" {
306
511
  *
307
512
  * Default value is `empty string`.
308
513
  *
514
+ *
309
515
  * @returns Reference to `this` in order to allow method chaining
310
516
  */
311
517
  setText(
@@ -324,6 +530,7 @@ declare module "sap/tnt/InfoLabel" {
324
530
  *
325
531
  * Default value is `Inherit`.
326
532
  *
533
+ *
327
534
  * @returns Reference to `this` in order to allow method chaining
328
535
  */
329
536
  setTextDirection(
@@ -340,6 +547,7 @@ declare module "sap/tnt/InfoLabel" {
340
547
  *
341
548
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
342
549
  *
550
+ *
343
551
  * @returns Reference to `this` in order to allow method chaining
344
552
  */
345
553
  setWidth(
@@ -351,6 +559,7 @@ declare module "sap/tnt/InfoLabel" {
351
559
  /**
352
560
  * Unbinds property {@link #getText text} from model data.
353
561
  *
562
+ *
354
563
  * @returns Reference to `this` in order to allow method chaining
355
564
  */
356
565
  unbindText(): this;
@@ -402,10 +611,10 @@ declare module "sap/tnt/InfoLabel" {
402
611
  | `{${string}}`;
403
612
 
404
613
  /**
405
- * @since 1.74
406
- *
407
614
  * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from
408
615
  * the icon font.
616
+ *
617
+ * @since 1.74
409
618
  */
410
619
  icon?: URI | PropertyBindingInfo | `{${string}}`;
411
620
  }
@@ -416,10 +625,12 @@ declare module "sap/tnt/NavigationList" {
416
625
 
417
626
  import { ID, CSSSize } from "sap/ui/core/library";
418
627
 
419
- import NavigationListItem from "sap/tnt/NavigationListItem";
628
+ import NavigationListItemBase from "sap/tnt/NavigationListItemBase";
420
629
 
421
630
  import ElementMetadata from "sap/ui/core/ElementMetadata";
422
631
 
632
+ import NavigationListItem from "sap/tnt/NavigationListItem";
633
+
423
634
  import {
424
635
  PropertyBindingInfo,
425
636
  AggregationBindingInfo,
@@ -430,14 +641,14 @@ declare module "sap/tnt/NavigationList" {
430
641
  import Event from "sap/ui/base/Event";
431
642
 
432
643
  /**
433
- * @since 1.34
434
- *
435
644
  * The NavigationList control is an interactive control, which provides a choice of different items, ordered
436
645
  * as a list.
646
+ *
647
+ * @since 1.34
437
648
  */
438
649
  export default class NavigationList extends Control {
439
650
  /**
440
- * Constructor for a new NavigationList.
651
+ * Constructor for a new `NavigationList`.
441
652
  *
442
653
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
443
654
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -450,7 +661,7 @@ declare module "sap/tnt/NavigationList" {
450
661
  mSettings?: $NavigationListSettings
451
662
  );
452
663
  /**
453
- * Constructor for a new NavigationList.
664
+ * Constructor for a new `NavigationList`.
454
665
  *
455
666
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
456
667
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -473,6 +684,7 @@ declare module "sap/tnt/NavigationList" {
473
684
  *
474
685
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
475
686
  *
687
+ *
476
688
  * @returns Created class / constructor function
477
689
  */
478
690
  static extend<T extends Record<string, unknown>>(
@@ -493,12 +705,14 @@ declare module "sap/tnt/NavigationList" {
493
705
  /**
494
706
  * Returns a metadata object for class sap.tnt.NavigationList.
495
707
  *
708
+ *
496
709
  * @returns Metadata object describing this class
497
710
  */
498
711
  static getMetadata(): ElementMetadata;
499
712
  /**
500
713
  * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
501
714
  *
715
+ *
502
716
  * @returns Reference to `this` in order to allow method chaining
503
717
  */
504
718
  addAriaDescribedBy(
@@ -510,6 +724,7 @@ declare module "sap/tnt/NavigationList" {
510
724
  /**
511
725
  * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
512
726
  *
727
+ *
513
728
  * @returns Reference to `this` in order to allow method chaining
514
729
  */
515
730
  addAriaLabelledBy(
@@ -521,13 +736,14 @@ declare module "sap/tnt/NavigationList" {
521
736
  /**
522
737
  * Adds some item to the aggregation {@link #getItems items}.
523
738
  *
739
+ *
524
740
  * @returns Reference to `this` in order to allow method chaining
525
741
  */
526
742
  addItem(
527
743
  /**
528
744
  * The item to add; if empty, nothing is inserted
529
745
  */
530
- oItem: NavigationListItem
746
+ oItem: NavigationListItemBase
531
747
  ): this;
532
748
  /**
533
749
  * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`.
@@ -537,6 +753,7 @@ declare module "sap/tnt/NavigationList" {
537
753
  *
538
754
  * Fired when an item is selected.
539
755
  *
756
+ *
540
757
  * @returns Reference to `this` in order to allow method chaining
541
758
  */
542
759
  attachItemSelect(
@@ -562,6 +779,7 @@ declare module "sap/tnt/NavigationList" {
562
779
  *
563
780
  * Fired when an item is selected.
564
781
  *
782
+ *
565
783
  * @returns Reference to `this` in order to allow method chaining
566
784
  */
567
785
  attachItemSelect(
@@ -577,6 +795,7 @@ declare module "sap/tnt/NavigationList" {
577
795
  /**
578
796
  * Destroys all the items in the aggregation {@link #getItems items}.
579
797
  *
798
+ *
580
799
  * @returns Reference to `this` in order to allow method chaining
581
800
  */
582
801
  destroyItems(): this;
@@ -585,6 +804,7 @@ declare module "sap/tnt/NavigationList" {
585
804
  *
586
805
  * The passed function and listener object must match the ones used for event registration.
587
806
  *
807
+ *
588
808
  * @returns Reference to `this` in order to allow method chaining
589
809
  */
590
810
  detachItemSelect(
@@ -598,10 +818,10 @@ declare module "sap/tnt/NavigationList" {
598
818
  oListener?: object
599
819
  ): this;
600
820
  /**
601
- * @ui5-protected Do not call from applications (only from related classes in the framework)
602
- *
603
821
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
604
822
  *
823
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
824
+ *
605
825
  * @returns Reference to `this` in order to allow method chaining
606
826
  */
607
827
  fireItemSelect(
@@ -625,6 +845,7 @@ declare module "sap/tnt/NavigationList" {
625
845
  *
626
846
  * Default value is `true`.
627
847
  *
848
+ *
628
849
  * @returns Value of property `expanded`
629
850
  */
630
851
  getExpanded(): boolean;
@@ -633,20 +854,21 @@ declare module "sap/tnt/NavigationList" {
633
854
  *
634
855
  * The items displayed in the list.
635
856
  */
636
- getItems(): NavigationListItem[];
857
+ getItems(): NavigationListItemBase[];
637
858
  /**
638
859
  * Gets the currently selected `NavigationListItem`.
639
860
  *
861
+ *
640
862
  * @returns The selected item or `null` if nothing is selected
641
863
  */
642
864
  getSelectedItem(): NavigationListItem | null;
643
865
  /**
644
- * @since 1.62.0
645
- *
646
866
  * Gets current value of property {@link #getSelectedKey selectedKey}.
647
867
  *
648
868
  * Specifies the currently selected key.
649
869
  *
870
+ * @since 1.62.0
871
+ *
650
872
  * @returns Value of property `selectedKey`
651
873
  */
652
874
  getSelectedKey(): string;
@@ -655,12 +877,14 @@ declare module "sap/tnt/NavigationList" {
655
877
  *
656
878
  * Specifies the width of the control.
657
879
  *
880
+ *
658
881
  * @returns Value of property `width`
659
882
  */
660
883
  getWidth(): CSSSize;
661
884
  /**
662
- * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
663
- * returns its index if found or -1 otherwise.
885
+ * Checks for the provided `sap.tnt.NavigationListItemBase` in the aggregation {@link #getItems items}.
886
+ * and returns its index if found or -1 otherwise.
887
+ *
664
888
  *
665
889
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
666
890
  */
@@ -668,18 +892,19 @@ declare module "sap/tnt/NavigationList" {
668
892
  /**
669
893
  * The item whose index is looked for
670
894
  */
671
- oItem: NavigationListItem
895
+ oItem: NavigationListItemBase
672
896
  ): int;
673
897
  /**
674
898
  * Inserts a item into the aggregation {@link #getItems items}.
675
899
  *
900
+ *
676
901
  * @returns Reference to `this` in order to allow method chaining
677
902
  */
678
903
  insertItem(
679
904
  /**
680
905
  * The item to insert; if empty, nothing is inserted
681
906
  */
682
- oItem: NavigationListItem,
907
+ oItem: NavigationListItemBase,
683
908
  /**
684
909
  * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
685
910
  * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
@@ -690,12 +915,14 @@ declare module "sap/tnt/NavigationList" {
690
915
  /**
691
916
  * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
692
917
  *
918
+ *
693
919
  * @returns An array of the removed elements (might be empty)
694
920
  */
695
921
  removeAllAriaDescribedBy(): ID[];
696
922
  /**
697
923
  * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
698
924
  *
925
+ *
699
926
  * @returns An array of the removed elements (might be empty)
700
927
  */
701
928
  removeAllAriaLabelledBy(): ID[];
@@ -704,12 +931,14 @@ declare module "sap/tnt/NavigationList" {
704
931
  *
705
932
  * Additionally, it unregisters them from the hosting UIArea.
706
933
  *
934
+ *
707
935
  * @returns An array of the removed elements (might be empty)
708
936
  */
709
- removeAllItems(): NavigationListItem[];
937
+ removeAllItems(): NavigationListItemBase[];
710
938
  /**
711
939
  * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
712
940
  *
941
+ *
713
942
  * @returns The removed ariaDescribedBy or `null`
714
943
  */
715
944
  removeAriaDescribedBy(
@@ -721,6 +950,7 @@ declare module "sap/tnt/NavigationList" {
721
950
  /**
722
951
  * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
723
952
  *
953
+ *
724
954
  * @returns The removed ariaLabelledBy or `null`
725
955
  */
726
956
  removeAriaLabelledBy(
@@ -732,14 +962,15 @@ declare module "sap/tnt/NavigationList" {
732
962
  /**
733
963
  * Removes a item from the aggregation {@link #getItems items}.
734
964
  *
965
+ *
735
966
  * @returns The removed item or `null`
736
967
  */
737
968
  removeItem(
738
969
  /**
739
970
  * The item to remove or its index or id
740
971
  */
741
- vItem: int | string | NavigationListItem
742
- ): NavigationListItem | null;
972
+ vItem: int | string | NavigationListItemBase
973
+ ): NavigationListItemBase | null;
743
974
  /**
744
975
  * Sets a new value for property {@link #getExpanded expanded}.
745
976
  *
@@ -749,6 +980,7 @@ declare module "sap/tnt/NavigationList" {
749
980
  *
750
981
  * Default value is `true`.
751
982
  *
983
+ *
752
984
  * @returns Reference to `this` in order to allow method chaining
753
985
  */
754
986
  setExpanded(
@@ -760,24 +992,26 @@ declare module "sap/tnt/NavigationList" {
760
992
  /**
761
993
  * Sets the association for selectedItem. Set `null` to deselect.
762
994
  *
995
+ *
763
996
  * @returns The `selectedItem` association
764
997
  */
765
998
  setSelectedItem(
766
999
  /**
767
1000
  * The control to be set as selected
768
1001
  */
769
- selectedItem: string | NavigationListItem
1002
+ oItem: ID | NavigationListItem
770
1003
  ): NavigationList | null;
771
1004
  /**
772
1005
  * Sets the selected item based on a key.
773
1006
  *
1007
+ *
774
1008
  * @returns this pointer for chaining
775
1009
  */
776
1010
  setSelectedKey(
777
1011
  /**
778
1012
  * The key of the item to be selected
779
1013
  */
780
- selectedKey: string
1014
+ sSelectedKey: string
781
1015
  ): this;
782
1016
  /**
783
1017
  * Sets a new value for property {@link #getWidth width}.
@@ -786,6 +1020,7 @@ declare module "sap/tnt/NavigationList" {
786
1020
  *
787
1021
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
788
1022
  *
1023
+ *
789
1024
  * @returns Reference to `this` in order to allow method chaining
790
1025
  */
791
1026
  setWidth(
@@ -808,9 +1043,9 @@ declare module "sap/tnt/NavigationList" {
808
1043
  expanded?: boolean | PropertyBindingInfo | `{${string}}`;
809
1044
 
810
1045
  /**
811
- * @since 1.62.0
812
- *
813
1046
  * Specifies the currently selected key.
1047
+ *
1048
+ * @since 1.62.0
814
1049
  */
815
1050
  selectedKey?: string | PropertyBindingInfo;
816
1051
 
@@ -818,8 +1053,8 @@ declare module "sap/tnt/NavigationList" {
818
1053
  * The items displayed in the list.
819
1054
  */
820
1055
  items?:
821
- | NavigationListItem[]
822
- | NavigationListItem
1056
+ | NavigationListItemBase[]
1057
+ | NavigationListItemBase
823
1058
  | AggregationBindingInfo
824
1059
  | `{${string}}`;
825
1060
 
@@ -834,9 +1069,9 @@ declare module "sap/tnt/NavigationList" {
834
1069
  ariaLabelledBy?: Array<Control | string>;
835
1070
 
836
1071
  /**
837
- * @since 1.52.0
838
- *
839
1072
  * The currently selected `NavigationListItem`.
1073
+ *
1074
+ * @since 1.52.0
840
1075
  */
841
1076
  selectedItem?: NavigationListItem | string;
842
1077
 
@@ -859,29 +1094,26 @@ declare module "sap/tnt/NavigationList" {
859
1094
  >;
860
1095
  }
861
1096
 
862
- declare module "sap/tnt/NavigationListItem" {
863
- import { default as Item, $ItemSettings } from "sap/ui/core/Item";
1097
+ declare module "sap/tnt/NavigationListGroup" {
1098
+ import {
1099
+ default as NavigationListItemBase,
1100
+ $NavigationListItemBaseSettings,
1101
+ } from "sap/tnt/NavigationListItemBase";
864
1102
 
865
- import { URI } from "sap/ui/core/library";
1103
+ import NavigationListItem from "sap/tnt/NavigationListItem";
866
1104
 
867
1105
  import ElementMetadata from "sap/ui/core/ElementMetadata";
868
1106
 
869
- import {
870
- PropertyBindingInfo,
871
- AggregationBindingInfo,
872
- } from "sap/ui/base/ManagedObject";
873
-
874
- import Event from "sap/ui/base/Event";
1107
+ import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
875
1108
 
876
1109
  /**
877
- * @since 1.34
1110
+ * The NavigationListGroup represents a group of navigation actions, which can be selected by the user.
878
1111
  *
879
- * The NavigationListItem control represents an action, which can be selected by the user. It can provide
880
- * sub items.
1112
+ * @since 1.121
881
1113
  */
882
- export default class NavigationListItem extends Item {
1114
+ export default class NavigationListGroup extends NavigationListItemBase {
883
1115
  /**
884
- * Constructor for a new NavigationListItem.
1116
+ * Constructor for a new NavigationListGroup.
885
1117
  *
886
1118
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
887
1119
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -891,10 +1123,10 @@ declare module "sap/tnt/NavigationListItem" {
891
1123
  /**
892
1124
  * Initial settings for the new control
893
1125
  */
894
- mSettings?: $NavigationListItemSettings
1126
+ mSettings?: $NavigationListGroupSettings
895
1127
  );
896
1128
  /**
897
- * Constructor for a new NavigationListItem.
1129
+ * Constructor for a new NavigationListGroup.
898
1130
  *
899
1131
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
900
1132
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -908,14 +1140,15 @@ declare module "sap/tnt/NavigationListItem" {
908
1140
  /**
909
1141
  * Initial settings for the new control
910
1142
  */
911
- mSettings?: $NavigationListItemSettings
1143
+ mSettings?: $NavigationListGroupSettings
912
1144
  );
913
1145
 
914
1146
  /**
915
- * Creates a new subclass of class sap.tnt.NavigationListItem with name `sClassName` and enriches it with
1147
+ * Creates a new subclass of class sap.tnt.NavigationListGroup with name `sClassName` and enriches it with
916
1148
  * the information contained in `oClassInfo`.
917
1149
  *
918
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
1150
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.tnt.NavigationListItemBase.extend}.
1151
+ *
919
1152
  *
920
1153
  * @returns Created class / constructor function
921
1154
  */
@@ -927,7 +1160,7 @@ declare module "sap/tnt/NavigationListItem" {
927
1160
  /**
928
1161
  * Object literal with information about the class
929
1162
  */
930
- oClassInfo?: sap.ClassInfo<T, NavigationListItem>,
1163
+ oClassInfo?: sap.ClassInfo<T, NavigationListGroup>,
931
1164
  /**
932
1165
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
933
1166
  * used by this class
@@ -935,7 +1168,8 @@ declare module "sap/tnt/NavigationListItem" {
935
1168
  FNMetaImpl?: Function
936
1169
  ): Function;
937
1170
  /**
938
- * Returns a metadata object for class sap.tnt.NavigationListItem.
1171
+ * Returns a metadata object for class sap.tnt.NavigationListGroup.
1172
+ *
939
1173
  *
940
1174
  * @returns Metadata object describing this class
941
1175
  */
@@ -943,6 +1177,8 @@ declare module "sap/tnt/NavigationListItem" {
943
1177
  /**
944
1178
  * Adds some item to the aggregation {@link #getItems items}.
945
1179
  *
1180
+ * @since 1.121.0
1181
+ *
946
1182
  * @returns Reference to `this` in order to allow method chaining
947
1183
  */
948
1184
  addItem(
@@ -952,43 +1188,234 @@ declare module "sap/tnt/NavigationListItem" {
952
1188
  oItem: NavigationListItem
953
1189
  ): this;
954
1190
  /**
955
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
956
- *
957
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
958
- * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1191
+ * Destroys all the items in the aggregation {@link #getItems items}.
959
1192
  *
960
- * Fired when this item is selected.
1193
+ * @since 1.121.0
961
1194
  *
962
1195
  * @returns Reference to `this` in order to allow method chaining
963
1196
  */
964
- attachSelect(
965
- /**
966
- * An application-specific payload object that will be passed to the event handler along with the event
967
- * object when firing the event
968
- */
969
- oData: object,
970
- /**
971
- * The function to be called when the event occurs
972
- */
973
- fnFunction: (p1: NavigationListItem$SelectEvent) => void,
974
- /**
975
- * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
976
- */
977
- oListener?: object
978
- ): this;
1197
+ destroyItems(): this;
979
1198
  /**
980
- * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1199
+ * Gets content of aggregation {@link #getItems items}.
981
1200
  *
982
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
983
- * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1201
+ * The sub items.
984
1202
  *
985
- * Fired when this item is selected.
1203
+ * @since 1.121.0
1204
+ */
1205
+ getItems(): NavigationListItem[];
1206
+ /**
1207
+ * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
1208
+ * returns its index if found or -1 otherwise.
986
1209
  *
987
- * @returns Reference to `this` in order to allow method chaining
1210
+ * @since 1.121.0
1211
+ *
1212
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
988
1213
  */
989
- attachSelect(
1214
+ indexOfItem(
990
1215
  /**
991
- * The function to be called when the event occurs
1216
+ * The item whose index is looked for
1217
+ */
1218
+ oItem: NavigationListItem
1219
+ ): int;
1220
+ /**
1221
+ * Inserts a item into the aggregation {@link #getItems items}.
1222
+ *
1223
+ * @since 1.121.0
1224
+ *
1225
+ * @returns Reference to `this` in order to allow method chaining
1226
+ */
1227
+ insertItem(
1228
+ /**
1229
+ * The item to insert; if empty, nothing is inserted
1230
+ */
1231
+ oItem: NavigationListItem,
1232
+ /**
1233
+ * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
1234
+ * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
1235
+ * the last position
1236
+ */
1237
+ iIndex: int
1238
+ ): this;
1239
+ /**
1240
+ * Removes all the controls from the aggregation {@link #getItems items}.
1241
+ *
1242
+ * Additionally, it unregisters them from the hosting UIArea.
1243
+ *
1244
+ * @since 1.121.0
1245
+ *
1246
+ * @returns An array of the removed elements (might be empty)
1247
+ */
1248
+ removeAllItems(): NavigationListItem[];
1249
+ /**
1250
+ * Removes a item from the aggregation {@link #getItems items}.
1251
+ *
1252
+ * @since 1.121.0
1253
+ *
1254
+ * @returns The removed item or `null`
1255
+ */
1256
+ removeItem(
1257
+ /**
1258
+ * The item to remove or its index or id
1259
+ */
1260
+ vItem: int | string | NavigationListItem
1261
+ ): NavigationListItem | null;
1262
+ }
1263
+
1264
+ export interface $NavigationListGroupSettings
1265
+ extends $NavigationListItemBaseSettings {
1266
+ /**
1267
+ * The sub items.
1268
+ *
1269
+ * @since 1.121.0
1270
+ */
1271
+ items?:
1272
+ | NavigationListItem[]
1273
+ | NavigationListItem
1274
+ | AggregationBindingInfo
1275
+ | `{${string}}`;
1276
+ }
1277
+ }
1278
+
1279
+ declare module "sap/tnt/NavigationListItem" {
1280
+ import {
1281
+ default as NavigationListItemBase,
1282
+ $NavigationListItemBaseSettings,
1283
+ } from "sap/tnt/NavigationListItemBase";
1284
+
1285
+ import { URI } from "sap/ui/core/library";
1286
+
1287
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1288
+
1289
+ import {
1290
+ PropertyBindingInfo,
1291
+ AggregationBindingInfo,
1292
+ } from "sap/ui/base/ManagedObject";
1293
+
1294
+ import Item from "sap/ui/core/Item";
1295
+
1296
+ import Event from "sap/ui/base/Event";
1297
+
1298
+ /**
1299
+ * The NavigationListItem represents a navigation action, which can be selected by the user. It can provide
1300
+ * sub items.
1301
+ *
1302
+ * @since 1.34
1303
+ */
1304
+ export default class NavigationListItem extends NavigationListItemBase {
1305
+ /**
1306
+ * Constructor for a new NavigationListItem.
1307
+ *
1308
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1309
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1310
+ * of the syntax of the settings object.
1311
+ */
1312
+ constructor(
1313
+ /**
1314
+ * Initial settings for the new control
1315
+ */
1316
+ mSettings?: $NavigationListItemSettings
1317
+ );
1318
+ /**
1319
+ * Constructor for a new NavigationListItem.
1320
+ *
1321
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1322
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1323
+ * of the syntax of the settings object.
1324
+ */
1325
+ constructor(
1326
+ /**
1327
+ * ID for the new control, generated automatically if no ID is given
1328
+ */
1329
+ sId?: string,
1330
+ /**
1331
+ * Initial settings for the new control
1332
+ */
1333
+ mSettings?: $NavigationListItemSettings
1334
+ );
1335
+
1336
+ /**
1337
+ * Creates a new subclass of class sap.tnt.NavigationListItem with name `sClassName` and enriches it with
1338
+ * the information contained in `oClassInfo`.
1339
+ *
1340
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.tnt.NavigationListItemBase.extend}.
1341
+ *
1342
+ *
1343
+ * @returns Created class / constructor function
1344
+ */
1345
+ static extend<T extends Record<string, unknown>>(
1346
+ /**
1347
+ * Name of the class being created
1348
+ */
1349
+ sClassName: string,
1350
+ /**
1351
+ * Object literal with information about the class
1352
+ */
1353
+ oClassInfo?: sap.ClassInfo<T, NavigationListItem>,
1354
+ /**
1355
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1356
+ * used by this class
1357
+ */
1358
+ FNMetaImpl?: Function
1359
+ ): Function;
1360
+ /**
1361
+ * Returns a metadata object for class sap.tnt.NavigationListItem.
1362
+ *
1363
+ *
1364
+ * @returns Metadata object describing this class
1365
+ */
1366
+ static getMetadata(): ElementMetadata;
1367
+ /**
1368
+ * Adds some item to the aggregation {@link #getItems items}.
1369
+ *
1370
+ *
1371
+ * @returns Reference to `this` in order to allow method chaining
1372
+ */
1373
+ addItem(
1374
+ /**
1375
+ * The item to add; if empty, nothing is inserted
1376
+ */
1377
+ oItem: NavigationListItem
1378
+ ): this;
1379
+ /**
1380
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1381
+ *
1382
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1383
+ * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1384
+ *
1385
+ * Fired when this item is selected.
1386
+ *
1387
+ *
1388
+ * @returns Reference to `this` in order to allow method chaining
1389
+ */
1390
+ attachSelect(
1391
+ /**
1392
+ * An application-specific payload object that will be passed to the event handler along with the event
1393
+ * object when firing the event
1394
+ */
1395
+ oData: object,
1396
+ /**
1397
+ * The function to be called when the event occurs
1398
+ */
1399
+ fnFunction: (p1: NavigationListItem$SelectEvent) => void,
1400
+ /**
1401
+ * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself
1402
+ */
1403
+ oListener?: object
1404
+ ): this;
1405
+ /**
1406
+ * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`.
1407
+ *
1408
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1409
+ * otherwise it will be bound to this `sap.tnt.NavigationListItem` itself.
1410
+ *
1411
+ * Fired when this item is selected.
1412
+ *
1413
+ *
1414
+ * @returns Reference to `this` in order to allow method chaining
1415
+ */
1416
+ attachSelect(
1417
+ /**
1418
+ * The function to be called when the event occurs
992
1419
  */
993
1420
  fnFunction: (p1: NavigationListItem$SelectEvent) => void,
994
1421
  /**
@@ -999,6 +1426,7 @@ declare module "sap/tnt/NavigationListItem" {
999
1426
  /**
1000
1427
  * Destroys all the items in the aggregation {@link #getItems items}.
1001
1428
  *
1429
+ *
1002
1430
  * @returns Reference to `this` in order to allow method chaining
1003
1431
  */
1004
1432
  destroyItems(): this;
@@ -1007,6 +1435,7 @@ declare module "sap/tnt/NavigationListItem" {
1007
1435
  *
1008
1436
  * The passed function and listener object must match the ones used for event registration.
1009
1437
  *
1438
+ *
1010
1439
  * @returns Reference to `this` in order to allow method chaining
1011
1440
  */
1012
1441
  detachSelect(
@@ -1020,10 +1449,10 @@ declare module "sap/tnt/NavigationListItem" {
1020
1449
  oListener?: object
1021
1450
  ): this;
1022
1451
  /**
1023
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1024
- *
1025
1452
  * Fires event {@link #event:select select} to attached listeners.
1026
1453
  *
1454
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1455
+ *
1027
1456
  * @returns Reference to `this` in order to allow method chaining
1028
1457
  */
1029
1458
  fireSelect(
@@ -1032,40 +1461,13 @@ declare module "sap/tnt/NavigationListItem" {
1032
1461
  */
1033
1462
  mParameters?: NavigationListItem$SelectEventParameters
1034
1463
  ): this;
1035
- /**
1036
- * Gets current value of property {@link #getExpanded expanded}.
1037
- *
1038
- * Specifies if the item is expanded.
1039
- *
1040
- * Default value is `true`.
1041
- *
1042
- * @returns Value of property `expanded`
1043
- */
1044
- getExpanded(): boolean;
1045
- /**
1046
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1047
- *
1048
- * Returns the DOM Element that should get the focus.
1049
- *
1050
- * @returns Returns the DOM Element that should get the focus
1051
- */
1052
- getFocusDomRef(): Element;
1053
- /**
1054
- * Gets current value of property {@link #getHasExpander hasExpander}.
1055
- *
1056
- * Specifies if the item has an expander.
1057
- *
1058
- * Default value is `true`.
1059
- *
1060
- * @returns Value of property `hasExpander`
1061
- */
1062
- getHasExpander(): boolean;
1063
1464
  /**
1064
1465
  * Gets current value of property {@link #getHref href}.
1065
1466
  *
1066
1467
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1067
1468
  * this should not be set, but instead an event handler for the `select` event should be registered.
1068
1469
  *
1470
+ *
1069
1471
  * @returns Value of property `href`
1070
1472
  */
1071
1473
  getHref(): URI;
@@ -1076,6 +1478,7 @@ declare module "sap/tnt/NavigationListItem" {
1076
1478
  *
1077
1479
  * Default value is `empty string`.
1078
1480
  *
1481
+ *
1079
1482
  * @returns Value of property `icon`
1080
1483
  */
1081
1484
  getIcon(): URI;
@@ -1086,16 +1489,17 @@ declare module "sap/tnt/NavigationListItem" {
1086
1489
  */
1087
1490
  getItems(): NavigationListItem[];
1088
1491
  /**
1089
- * @since 1.116
1090
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1091
- * may be done before its official public release.
1092
- *
1093
1492
  * Gets current value of property {@link #getSelectable selectable}.
1094
1493
  *
1095
- * Specifies if the item can be selected.
1494
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1495
+ * `href` is also used.
1096
1496
  *
1097
1497
  * Default value is `true`.
1098
1498
  *
1499
+ * @since 1.116
1500
+ * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1501
+ * may be done before its official public release.
1502
+ *
1099
1503
  * @returns Value of property `selectable`
1100
1504
  */
1101
1505
  getSelectable(): boolean;
@@ -1108,18 +1512,19 @@ declare module "sap/tnt/NavigationListItem" {
1108
1512
  * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1109
1513
  * is set.
1110
1514
  *
1515
+ *
1111
1516
  * @returns Value of property `target`
1112
1517
  */
1113
1518
  getTarget(): string;
1114
1519
  /**
1115
- * @since 1.52
1116
- *
1117
1520
  * Gets current value of property {@link #getVisible visible}.
1118
1521
  *
1119
1522
  * Specifies if the item should be shown.
1120
1523
  *
1121
1524
  * Default value is `true`.
1122
1525
  *
1526
+ * @since 1.52
1527
+ *
1123
1528
  * @returns Value of property `visible`
1124
1529
  */
1125
1530
  getVisible(): boolean;
@@ -1127,6 +1532,7 @@ declare module "sap/tnt/NavigationListItem" {
1127
1532
  * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and
1128
1533
  * returns its index if found or -1 otherwise.
1129
1534
  *
1535
+ *
1130
1536
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1131
1537
  */
1132
1538
  indexOfItem(
@@ -1138,6 +1544,7 @@ declare module "sap/tnt/NavigationListItem" {
1138
1544
  /**
1139
1545
  * Inserts a item into the aggregation {@link #getItems items}.
1140
1546
  *
1547
+ *
1141
1548
  * @returns Reference to `this` in order to allow method chaining
1142
1549
  */
1143
1550
  insertItem(
@@ -1157,12 +1564,14 @@ declare module "sap/tnt/NavigationListItem" {
1157
1564
  *
1158
1565
  * Additionally, it unregisters them from the hosting UIArea.
1159
1566
  *
1567
+ *
1160
1568
  * @returns An array of the removed elements (might be empty)
1161
1569
  */
1162
1570
  removeAllItems(): NavigationListItem[];
1163
1571
  /**
1164
1572
  * Removes a item from the aggregation {@link #getItems items}.
1165
1573
  *
1574
+ *
1166
1575
  * @returns The removed item or `null`
1167
1576
  */
1168
1577
  removeItem(
@@ -1172,115 +1581,327 @@ declare module "sap/tnt/NavigationListItem" {
1172
1581
  vItem: int | string | NavigationListItem
1173
1582
  ): NavigationListItem | null;
1174
1583
  /**
1175
- * Sets a new value for property {@link #getExpanded expanded}.
1584
+ * Sets a new value for property {@link #getHref href}.
1585
+ *
1586
+ * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1587
+ * this should not be set, but instead an event handler for the `select` event should be registered.
1588
+ *
1589
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1176
1590
  *
1177
- * Specifies if the item is expanded.
1591
+ *
1592
+ * @returns Reference to `this` in order to allow method chaining
1593
+ */
1594
+ setHref(
1595
+ /**
1596
+ * New value for property `href`
1597
+ */
1598
+ sHref?: URI
1599
+ ): this;
1600
+ /**
1601
+ * Sets a new value for property {@link #getIcon icon}.
1602
+ *
1603
+ * Specifies the icon for the item.
1604
+ *
1605
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1606
+ *
1607
+ * Default value is `empty string`.
1608
+ *
1609
+ *
1610
+ * @returns Reference to `this` in order to allow method chaining
1611
+ */
1612
+ setIcon(
1613
+ /**
1614
+ * New value for property `icon`
1615
+ */
1616
+ sIcon?: URI
1617
+ ): this;
1618
+ /**
1619
+ * Sets a new value for property {@link #getSelectable selectable}.
1620
+ *
1621
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1622
+ * `href` is also used.
1178
1623
  *
1179
1624
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1180
1625
  *
1181
1626
  * Default value is `true`.
1182
1627
  *
1628
+ * @since 1.116
1629
+ * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1630
+ * may be done before its official public release.
1631
+ *
1183
1632
  * @returns Reference to `this` in order to allow method chaining
1184
1633
  */
1185
- setExpanded(
1634
+ setSelectable(
1186
1635
  /**
1187
- * New value for property `expanded`
1636
+ * New value for property `selectable`
1188
1637
  */
1189
- bExpanded?: boolean
1638
+ bSelectable?: boolean
1190
1639
  ): this;
1191
1640
  /**
1192
- * Sets a new value for property {@link #getHasExpander hasExpander}.
1641
+ * Sets a new value for property {@link #getTarget target}.
1642
+ *
1643
+ * Specifies the browsing context where the linked content will open.
1193
1644
  *
1194
- * Specifies if the item has an expander.
1645
+ * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1646
+ * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1647
+ * is set.
1648
+ *
1649
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1650
+ *
1651
+ *
1652
+ * @returns Reference to `this` in order to allow method chaining
1653
+ */
1654
+ setTarget(
1655
+ /**
1656
+ * New value for property `target`
1657
+ */
1658
+ sTarget?: string
1659
+ ): this;
1660
+ /**
1661
+ * Sets a new value for property {@link #getVisible visible}.
1662
+ *
1663
+ * Specifies if the item should be shown.
1195
1664
  *
1196
1665
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1197
1666
  *
1198
1667
  * Default value is `true`.
1199
1668
  *
1669
+ * @since 1.52
1670
+ *
1200
1671
  * @returns Reference to `this` in order to allow method chaining
1201
1672
  */
1202
- setHasExpander(
1673
+ setVisible(
1203
1674
  /**
1204
- * New value for property `hasExpander`
1675
+ * New value for property `visible`
1205
1676
  */
1206
- bHasExpander?: boolean
1677
+ bVisible?: boolean
1207
1678
  ): this;
1679
+ }
1680
+
1681
+ export interface $NavigationListItemSettings
1682
+ extends $NavigationListItemBaseSettings {
1208
1683
  /**
1209
- * Sets a new value for property {@link #getHref href}.
1684
+ * Specifies the icon for the item.
1685
+ */
1686
+ icon?: URI | PropertyBindingInfo | `{${string}}`;
1687
+
1688
+ /**
1689
+ * Specifies if the item should be shown.
1210
1690
  *
1691
+ * @since 1.52
1692
+ */
1693
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1694
+
1695
+ /**
1696
+ * Specifies if the item can be selected. It is recommended to set this property to `false` when the property
1697
+ * `href` is also used.
1698
+ *
1699
+ * @since 1.116
1700
+ * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1701
+ * may be done before its official public release.
1702
+ */
1703
+ selectable?: boolean | PropertyBindingInfo | `{${string}}`;
1704
+
1705
+ /**
1211
1706
  * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1212
1707
  * this should not be set, but instead an event handler for the `select` event should be registered.
1708
+ */
1709
+ href?: URI | PropertyBindingInfo | `{${string}}`;
1710
+
1711
+ /**
1712
+ * Specifies the browsing context where the linked content will open.
1713
+ *
1714
+ * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1715
+ * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1716
+ * is set.
1717
+ */
1718
+ target?: string | PropertyBindingInfo;
1719
+
1720
+ /**
1721
+ * The sub items.
1722
+ */
1723
+ items?:
1724
+ | NavigationListItem[]
1725
+ | NavigationListItem
1726
+ | AggregationBindingInfo
1727
+ | `{${string}}`;
1728
+
1729
+ /**
1730
+ * Fired when this item is selected.
1731
+ */
1732
+ select?: (oEvent: NavigationListItem$SelectEvent) => void;
1733
+ }
1734
+
1735
+ export interface NavigationListItem$SelectEventParameters {
1736
+ /**
1737
+ * The selected item.
1738
+ */
1739
+ item?: Item;
1740
+ }
1741
+
1742
+ export type NavigationListItem$SelectEvent = Event<
1743
+ NavigationListItem$SelectEventParameters,
1744
+ NavigationListItem
1745
+ >;
1746
+ }
1747
+
1748
+ declare module "sap/tnt/NavigationListItemBase" {
1749
+ import { default as Item, $ItemSettings } from "sap/ui/core/Item";
1750
+
1751
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
1752
+
1753
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1754
+
1755
+ /**
1756
+ * The `NavigationListItemBase` class represents a base class for the items that are accepted by the `NavigationList`
1757
+ * control.
1758
+ *
1759
+ * @since 1.121
1760
+ */
1761
+ export default abstract class NavigationListItemBase extends Item {
1762
+ /**
1763
+ * Constructor for a new `NavigationListItemBase`.
1764
+ *
1765
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1766
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1767
+ * of the syntax of the settings object.
1768
+ */
1769
+ constructor(
1770
+ /**
1771
+ * Initial settings for the new control
1772
+ */
1773
+ mSettings?: $NavigationListItemBaseSettings
1774
+ );
1775
+ /**
1776
+ * Constructor for a new `NavigationListItemBase`.
1777
+ *
1778
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1779
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1780
+ * of the syntax of the settings object.
1781
+ */
1782
+ constructor(
1783
+ /**
1784
+ * ID for the new control, generated automatically if no ID is given
1785
+ */
1786
+ sId?: string,
1787
+ /**
1788
+ * Initial settings for the new control
1789
+ */
1790
+ mSettings?: $NavigationListItemBaseSettings
1791
+ );
1792
+
1793
+ /**
1794
+ * Creates a new subclass of class sap.tnt.NavigationListItemBase with name `sClassName` and enriches it
1795
+ * with the information contained in `oClassInfo`.
1796
+ *
1797
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
1798
+ *
1799
+ *
1800
+ * @returns Created class / constructor function
1801
+ */
1802
+ static extend<T extends Record<string, unknown>>(
1803
+ /**
1804
+ * Name of the class being created
1805
+ */
1806
+ sClassName: string,
1807
+ /**
1808
+ * Object literal with information about the class
1809
+ */
1810
+ oClassInfo?: sap.ClassInfo<T, NavigationListItemBase>,
1811
+ /**
1812
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1813
+ * used by this class
1814
+ */
1815
+ FNMetaImpl?: Function
1816
+ ): Function;
1817
+ /**
1818
+ * Returns a metadata object for class sap.tnt.NavigationListItemBase.
1819
+ *
1820
+ *
1821
+ * @returns Metadata object describing this class
1822
+ */
1823
+ static getMetadata(): ElementMetadata;
1824
+ /**
1825
+ * Gets current value of property {@link #getExpanded expanded}.
1826
+ *
1827
+ * Specifies if the item is expanded.
1828
+ *
1829
+ * Default value is `true`.
1830
+ *
1831
+ * @since 1.121
1832
+ *
1833
+ * @returns Value of property `expanded`
1834
+ */
1835
+ getExpanded(): boolean;
1836
+ /**
1837
+ * Returns the DOM Element that should get the focus.
1838
+ *
1839
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1840
+ *
1841
+ * @returns Returns the DOM Element that should get the focus
1842
+ */
1843
+ getFocusDomRef(): Element;
1844
+ /**
1845
+ * Gets current value of property {@link #getHasExpander hasExpander}.
1846
+ *
1847
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
1848
+ *
1849
+ * Default value is `true`.
1213
1850
  *
1214
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1215
1851
  *
1216
- * @returns Reference to `this` in order to allow method chaining
1852
+ * @returns Value of property `hasExpander`
1217
1853
  */
1218
- setHref(
1219
- /**
1220
- * New value for property `href`
1221
- */
1222
- sHref?: URI
1223
- ): this;
1854
+ getHasExpander(): boolean;
1224
1855
  /**
1225
- * Sets a new value for property {@link #getIcon icon}.
1856
+ * Gets current value of property {@link #getVisible visible}.
1226
1857
  *
1227
- * Specifies the icon for the item.
1858
+ * Specifies if the item should be shown.
1228
1859
  *
1229
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1860
+ * Default value is `true`.
1230
1861
  *
1231
- * Default value is `empty string`.
1862
+ * @since 1.121
1232
1863
  *
1233
- * @returns Reference to `this` in order to allow method chaining
1864
+ * @returns Value of property `visible`
1234
1865
  */
1235
- setIcon(
1236
- /**
1237
- * New value for property `icon`
1238
- */
1239
- sIcon?: URI
1240
- ): this;
1866
+ getVisible(): boolean;
1241
1867
  /**
1242
- * @since 1.116
1243
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1244
- * may be done before its official public release.
1245
- *
1246
- * Sets a new value for property {@link #getSelectable selectable}.
1868
+ * Sets a new value for property {@link #getExpanded expanded}.
1247
1869
  *
1248
- * Specifies if the item can be selected.
1870
+ * Specifies if the item is expanded.
1249
1871
  *
1250
1872
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1251
1873
  *
1252
1874
  * Default value is `true`.
1253
1875
  *
1876
+ * @since 1.121
1877
+ *
1254
1878
  * @returns Reference to `this` in order to allow method chaining
1255
1879
  */
1256
- setSelectable(
1880
+ setExpanded(
1257
1881
  /**
1258
- * New value for property `selectable`
1882
+ * New value for property `expanded`
1259
1883
  */
1260
- bSelectable?: boolean
1884
+ bExpanded?: boolean
1261
1885
  ): this;
1262
1886
  /**
1263
- * Sets a new value for property {@link #getTarget target}.
1264
- *
1265
- * Specifies the browsing context where the linked content will open.
1887
+ * Sets a new value for property {@link #getHasExpander hasExpander}.
1266
1888
  *
1267
- * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1268
- * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1269
- * is set.
1889
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
1270
1890
  *
1271
1891
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1272
1892
  *
1893
+ * Default value is `true`.
1894
+ *
1895
+ *
1273
1896
  * @returns Reference to `this` in order to allow method chaining
1274
1897
  */
1275
- setTarget(
1898
+ setHasExpander(
1276
1899
  /**
1277
- * New value for property `target`
1900
+ * New value for property `hasExpander`
1278
1901
  */
1279
- sTarget?: string
1902
+ bHasExpander?: boolean
1280
1903
  ): this;
1281
1904
  /**
1282
- * @since 1.52
1283
- *
1284
1905
  * Sets a new value for property {@link #getVisible visible}.
1285
1906
  *
1286
1907
  * Specifies if the item should be shown.
@@ -1289,6 +1910,8 @@ declare module "sap/tnt/NavigationListItem" {
1289
1910
  *
1290
1911
  * Default value is `true`.
1291
1912
  *
1913
+ * @since 1.121
1914
+ *
1292
1915
  * @returns Reference to `this` in order to allow method chaining
1293
1916
  */
1294
1917
  setVisible(
@@ -1299,79 +1922,26 @@ declare module "sap/tnt/NavigationListItem" {
1299
1922
  ): this;
1300
1923
  }
1301
1924
 
1302
- export interface $NavigationListItemSettings extends $ItemSettings {
1303
- /**
1304
- * Specifies the icon for the item.
1305
- */
1306
- icon?: URI | PropertyBindingInfo | `{${string}}`;
1307
-
1925
+ export interface $NavigationListItemBaseSettings extends $ItemSettings {
1308
1926
  /**
1309
1927
  * Specifies if the item is expanded.
1928
+ *
1929
+ * @since 1.121
1310
1930
  */
1311
1931
  expanded?: boolean | PropertyBindingInfo | `{${string}}`;
1312
1932
 
1313
1933
  /**
1314
- * Specifies if the item has an expander.
1934
+ * Specifies if the item is allowed to be expanded or collapsed by the user.
1315
1935
  */
1316
1936
  hasExpander?: boolean | PropertyBindingInfo | `{${string}}`;
1317
1937
 
1318
1938
  /**
1319
- * @since 1.52
1320
- *
1321
1939
  * Specifies if the item should be shown.
1322
- */
1323
- visible?: boolean | PropertyBindingInfo | `{${string}}`;
1324
-
1325
- /**
1326
- * @since 1.116
1327
- * @experimental (since 1.116) - Disclaimer: this property is in a beta state - incompatible API changes
1328
- * may be done before its official public release.
1329
- *
1330
- * Specifies if the item can be selected.
1331
- */
1332
- selectable?: boolean | PropertyBindingInfo | `{${string}}`;
1333
-
1334
- /**
1335
- * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered,
1336
- * this should not be set, but instead an event handler for the `select` event should be registered.
1337
- */
1338
- href?: URI | PropertyBindingInfo | `{${string}}`;
1339
-
1340
- /**
1341
- * Specifies the browsing context where the linked content will open.
1342
1940
  *
1343
- * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`,
1344
- * `_search`. Alternatively, a frame name can be entered. This property is only used when the `href` property
1345
- * is set.
1346
- */
1347
- target?: string | PropertyBindingInfo;
1348
-
1349
- /**
1350
- * The sub items.
1351
- */
1352
- items?:
1353
- | NavigationListItem[]
1354
- | NavigationListItem
1355
- | AggregationBindingInfo
1356
- | `{${string}}`;
1357
-
1358
- /**
1359
- * Fired when this item is selected.
1360
- */
1361
- select?: (oEvent: NavigationListItem$SelectEvent) => void;
1362
- }
1363
-
1364
- export interface NavigationListItem$SelectEventParameters {
1365
- /**
1366
- * The selected item.
1941
+ * @since 1.121
1367
1942
  */
1368
- item?: Item;
1943
+ visible?: boolean | PropertyBindingInfo | `{${string}}`;
1369
1944
  }
1370
-
1371
- export type NavigationListItem$SelectEvent = Event<
1372
- NavigationListItem$SelectEventParameters,
1373
- NavigationListItem
1374
- >;
1375
1945
  }
1376
1946
 
1377
1947
  declare module "sap/tnt/SideNavigation" {
@@ -1395,17 +1965,17 @@ declare module "sap/tnt/SideNavigation" {
1395
1965
  import Event from "sap/ui/base/Event";
1396
1966
 
1397
1967
  /**
1398
- * @since 1.34
1399
- *
1400
- * The SideNavigation control is a container, which consists of flexible and fixed parts on top of each
1968
+ * The `SideNavigation` control is a container, which consists of flexible and fixed parts on top of each
1401
1969
  * other. Responsive Behavior:
1402
1970
  * - The flexible part adapts its size to the fixed one.
1403
1971
  * - The flexible part has a scrollbar when the content is larger than the available space. **Note:**
1404
- * In order for the SideNavigation to stretch properly, its parent layout control should only be the sap.tnt.ToolPage.
1972
+ * In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`.
1973
+ *
1974
+ * @since 1.34
1405
1975
  */
1406
1976
  export default class SideNavigation extends Control {
1407
1977
  /**
1408
- * Constructor for a new SideNavigation.
1978
+ * Constructor for a new `SideNavigation`.
1409
1979
  *
1410
1980
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1411
1981
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1418,7 +1988,7 @@ declare module "sap/tnt/SideNavigation" {
1418
1988
  mSettings?: $SideNavigationSettings
1419
1989
  );
1420
1990
  /**
1421
- * Constructor for a new SideNavigation.
1991
+ * Constructor for a new `SideNavigation`.
1422
1992
  *
1423
1993
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1424
1994
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
@@ -1441,6 +2011,7 @@ declare module "sap/tnt/SideNavigation" {
1441
2011
  *
1442
2012
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1443
2013
  *
2014
+ *
1444
2015
  * @returns Created class / constructor function
1445
2016
  */
1446
2017
  static extend<T extends Record<string, unknown>>(
@@ -1461,6 +2032,7 @@ declare module "sap/tnt/SideNavigation" {
1461
2032
  /**
1462
2033
  * Returns a metadata object for class sap.tnt.SideNavigation.
1463
2034
  *
2035
+ *
1464
2036
  * @returns Metadata object describing this class
1465
2037
  */
1466
2038
  static getMetadata(): ElementMetadata;
@@ -1472,6 +2044,7 @@ declare module "sap/tnt/SideNavigation" {
1472
2044
  *
1473
2045
  * Fired when an item is selected.
1474
2046
  *
2047
+ *
1475
2048
  * @returns Reference to `this` in order to allow method chaining
1476
2049
  */
1477
2050
  attachItemSelect(
@@ -1497,6 +2070,7 @@ declare module "sap/tnt/SideNavigation" {
1497
2070
  *
1498
2071
  * Fired when an item is selected.
1499
2072
  *
2073
+ *
1500
2074
  * @returns Reference to `this` in order to allow method chaining
1501
2075
  */
1502
2076
  attachItemSelect(
@@ -1515,6 +2089,7 @@ declare module "sap/tnt/SideNavigation" {
1515
2089
  * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
1516
2090
  * of the possible properties of `oBindingInfo`.
1517
2091
  *
2092
+ *
1518
2093
  * @returns Reference to `this` in order to allow method chaining
1519
2094
  */
1520
2095
  bindItem(
@@ -1526,20 +2101,22 @@ declare module "sap/tnt/SideNavigation" {
1526
2101
  /**
1527
2102
  * Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}.
1528
2103
  *
2104
+ *
1529
2105
  * @returns Reference to `this` in order to allow method chaining
1530
2106
  */
1531
2107
  destroyFixedItem(): this;
1532
2108
  /**
1533
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1534
- *
1535
2109
  * Destroys the footer in the aggregation {@link #getFooter footer}.
1536
2110
  *
2111
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2112
+ *
1537
2113
  * @returns Reference to `this` in order to allow method chaining
1538
2114
  */
1539
2115
  destroyFooter(): this;
1540
2116
  /**
1541
2117
  * Destroys the item in the aggregation {@link #getItem item}.
1542
2118
  *
2119
+ *
1543
2120
  * @returns Reference to `this` in order to allow method chaining
1544
2121
  */
1545
2122
  destroyItem(): this;
@@ -1548,6 +2125,7 @@ declare module "sap/tnt/SideNavigation" {
1548
2125
  *
1549
2126
  * The passed function and listener object must match the ones used for event registration.
1550
2127
  *
2128
+ *
1551
2129
  * @returns Reference to `this` in order to allow method chaining
1552
2130
  */
1553
2131
  detachItemSelect(
@@ -1561,10 +2139,10 @@ declare module "sap/tnt/SideNavigation" {
1561
2139
  oListener?: object
1562
2140
  ): this;
1563
2141
  /**
1564
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1565
- *
1566
2142
  * Fires event {@link #event:itemSelect itemSelect} to attached listeners.
1567
2143
  *
2144
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2145
+ *
1568
2146
  * @returns Reference to `this` in order to allow method chaining
1569
2147
  */
1570
2148
  fireItemSelect(
@@ -1574,11 +2152,11 @@ declare module "sap/tnt/SideNavigation" {
1574
2152
  mParameters?: SideNavigation$ItemSelectEventParameters
1575
2153
  ): this;
1576
2154
  /**
1577
- * @since 1.98
1578
- *
1579
2155
  * Gets current value of property {@link #getAriaLabel ariaLabel}.
1580
2156
  *
1581
- * Specifies an optional aria-label that can be used by the screen readers.
2157
+ * Specifies an optional `aria-label` that can be used by the screen readers.
2158
+ *
2159
+ * @since 1.98
1582
2160
  *
1583
2161
  * @returns Value of property `ariaLabel`
1584
2162
  */
@@ -1590,6 +2168,7 @@ declare module "sap/tnt/SideNavigation" {
1590
2168
  *
1591
2169
  * Default value is `true`.
1592
2170
  *
2171
+ *
1593
2172
  * @returns Value of property `expanded`
1594
2173
  */
1595
2174
  getExpanded(): boolean;
@@ -1600,11 +2179,11 @@ declare module "sap/tnt/SideNavigation" {
1600
2179
  */
1601
2180
  getFixedItem(): NavigationList;
1602
2181
  /**
1603
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1604
- *
1605
2182
  * Gets content of aggregation {@link #getFooter footer}.
1606
2183
  *
1607
2184
  * Defines the content inside the footer.
2185
+ *
2186
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1608
2187
  */
1609
2188
  getFooter(): NavigationList;
1610
2189
  /**
@@ -1614,25 +2193,23 @@ declare module "sap/tnt/SideNavigation" {
1614
2193
  */
1615
2194
  getItem(): NavigationList;
1616
2195
  /**
1617
- * @since 1.52.0
1618
- *
1619
2196
  * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
1620
2197
  * or `null`.
2198
+ *
2199
+ * @since 1.52.0
1621
2200
  */
1622
- getSelectedItem(): ID;
2201
+ getSelectedItem(): ID | null;
1623
2202
  /**
1624
- * @since 1.62.0
1625
- *
1626
2203
  * Gets current value of property {@link #getSelectedKey selectedKey}.
1627
2204
  *
1628
2205
  * Specifies the currently selected key.
1629
2206
  *
2207
+ * @since 1.62.0
2208
+ *
1630
2209
  * @returns Value of property `selectedKey`
1631
2210
  */
1632
2211
  getSelectedKey(): string;
1633
2212
  /**
1634
- * @since 1.120
1635
- *
1636
2213
  * Gets current value of property {@link #getWidth width}.
1637
2214
  *
1638
2215
  * Specifies the width of the control.
@@ -1640,18 +2217,20 @@ declare module "sap/tnt/SideNavigation" {
1640
2217
  * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
1641
2218
  * can be used to set a bigger width.
1642
2219
  *
2220
+ * @since 1.120
2221
+ *
1643
2222
  * @returns Value of property `width`
1644
2223
  */
1645
2224
  getWidth(): CSSSize;
1646
2225
  /**
1647
- * @since 1.98
1648
- *
1649
2226
  * Sets a new value for property {@link #getAriaLabel ariaLabel}.
1650
2227
  *
1651
- * Specifies an optional aria-label that can be used by the screen readers.
2228
+ * Specifies an optional `aria-label` that can be used by the screen readers.
1652
2229
  *
1653
2230
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1654
2231
  *
2232
+ * @since 1.98
2233
+ *
1655
2234
  * @returns Reference to `this` in order to allow method chaining
1656
2235
  */
1657
2236
  setAriaLabel(
@@ -1663,17 +2242,19 @@ declare module "sap/tnt/SideNavigation" {
1663
2242
  /**
1664
2243
  * Sets if the control is in expanded or collapsed mode.
1665
2244
  *
2245
+ *
1666
2246
  * @returns this SideNavigation reference for chaining.
1667
2247
  */
1668
2248
  setExpanded(
1669
2249
  /**
1670
2250
  * Indication if the SideNavigation is expanded.
1671
2251
  */
1672
- isExpanded: boolean
2252
+ bExpanded: boolean
1673
2253
  ): this;
1674
2254
  /**
1675
2255
  * Sets the aggregated {@link #getFixedItem fixedItem}.
1676
2256
  *
2257
+ *
1677
2258
  * @returns Reference to `this` in order to allow method chaining
1678
2259
  */
1679
2260
  setFixedItem(
@@ -1683,10 +2264,10 @@ declare module "sap/tnt/SideNavigation" {
1683
2264
  oFixedItem: NavigationList
1684
2265
  ): this;
1685
2266
  /**
1686
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1687
- *
1688
2267
  * Sets the aggregated {@link #getFooter footer}.
1689
2268
  *
2269
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
2270
+ *
1690
2271
  * @returns Reference to `this` in order to allow method chaining
1691
2272
  */
1692
2273
  setFooter(
@@ -1698,6 +2279,7 @@ declare module "sap/tnt/SideNavigation" {
1698
2279
  /**
1699
2280
  * Sets the aggregated {@link #getItem item}.
1700
2281
  *
2282
+ *
1701
2283
  * @returns Reference to `this` in order to allow method chaining
1702
2284
  */
1703
2285
  setItem(
@@ -1707,7 +2289,8 @@ declare module "sap/tnt/SideNavigation" {
1707
2289
  oItem: NavigationList
1708
2290
  ): this;
1709
2291
  /**
1710
- * Sets the association for selectedItem
2292
+ * Sets the association for `selectedItem`.
2293
+ *
1711
2294
  *
1712
2295
  * @returns The `selectedItem` association
1713
2296
  */
@@ -1715,22 +2298,21 @@ declare module "sap/tnt/SideNavigation" {
1715
2298
  /**
1716
2299
  * The control to be set as selected
1717
2300
  */
1718
- selectedItem: string | NavigationListItem
2301
+ vSelectedItem: ID | NavigationListItem
1719
2302
  ): SideNavigation | null;
1720
2303
  /**
1721
2304
  * Sets the selected item based on a key.
1722
2305
  *
2306
+ *
1723
2307
  * @returns this pointer for chaining
1724
2308
  */
1725
2309
  setSelectedKey(
1726
2310
  /**
1727
2311
  * The key of the item to be selected
1728
2312
  */
1729
- selectedKey: string
2313
+ sSelectedKey: string
1730
2314
  ): this;
1731
2315
  /**
1732
- * @since 1.120
1733
- *
1734
2316
  * Sets a new value for property {@link #getWidth width}.
1735
2317
  *
1736
2318
  * Specifies the width of the control.
@@ -1740,6 +2322,8 @@ declare module "sap/tnt/SideNavigation" {
1740
2322
  *
1741
2323
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1742
2324
  *
2325
+ * @since 1.120
2326
+ *
1743
2327
  * @returns Reference to `this` in order to allow method chaining
1744
2328
  */
1745
2329
  setWidth(
@@ -1751,6 +2335,7 @@ declare module "sap/tnt/SideNavigation" {
1751
2335
  /**
1752
2336
  * Unbinds aggregation {@link #getItem item} from model data.
1753
2337
  *
2338
+ *
1754
2339
  * @returns Reference to `this` in order to allow method chaining
1755
2340
  */
1756
2341
  unbindItem(): this;
@@ -1758,12 +2343,12 @@ declare module "sap/tnt/SideNavigation" {
1758
2343
 
1759
2344
  export interface $SideNavigationSettings extends $ControlSettings {
1760
2345
  /**
1761
- * @since 1.120
1762
- *
1763
2346
  * Specifies the width of the control.
1764
2347
  *
1765
2348
  * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property
1766
2349
  * can be used to set a bigger width.
2350
+ *
2351
+ * @since 1.120
1767
2352
  */
1768
2353
  width?: CSSSize | PropertyBindingInfo | `{${string}}`;
1769
2354
 
@@ -1773,16 +2358,16 @@ declare module "sap/tnt/SideNavigation" {
1773
2358
  expanded?: boolean | PropertyBindingInfo | `{${string}}`;
1774
2359
 
1775
2360
  /**
1776
- * @since 1.62.0
1777
- *
1778
2361
  * Specifies the currently selected key.
2362
+ *
2363
+ * @since 1.62.0
1779
2364
  */
1780
2365
  selectedKey?: string | PropertyBindingInfo;
1781
2366
 
1782
2367
  /**
1783
- * @since 1.98
2368
+ * Specifies an optional `aria-label` that can be used by the screen readers.
1784
2369
  *
1785
- * Specifies an optional aria-label that can be used by the screen readers.
2370
+ * @since 1.98
1786
2371
  */
1787
2372
  ariaLabel?: string | PropertyBindingInfo;
1788
2373
 
@@ -1797,16 +2382,16 @@ declare module "sap/tnt/SideNavigation" {
1797
2382
  fixedItem?: NavigationList;
1798
2383
 
1799
2384
  /**
1800
- * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1801
- *
1802
2385
  * Defines the content inside the footer.
2386
+ *
2387
+ * @deprecated (since 1.120) - Use the aggregation `fixedItem` instead.
1803
2388
  */
1804
2389
  footer?: NavigationList;
1805
2390
 
1806
2391
  /**
1807
- * @since 1.52.0
1808
- *
1809
2392
  * The selected `NavigationListItem`.
2393
+ *
2394
+ * @since 1.52.0
1810
2395
  */
1811
2396
  selectedItem?: NavigationListItem | string;
1812
2397
 
@@ -1840,8 +2425,6 @@ declare module "sap/tnt/ToolHeader" {
1840
2425
  import ElementMetadata from "sap/ui/core/ElementMetadata";
1841
2426
 
1842
2427
  /**
1843
- * @since 1.34
1844
- *
1845
2428
  * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts,
1846
2429
  * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}.
1847
2430
  * It contains clearly structured menus of commands that are available across the various apps within the
@@ -1876,6 +2459,8 @@ declare module "sap/tnt/ToolHeader" {
1876
2459
  * in Inline mode only. Semantic colors, icons and separators. sap.f.Avatar/sap.m.Avatar
1877
2460
  * Support for default (Accent 6) color. Image avatar. - sap.m.Image
1878
2461
  * Primarily used for displaying the company logo. Interaction states
2462
+ *
2463
+ * @since 1.34
1879
2464
  */
1880
2465
  export default class ToolHeader
1881
2466
  extends OverflowToolbar
@@ -1924,6 +2509,7 @@ declare module "sap/tnt/ToolHeader" {
1924
2509
  *
1925
2510
  * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.extend}.
1926
2511
  *
2512
+ *
1927
2513
  * @returns Created class / constructor function
1928
2514
  */
1929
2515
  static extend<T extends Record<string, unknown>>(
@@ -1944,6 +2530,7 @@ declare module "sap/tnt/ToolHeader" {
1944
2530
  /**
1945
2531
  * Returns a metadata object for class sap.tnt.ToolHeader.
1946
2532
  *
2533
+ *
1947
2534
  * @returns Metadata object describing this class
1948
2535
  */
1949
2536
  static getMetadata(): ElementMetadata;
@@ -1958,10 +2545,10 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
1958
2545
  import ElementMetadata from "sap/ui/core/ElementMetadata";
1959
2546
 
1960
2547
  /**
1961
- * @since 1.16
1962
- *
1963
2548
  * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the
1964
2549
  * overflow button is placed.
2550
+ *
2551
+ * @since 1.16
1965
2552
  */
1966
2553
  export default class ToolHeaderUtilitySeparator extends Control {
1967
2554
  /**
@@ -2007,6 +2594,7 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
2007
2594
  *
2008
2595
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2009
2596
  *
2597
+ *
2010
2598
  * @returns Created class / constructor function
2011
2599
  */
2012
2600
  static extend<T extends Record<string, unknown>>(
@@ -2027,6 +2615,7 @@ declare module "sap/tnt/ToolHeaderUtilitySeparator" {
2027
2615
  /**
2028
2616
  * Returns a metadata object for class sap.tnt.ToolHeaderUtilitySeparator.
2029
2617
  *
2618
+ *
2030
2619
  * @returns Metadata object describing this class
2031
2620
  */
2032
2621
  static getMetadata(): ElementMetadata;
@@ -2053,13 +2642,13 @@ declare module "sap/tnt/ToolPage" {
2053
2642
  } from "sap/ui/base/ManagedObject";
2054
2643
 
2055
2644
  /**
2056
- * @since 1.34
2057
- *
2058
2645
  * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation
2059
2646
  * and contents area. Overview: The control has three main areas - a header on top, navigation to the side
2060
2647
  * and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader }
2061
2648
  * and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in
2062
2649
  * the tooling or administration space.
2650
+ *
2651
+ * @since 1.34
2063
2652
  */
2064
2653
  export default class ToolPage extends Control {
2065
2654
  /**
@@ -2099,6 +2688,7 @@ declare module "sap/tnt/ToolPage" {
2099
2688
  *
2100
2689
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2101
2690
  *
2691
+ *
2102
2692
  * @returns Created class / constructor function
2103
2693
  */
2104
2694
  static extend<T extends Record<string, unknown>>(
@@ -2119,12 +2709,14 @@ declare module "sap/tnt/ToolPage" {
2119
2709
  /**
2120
2710
  * Returns a metadata object for class sap.tnt.ToolPage.
2121
2711
  *
2712
+ *
2122
2713
  * @returns Metadata object describing this class
2123
2714
  */
2124
2715
  static getMetadata(): ElementMetadata;
2125
2716
  /**
2126
2717
  * Adds some mainContent to the aggregation {@link #getMainContents mainContents}.
2127
2718
  *
2719
+ *
2128
2720
  * @returns Reference to `this` in order to allow method chaining
2129
2721
  */
2130
2722
  addMainContent(
@@ -2136,38 +2728,41 @@ declare module "sap/tnt/ToolPage" {
2136
2728
  /**
2137
2729
  * Destroys the header in the aggregation {@link #getHeader header}.
2138
2730
  *
2731
+ *
2139
2732
  * @returns Reference to `this` in order to allow method chaining
2140
2733
  */
2141
2734
  destroyHeader(): this;
2142
2735
  /**
2143
2736
  * Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}.
2144
2737
  *
2738
+ *
2145
2739
  * @returns Reference to `this` in order to allow method chaining
2146
2740
  */
2147
2741
  destroyMainContents(): this;
2148
2742
  /**
2149
2743
  * Destroys the sideContent in the aggregation {@link #getSideContent sideContent}.
2150
2744
  *
2745
+ *
2151
2746
  * @returns Reference to `this` in order to allow method chaining
2152
2747
  */
2153
2748
  destroySideContent(): this;
2154
2749
  /**
2155
- * @since 1.93
2156
- *
2157
2750
  * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}.
2158
2751
  *
2752
+ * @since 1.93
2753
+ *
2159
2754
  * @returns Reference to `this` in order to allow method chaining
2160
2755
  */
2161
2756
  destroySubHeader(): this;
2162
2757
  /**
2163
- * @since 1.115
2164
- *
2165
2758
  * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2166
2759
  *
2167
2760
  * Specifies the content background design.
2168
2761
  *
2169
2762
  * Default value is `Standard`.
2170
2763
  *
2764
+ * @since 1.115
2765
+ *
2171
2766
  * @returns Value of property `contentBackgroundDesign`
2172
2767
  */
2173
2768
  getContentBackgroundDesign():
@@ -2198,21 +2793,23 @@ declare module "sap/tnt/ToolPage" {
2198
2793
  *
2199
2794
  * Default value is `true`.
2200
2795
  *
2796
+ *
2201
2797
  * @returns Value of property `sideExpanded`
2202
2798
  */
2203
2799
  getSideExpanded(): boolean;
2204
2800
  /**
2205
- * @since 1.93
2206
- *
2207
2801
  * Gets content of aggregation {@link #getSubHeader subHeader}.
2208
2802
  *
2209
2803
  * The control to appear in the subheader area.
2804
+ *
2805
+ * @since 1.93
2210
2806
  */
2211
2807
  getSubHeader(): IToolHeader;
2212
2808
  /**
2213
2809
  * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}.
2214
2810
  * and returns its index if found or -1 otherwise.
2215
2811
  *
2812
+ *
2216
2813
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2217
2814
  */
2218
2815
  indexOfMainContent(
@@ -2224,6 +2821,7 @@ declare module "sap/tnt/ToolPage" {
2224
2821
  /**
2225
2822
  * Inserts a mainContent into the aggregation {@link #getMainContents mainContents}.
2226
2823
  *
2824
+ *
2227
2825
  * @returns Reference to `this` in order to allow method chaining
2228
2826
  */
2229
2827
  insertMainContent(
@@ -2243,12 +2841,14 @@ declare module "sap/tnt/ToolPage" {
2243
2841
  *
2244
2842
  * Additionally, it unregisters them from the hosting UIArea.
2245
2843
  *
2844
+ *
2246
2845
  * @returns An array of the removed elements (might be empty)
2247
2846
  */
2248
2847
  removeAllMainContents(): Control[];
2249
2848
  /**
2250
2849
  * Removes a mainContent from the aggregation {@link #getMainContents mainContents}.
2251
2850
  *
2851
+ *
2252
2852
  * @returns The removed mainContent or `null`
2253
2853
  */
2254
2854
  removeMainContent(
@@ -2258,8 +2858,6 @@ declare module "sap/tnt/ToolPage" {
2258
2858
  vMainContent: int | string | Control
2259
2859
  ): Control | null;
2260
2860
  /**
2261
- * @since 1.115
2262
- *
2263
2861
  * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}.
2264
2862
  *
2265
2863
  * Specifies the content background design.
@@ -2268,6 +2866,8 @@ declare module "sap/tnt/ToolPage" {
2268
2866
  *
2269
2867
  * Default value is `Standard`.
2270
2868
  *
2869
+ * @since 1.115
2870
+ *
2271
2871
  * @returns Reference to `this` in order to allow method chaining
2272
2872
  */
2273
2873
  setContentBackgroundDesign(
@@ -2281,6 +2881,7 @@ declare module "sap/tnt/ToolPage" {
2281
2881
  /**
2282
2882
  * Sets the aggregated {@link #getHeader header}.
2283
2883
  *
2884
+ *
2284
2885
  * @returns Reference to `this` in order to allow method chaining
2285
2886
  */
2286
2887
  setHeader(
@@ -2292,6 +2893,7 @@ declare module "sap/tnt/ToolPage" {
2292
2893
  /**
2293
2894
  * Sets the aggregated {@link #getSideContent sideContent}.
2294
2895
  *
2896
+ *
2295
2897
  * @returns Reference to `this` in order to allow method chaining
2296
2898
  */
2297
2899
  setSideContent(
@@ -2303,6 +2905,7 @@ declare module "sap/tnt/ToolPage" {
2303
2905
  /**
2304
2906
  * Sets the expand/collapse state of the SideContent.
2305
2907
  *
2908
+ *
2306
2909
  * @returns Pointer to the control instance for chaining
2307
2910
  */
2308
2911
  setSideExpanded(
@@ -2312,10 +2915,10 @@ declare module "sap/tnt/ToolPage" {
2312
2915
  bSideExpanded: boolean
2313
2916
  ): this;
2314
2917
  /**
2315
- * @since 1.93
2316
- *
2317
2918
  * Sets the aggregated {@link #getSubHeader subHeader}.
2318
2919
  *
2920
+ * @since 1.93
2921
+ *
2319
2922
  * @returns Reference to `this` in order to allow method chaining
2320
2923
  */
2321
2924
  setSubHeader(
@@ -2327,6 +2930,7 @@ declare module "sap/tnt/ToolPage" {
2327
2930
  /**
2328
2931
  * Toggles the expand/collapse state of the SideContent.
2329
2932
  *
2933
+ *
2330
2934
  * @returns Pointer to the control instance for chaining.
2331
2935
  */
2332
2936
  toggleSideContentMode(): this;
@@ -2339,9 +2943,9 @@ declare module "sap/tnt/ToolPage" {
2339
2943
  sideExpanded?: boolean | PropertyBindingInfo | `{${string}}`;
2340
2944
 
2341
2945
  /**
2342
- * @since 1.115
2343
- *
2344
2946
  * Specifies the content background design.
2947
+ *
2948
+ * @since 1.115
2345
2949
  */
2346
2950
  contentBackgroundDesign?:
2347
2951
  | (PageBackgroundDesign | keyof typeof PageBackgroundDesign)
@@ -2354,9 +2958,9 @@ declare module "sap/tnt/ToolPage" {
2354
2958
  header?: IToolHeader;
2355
2959
 
2356
2960
  /**
2357
- * @since 1.93
2358
- *
2359
2961
  * The control to appear in the subheader area.
2962
+ *
2963
+ * @since 1.93
2360
2964
  */
2361
2965
  subHeader?: IToolHeader;
2362
2966
 
@@ -2374,14 +2978,20 @@ declare module "sap/tnt/ToolPage" {
2374
2978
 
2375
2979
  declare namespace sap {
2376
2980
  interface IUI5DefineDependencyNames {
2981
+ "sap/tnt/IllustratedMessageType": undefined;
2982
+
2377
2983
  "sap/tnt/InfoLabel": undefined;
2378
2984
 
2379
2985
  "sap/tnt/library": undefined;
2380
2986
 
2381
2987
  "sap/tnt/NavigationList": undefined;
2382
2988
 
2989
+ "sap/tnt/NavigationListGroup": undefined;
2990
+
2383
2991
  "sap/tnt/NavigationListItem": undefined;
2384
2992
 
2993
+ "sap/tnt/NavigationListItemBase": undefined;
2994
+
2385
2995
  "sap/tnt/SideNavigation": undefined;
2386
2996
 
2387
2997
  "sap/tnt/ToolHeader": undefined;