@openui5/ts-types-esm 1.102.1 → 1.103.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types-esm",
3
- "version": "1.102.1",
3
+ "version": "1.103.0",
4
4
  "description": "OpenUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.1
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
@@ -511,6 +511,8 @@ declare module "sap/f/AvatarGroup" {
511
511
 
512
512
  import Event from "sap/ui/base/Event";
513
513
 
514
+ import { AbsoluteCSSSize } from "sap/ui/core/library";
515
+
514
516
  import AvatarSize from "sap/m/AvatarSize";
515
517
 
516
518
  import { AvatarGroupType } from "sap/f/library";
@@ -720,6 +722,36 @@ declare module "sap/f/AvatarGroup" {
720
722
  avatarsDisplayed?: int;
721
723
  }
722
724
  ): this;
725
+ /**
726
+ * @SINCE 1.103
727
+ *
728
+ * Gets current value of property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
729
+ *
730
+ * Specifies a custom display size for each avatar.
731
+ *
732
+ * **Notes:**
733
+ * - Supports only `px` and code>rem values.
734
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
735
+ *
736
+ * Default value is `"3rem"`.
737
+ *
738
+ * @returns Value of property `avatarCustomDisplaySize`
739
+ */
740
+ getAvatarCustomDisplaySize(): AbsoluteCSSSize;
741
+ /**
742
+ * @SINCE 1.103
743
+ *
744
+ * Gets current value of property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
745
+ *
746
+ * Specifies a custom font size for each avatar.
747
+ *
748
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
749
+ *
750
+ * Default value is `"1.125rem"`.
751
+ *
752
+ * @returns Value of property `avatarCustomFontSize`
753
+ */
754
+ getAvatarCustomFontSize(): AbsoluteCSSSize;
723
755
  /**
724
756
  * Gets current value of property {@link #getAvatarDisplaySize avatarDisplaySize}.
725
757
  *
@@ -793,7 +825,51 @@ declare module "sap/f/AvatarGroup" {
793
825
  * The item to remove or its index or id
794
826
  */
795
827
  vItem: int | string | AvatarGroupItem
796
- ): AvatarGroupItem;
828
+ ): AvatarGroupItem | null;
829
+ /**
830
+ * @SINCE 1.103
831
+ *
832
+ * Sets a new value for property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
833
+ *
834
+ * Specifies a custom display size for each avatar.
835
+ *
836
+ * **Notes:**
837
+ * - Supports only `px` and code>rem values.
838
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
839
+ *
840
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
841
+ *
842
+ * Default value is `"3rem"`.
843
+ *
844
+ * @returns Reference to `this` in order to allow method chaining
845
+ */
846
+ setAvatarCustomDisplaySize(
847
+ /**
848
+ * New value for property `avatarCustomDisplaySize`
849
+ */
850
+ sAvatarCustomDisplaySize?: AbsoluteCSSSize
851
+ ): this;
852
+ /**
853
+ * @SINCE 1.103
854
+ *
855
+ * Sets a new value for property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
856
+ *
857
+ * Specifies a custom font size for each avatar.
858
+ *
859
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
860
+ *
861
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
862
+ *
863
+ * Default value is `"1.125rem"`.
864
+ *
865
+ * @returns Reference to `this` in order to allow method chaining
866
+ */
867
+ setAvatarCustomFontSize(
868
+ /**
869
+ * New value for property `avatarCustomFontSize`
870
+ */
871
+ sAvatarCustomFontSize?: AbsoluteCSSSize
872
+ ): this;
797
873
  /**
798
874
  * Sets a new value for property {@link #getAvatarDisplaySize avatarDisplaySize}.
799
875
  *
@@ -847,6 +923,32 @@ declare module "sap/f/AvatarGroup" {
847
923
  | PropertyBindingInfo
848
924
  | `{${string}}`;
849
925
 
926
+ /**
927
+ * @SINCE 1.103
928
+ *
929
+ * Specifies a custom display size for each avatar.
930
+ *
931
+ * **Notes:**
932
+ * - Supports only `px` and code>rem values.
933
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
934
+ */
935
+ avatarCustomDisplaySize?:
936
+ | AbsoluteCSSSize
937
+ | PropertyBindingInfo
938
+ | `{${string}}`;
939
+
940
+ /**
941
+ * @SINCE 1.103
942
+ *
943
+ * Specifies a custom font size for each avatar.
944
+ *
945
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
946
+ */
947
+ avatarCustomFontSize?:
948
+ | AbsoluteCSSSize
949
+ | PropertyBindingInfo
950
+ | `{${string}}`;
951
+
850
952
  /**
851
953
  * The `AvatarGroupItems` contained by the control.
852
954
  */
@@ -1612,6 +1714,8 @@ declare module "sap/f/cards/Header" {
1612
1714
 
1613
1715
  import Event from "sap/ui/base/Event";
1614
1716
 
1717
+ import Control from "sap/ui/core/Control";
1718
+
1615
1719
  import AvatarColor from "sap/m/AvatarColor";
1616
1720
 
1617
1721
  import AvatarShape from "sap/m/AvatarShape";
@@ -1757,6 +1861,20 @@ declare module "sap/f/cards/Header" {
1757
1861
  */
1758
1862
  oListener?: object
1759
1863
  ): this;
1864
+ /**
1865
+ * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
1866
+ * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
1867
+ */
1868
+ enhanceAccessibilityState(
1869
+ /**
1870
+ * The Control that gets rendered by the RenderManager
1871
+ */
1872
+ oElement: Control,
1873
+ /**
1874
+ * The mapping of "aria-" prefixed attributes
1875
+ */
1876
+ mAriaProps: object
1877
+ ): void;
1760
1878
  /**
1761
1879
  * Fires event {@link #event:press press} to attached listeners.
1762
1880
  *
@@ -2140,6 +2258,8 @@ declare module "sap/f/cards/NumericHeader" {
2140
2258
 
2141
2259
  import Event from "sap/ui/base/Event";
2142
2260
 
2261
+ import Control from "sap/ui/core/Control";
2262
+
2143
2263
  import ElementMetadata from "sap/ui/core/ElementMetadata";
2144
2264
 
2145
2265
  import { ValueColor, DeviationIndicator } from "sap/m/library";
@@ -2306,6 +2426,20 @@ declare module "sap/f/cards/NumericHeader" {
2306
2426
  */
2307
2427
  oListener?: object
2308
2428
  ): this;
2429
+ /**
2430
+ * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
2431
+ * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
2432
+ */
2433
+ enhanceAccessibilityState(
2434
+ /**
2435
+ * The Control that gets rendered by the RenderManager
2436
+ */
2437
+ oElement: Control,
2438
+ /**
2439
+ * The mapping of "aria-" prefixed attributes
2440
+ */
2441
+ mAriaProps: object
2442
+ ): void;
2309
2443
  /**
2310
2444
  * Fires event {@link #event:press press} to attached listeners.
2311
2445
  *
@@ -2502,7 +2636,7 @@ declare module "sap/f/cards/NumericHeader" {
2502
2636
  * The sideIndicator to remove or its index or id
2503
2637
  */
2504
2638
  vSideIndicator: int | string | NumericSideIndicator
2505
- ): NumericSideIndicator;
2639
+ ): NumericSideIndicator | null;
2506
2640
  /**
2507
2641
  * Sets a new value for property {@link #getDetails details}.
2508
2642
  *
@@ -4612,7 +4746,7 @@ declare module "sap/f/DynamicPageHeader" {
4612
4746
  * The content to remove or its index or id
4613
4747
  */
4614
4748
  vContent: int | string | Control
4615
- ): Control;
4749
+ ): Control | null;
4616
4750
  /**
4617
4751
  * @SINCE 1.58
4618
4752
  *
@@ -5391,7 +5525,7 @@ declare module "sap/f/DynamicPageTitle" {
5391
5525
  * The action to remove or its index or id
5392
5526
  */
5393
5527
  vAction: int | string | Control
5394
- ): Control;
5528
+ ): Control | null;
5395
5529
  /**
5396
5530
  * Removes all the controls from the aggregation {@link #getActions actions}.
5397
5531
  *
@@ -5469,7 +5603,7 @@ declare module "sap/f/DynamicPageTitle" {
5469
5603
  * The content to remove or its index or id
5470
5604
  */
5471
5605
  vContent: int | string | Control
5472
- ): Control;
5606
+ ): Control | null;
5473
5607
  /**
5474
5608
  * Removes a expandedContent from the aggregation {@link #getExpandedContent expandedContent}.
5475
5609
  *
@@ -5480,7 +5614,7 @@ declare module "sap/f/DynamicPageTitle" {
5480
5614
  * The expandedContent to remove or its index or id
5481
5615
  */
5482
5616
  vExpandedContent: int | string | Control
5483
- ): Control;
5617
+ ): Control | null;
5484
5618
  /**
5485
5619
  * @SINCE 1.52
5486
5620
  *
@@ -5493,7 +5627,7 @@ declare module "sap/f/DynamicPageTitle" {
5493
5627
  * The navigationAction to remove or its index or id
5494
5628
  */
5495
5629
  vNavigationAction: int | string | Button
5496
- ): Button;
5630
+ ): Button | null;
5497
5631
  /**
5498
5632
  * Removes a snappedContent from the aggregation {@link #getSnappedContent snappedContent}.
5499
5633
  *
@@ -5504,7 +5638,7 @@ declare module "sap/f/DynamicPageTitle" {
5504
5638
  * The snappedContent to remove or its index or id
5505
5639
  */
5506
5640
  vSnappedContent: int | string | Control
5507
- ): Control;
5641
+ ): Control | null;
5508
5642
  /**
5509
5643
  * @SINCE 1.54
5510
5644
  *
@@ -7422,7 +7556,7 @@ declare module "sap/f/FlexibleColumnLayout" {
7422
7556
  * The beginColumnPage to remove or its index or id
7423
7557
  */
7424
7558
  vBeginColumnPage: int | string | Control
7425
- ): Control;
7559
+ ): Control | null;
7426
7560
  /**
7427
7561
  * Removes a endColumnPage from the aggregation {@link #getEndColumnPages endColumnPages}.
7428
7562
  *
@@ -7433,7 +7567,7 @@ declare module "sap/f/FlexibleColumnLayout" {
7433
7567
  * The endColumnPage to remove or its index or id
7434
7568
  */
7435
7569
  vEndColumnPage: int | string | Control
7436
- ): Control;
7570
+ ): Control | null;
7437
7571
  /**
7438
7572
  * Removes a midColumnPage from the aggregation {@link #getMidColumnPages midColumnPages}.
7439
7573
  *
@@ -7444,7 +7578,7 @@ declare module "sap/f/FlexibleColumnLayout" {
7444
7578
  * The midColumnPage to remove or its index or id
7445
7579
  */
7446
7580
  vMidColumnPage: int | string | Control
7447
- ): Control;
7581
+ ): Control | null;
7448
7582
  /**
7449
7583
  * @SINCE 1.76
7450
7584
  *
@@ -8765,6 +8899,9 @@ declare module "sap/f/GridContainer" {
8765
8899
  * drag and drop. The difference is that the `{@link sap.f.dnd.GridDropInfo}` will provide a drop indicator,
8766
8900
  * which mimics the size of the dragged item and shows the potential drop position inside the grid.
8767
8901
  *
8902
+ * Drag and drop is enabled via keyboard using `Ctrl` + arrow keys (Windows) and `Control` + arrow keys
8903
+ * (Mac OS).
8904
+ *
8768
8905
  * Keyboard Navigation:: `GridContainer` provides support for two-dimensional keyboard navigation through
8769
8906
  * its contained controls. Navigating up/down or left/right using the arrow keys follows the configurable
8770
8907
  * two-dimensional grid mesh. This provides stable navigation paths in the cases when there are items of
@@ -10652,7 +10789,7 @@ declare module "sap/f/GridListItem" {
10652
10789
  * The content to remove or its index or id
10653
10790
  */
10654
10791
  vContent: int | string | Control
10655
- ): Control;
10792
+ ): Control | null;
10656
10793
  /**
10657
10794
  * Unbinds aggregation {@link #getContent content} from model data.
10658
10795
  *
@@ -11129,7 +11266,7 @@ declare module "sap/f/ProductSwitch" {
11129
11266
  * The item to remove or its index or id
11130
11267
  */
11131
11268
  vItem: int | string | ProductSwitchItem
11132
- ): ProductSwitchItem;
11269
+ ): ProductSwitchItem | null;
11133
11270
  /**
11134
11271
  * Sets the `selectedItem` association.
11135
11272
  *
@@ -11278,6 +11415,9 @@ declare module "sap/f/ProductSwitchItem" {
11278
11415
  *
11279
11416
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
11280
11417
  *
11418
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
11419
+ * change} event of `sap.f.ProductSwitch`.
11420
+ *
11281
11421
  * @returns Value of property `targetSrc`
11282
11422
  */
11283
11423
  getTargetSrc(): URI;
@@ -11343,6 +11483,9 @@ declare module "sap/f/ProductSwitchItem" {
11343
11483
  *
11344
11484
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
11345
11485
  *
11486
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
11487
+ * change} event of `sap.f.ProductSwitch`.
11488
+ *
11346
11489
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
11347
11490
  *
11348
11491
  * @returns Reference to `this` in order to allow method chaining
@@ -11389,6 +11532,9 @@ declare module "sap/f/ProductSwitchItem" {
11389
11532
 
11390
11533
  /**
11391
11534
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
11535
+ *
11536
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
11537
+ * change} event of `sap.f.ProductSwitch`.
11392
11538
  */
11393
11539
  targetSrc?: URI | PropertyBindingInfo | `{${string}}`;
11394
11540
 
@@ -12472,7 +12618,7 @@ declare module "sap/f/SearchManager" {
12472
12618
  * The suggestionItem to remove or its index or id
12473
12619
  */
12474
12620
  vSuggestionItem: int | string | SuggestionItem
12475
- ): SuggestionItem;
12621
+ ): SuggestionItem | null;
12476
12622
  /**
12477
12623
  * Sets a new value for property {@link #getEnabled enabled}.
12478
12624
  *
@@ -15663,7 +15809,7 @@ declare module "sap/f/semantic/SemanticPage" {
15663
15809
  * The customShareAction to remove or its index or id
15664
15810
  */
15665
15811
  vCustomShareAction: int | string | Button
15666
- ): Button;
15812
+ ): Button | null;
15667
15813
  /**
15668
15814
  * Removes a footerCustomAction from the aggregation {@link #getFooterCustomActions footerCustomActions}.
15669
15815
  *
@@ -15674,7 +15820,7 @@ declare module "sap/f/semantic/SemanticPage" {
15674
15820
  * The footerCustomAction to remove or its index or id
15675
15821
  */
15676
15822
  vFooterCustomAction: int | string | Button
15677
- ): Button;
15823
+ ): Button | null;
15678
15824
  /**
15679
15825
  * Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
15680
15826
  *
@@ -15685,7 +15831,7 @@ declare module "sap/f/semantic/SemanticPage" {
15685
15831
  * The headerContent to remove or its index or id
15686
15832
  */
15687
15833
  vHeaderContent: int | string | Control
15688
- ): Control;
15834
+ ): Control | null;
15689
15835
  /**
15690
15836
  * @SINCE 1.52
15691
15837
  *
@@ -15698,7 +15844,7 @@ declare module "sap/f/semantic/SemanticPage" {
15698
15844
  * The titleContent to remove or its index or id
15699
15845
  */
15700
15846
  vTitleContent: int | string | Control
15701
- ): Control;
15847
+ ): Control | null;
15702
15848
  /**
15703
15849
  * Removes a titleCustomIconAction from the aggregation {@link #getTitleCustomIconActions titleCustomIconActions}.
15704
15850
  *
@@ -15709,7 +15855,7 @@ declare module "sap/f/semantic/SemanticPage" {
15709
15855
  * The titleCustomIconAction to remove or its index or id
15710
15856
  */
15711
15857
  vTitleCustomIconAction: int | string | OverflowToolbarButton
15712
- ): OverflowToolbarButton;
15858
+ ): OverflowToolbarButton | null;
15713
15859
  /**
15714
15860
  * Removes a titleCustomTextAction from the aggregation {@link #getTitleCustomTextActions titleCustomTextActions}.
15715
15861
  *
@@ -15720,7 +15866,7 @@ declare module "sap/f/semantic/SemanticPage" {
15720
15866
  * The titleCustomTextAction to remove or its index or id
15721
15867
  */
15722
15868
  vTitleCustomTextAction: int | string | Button
15723
- ): Button;
15869
+ ): Button | null;
15724
15870
  /**
15725
15871
  * Removes a titleExpandedContent from the aggregation {@link #getTitleExpandedContent titleExpandedContent}.
15726
15872
  *
@@ -15731,7 +15877,7 @@ declare module "sap/f/semantic/SemanticPage" {
15731
15877
  * The titleExpandedContent to remove or its index or id
15732
15878
  */
15733
15879
  vTitleExpandedContent: int | string | Control
15734
- ): Control;
15880
+ ): Control | null;
15735
15881
  /**
15736
15882
  * Removes a titleSnappedContent from the aggregation {@link #getTitleSnappedContent titleSnappedContent}.
15737
15883
  *
@@ -15742,7 +15888,7 @@ declare module "sap/f/semantic/SemanticPage" {
15742
15888
  * The titleSnappedContent to remove or its index or id
15743
15889
  */
15744
15890
  vTitleSnappedContent: int | string | Control
15745
- ): Control;
15891
+ ): Control | null;
15746
15892
  /**
15747
15893
  * Sets the aggregated {@link #getAddAction addAction}.
15748
15894
  *
@@ -18215,7 +18361,7 @@ declare module "sap/f/ShellBar" {
18215
18361
  * The additionalContent to remove or its index or id
18216
18362
  */
18217
18363
  vAdditionalContent: int | string | IShellBar
18218
- ): IShellBar;
18364
+ ): IShellBar | null;
18219
18365
  /**
18220
18366
  * Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
18221
18367
  *