@openui5/ts-types 1.102.1 → 1.103.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types",
3
- "version": "1.102.1",
3
+ "version": "1.103.1",
4
4
  "description": "OpenUI5 TypeScript Definitions",
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.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -514,6 +514,20 @@ declare namespace sap {
514
514
  */
515
515
  oListener?: object
516
516
  ): this;
517
+ /**
518
+ * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
519
+ * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
520
+ */
521
+ enhanceAccessibilityState(
522
+ /**
523
+ * The Control that gets rendered by the RenderManager
524
+ */
525
+ oElement: sap.ui.core.Control,
526
+ /**
527
+ * The mapping of "aria-" prefixed attributes
528
+ */
529
+ mAriaProps: object
530
+ ): void;
517
531
  /**
518
532
  * Fires event {@link #event:press press} to attached listeners.
519
533
  *
@@ -969,6 +983,20 @@ declare namespace sap {
969
983
  */
970
984
  oListener?: object
971
985
  ): this;
986
+ /**
987
+ * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
988
+ * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
989
+ */
990
+ enhanceAccessibilityState(
991
+ /**
992
+ * The Control that gets rendered by the RenderManager
993
+ */
994
+ oElement: sap.ui.core.Control,
995
+ /**
996
+ * The mapping of "aria-" prefixed attributes
997
+ */
998
+ mAriaProps: object
999
+ ): void;
972
1000
  /**
973
1001
  * Fires event {@link #event:press press} to attached listeners.
974
1002
  *
@@ -1163,7 +1191,7 @@ declare namespace sap {
1163
1191
  * The sideIndicator to remove or its index or id
1164
1192
  */
1165
1193
  vSideIndicator: int | string | sap.f.cards.NumericSideIndicator
1166
- ): sap.f.cards.NumericSideIndicator;
1194
+ ): sap.f.cards.NumericSideIndicator | null;
1167
1195
  /**
1168
1196
  * Sets a new value for property {@link #getDetails details}.
1169
1197
  *
@@ -5802,7 +5830,7 @@ declare namespace sap {
5802
5830
  * The customShareAction to remove or its index or id
5803
5831
  */
5804
5832
  vCustomShareAction: int | string | sap.m.Button
5805
- ): sap.m.Button;
5833
+ ): sap.m.Button | null;
5806
5834
  /**
5807
5835
  * Removes a footerCustomAction from the aggregation {@link #getFooterCustomActions footerCustomActions}.
5808
5836
  *
@@ -5813,7 +5841,7 @@ declare namespace sap {
5813
5841
  * The footerCustomAction to remove or its index or id
5814
5842
  */
5815
5843
  vFooterCustomAction: int | string | sap.m.Button
5816
- ): sap.m.Button;
5844
+ ): sap.m.Button | null;
5817
5845
  /**
5818
5846
  * Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
5819
5847
  *
@@ -5824,7 +5852,7 @@ declare namespace sap {
5824
5852
  * The headerContent to remove or its index or id
5825
5853
  */
5826
5854
  vHeaderContent: int | string | sap.ui.core.Control
5827
- ): sap.ui.core.Control;
5855
+ ): sap.ui.core.Control | null;
5828
5856
  /**
5829
5857
  * @SINCE 1.52
5830
5858
  *
@@ -5837,7 +5865,7 @@ declare namespace sap {
5837
5865
  * The titleContent to remove or its index or id
5838
5866
  */
5839
5867
  vTitleContent: int | string | sap.ui.core.Control
5840
- ): sap.ui.core.Control;
5868
+ ): sap.ui.core.Control | null;
5841
5869
  /**
5842
5870
  * Removes a titleCustomIconAction from the aggregation {@link #getTitleCustomIconActions titleCustomIconActions}.
5843
5871
  *
@@ -5848,7 +5876,7 @@ declare namespace sap {
5848
5876
  * The titleCustomIconAction to remove or its index or id
5849
5877
  */
5850
5878
  vTitleCustomIconAction: int | string | sap.m.OverflowToolbarButton
5851
- ): sap.m.OverflowToolbarButton;
5879
+ ): sap.m.OverflowToolbarButton | null;
5852
5880
  /**
5853
5881
  * Removes a titleCustomTextAction from the aggregation {@link #getTitleCustomTextActions titleCustomTextActions}.
5854
5882
  *
@@ -5859,7 +5887,7 @@ declare namespace sap {
5859
5887
  * The titleCustomTextAction to remove or its index or id
5860
5888
  */
5861
5889
  vTitleCustomTextAction: int | string | sap.m.Button
5862
- ): sap.m.Button;
5890
+ ): sap.m.Button | null;
5863
5891
  /**
5864
5892
  * Removes a titleExpandedContent from the aggregation {@link #getTitleExpandedContent titleExpandedContent}.
5865
5893
  *
@@ -5870,7 +5898,7 @@ declare namespace sap {
5870
5898
  * The titleExpandedContent to remove or its index or id
5871
5899
  */
5872
5900
  vTitleExpandedContent: int | string | sap.ui.core.Control
5873
- ): sap.ui.core.Control;
5901
+ ): sap.ui.core.Control | null;
5874
5902
  /**
5875
5903
  * Removes a titleSnappedContent from the aggregation {@link #getTitleSnappedContent titleSnappedContent}.
5876
5904
  *
@@ -5881,7 +5909,7 @@ declare namespace sap {
5881
5909
  * The titleSnappedContent to remove or its index or id
5882
5910
  */
5883
5911
  vTitleSnappedContent: int | string | sap.ui.core.Control
5884
- ): sap.ui.core.Control;
5912
+ ): sap.ui.core.Control | null;
5885
5913
  /**
5886
5914
  * Sets the aggregated {@link #getAddAction addAction}.
5887
5915
  *
@@ -6852,6 +6880,32 @@ declare namespace sap {
6852
6880
  | sap.ui.base.ManagedObject.PropertyBindingInfo
6853
6881
  | `{${string}}`;
6854
6882
 
6883
+ /**
6884
+ * @SINCE 1.103
6885
+ *
6886
+ * Specifies a custom display size for each avatar.
6887
+ *
6888
+ * **Notes:**
6889
+ * - Supports only `px` and code>rem values.
6890
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
6891
+ */
6892
+ avatarCustomDisplaySize?:
6893
+ | sap.ui.core.AbsoluteCSSSize
6894
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6895
+ | `{${string}}`;
6896
+
6897
+ /**
6898
+ * @SINCE 1.103
6899
+ *
6900
+ * Specifies a custom font size for each avatar.
6901
+ *
6902
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
6903
+ */
6904
+ avatarCustomFontSize?:
6905
+ | sap.ui.core.AbsoluteCSSSize
6906
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
6907
+ | `{${string}}`;
6908
+
6855
6909
  /**
6856
6910
  * The `AvatarGroupItems` contained by the control.
6857
6911
  */
@@ -7951,6 +8005,9 @@ declare namespace sap {
7951
8005
 
7952
8006
  /**
7953
8007
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
8008
+ *
8009
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
8010
+ * change} event of `sap.f.ProductSwitch`.
7954
8011
  */
7955
8012
  targetSrc?:
7956
8013
  | sap.ui.core.URI
@@ -8503,6 +8560,36 @@ declare namespace sap {
8503
8560
  avatarsDisplayed?: int;
8504
8561
  }
8505
8562
  ): this;
8563
+ /**
8564
+ * @SINCE 1.103
8565
+ *
8566
+ * Gets current value of property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
8567
+ *
8568
+ * Specifies a custom display size for each avatar.
8569
+ *
8570
+ * **Notes:**
8571
+ * - Supports only `px` and code>rem values.
8572
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
8573
+ *
8574
+ * Default value is `"3rem"`.
8575
+ *
8576
+ * @returns Value of property `avatarCustomDisplaySize`
8577
+ */
8578
+ getAvatarCustomDisplaySize(): sap.ui.core.AbsoluteCSSSize;
8579
+ /**
8580
+ * @SINCE 1.103
8581
+ *
8582
+ * Gets current value of property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
8583
+ *
8584
+ * Specifies a custom font size for each avatar.
8585
+ *
8586
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
8587
+ *
8588
+ * Default value is `"1.125rem"`.
8589
+ *
8590
+ * @returns Value of property `avatarCustomFontSize`
8591
+ */
8592
+ getAvatarCustomFontSize(): sap.ui.core.AbsoluteCSSSize;
8506
8593
  /**
8507
8594
  * Gets current value of property {@link #getAvatarDisplaySize avatarDisplaySize}.
8508
8595
  *
@@ -8576,7 +8663,51 @@ declare namespace sap {
8576
8663
  * The item to remove or its index or id
8577
8664
  */
8578
8665
  vItem: int | string | sap.f.AvatarGroupItem
8579
- ): sap.f.AvatarGroupItem;
8666
+ ): sap.f.AvatarGroupItem | null;
8667
+ /**
8668
+ * @SINCE 1.103
8669
+ *
8670
+ * Sets a new value for property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
8671
+ *
8672
+ * Specifies a custom display size for each avatar.
8673
+ *
8674
+ * **Notes:**
8675
+ * - Supports only `px` and code>rem values.
8676
+ * - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
8677
+ *
8678
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8679
+ *
8680
+ * Default value is `"3rem"`.
8681
+ *
8682
+ * @returns Reference to `this` in order to allow method chaining
8683
+ */
8684
+ setAvatarCustomDisplaySize(
8685
+ /**
8686
+ * New value for property `avatarCustomDisplaySize`
8687
+ */
8688
+ sAvatarCustomDisplaySize?: sap.ui.core.AbsoluteCSSSize
8689
+ ): this;
8690
+ /**
8691
+ * @SINCE 1.103
8692
+ *
8693
+ * Sets a new value for property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
8694
+ *
8695
+ * Specifies a custom font size for each avatar.
8696
+ *
8697
+ * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
8698
+ *
8699
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8700
+ *
8701
+ * Default value is `"1.125rem"`.
8702
+ *
8703
+ * @returns Reference to `this` in order to allow method chaining
8704
+ */
8705
+ setAvatarCustomFontSize(
8706
+ /**
8707
+ * New value for property `avatarCustomFontSize`
8708
+ */
8709
+ sAvatarCustomFontSize?: sap.ui.core.AbsoluteCSSSize
8710
+ ): this;
8580
8711
  /**
8581
8712
  * Sets a new value for property {@link #getAvatarDisplaySize avatarDisplaySize}.
8582
8713
  *
@@ -10250,7 +10381,7 @@ declare namespace sap {
10250
10381
  * The content to remove or its index or id
10251
10382
  */
10252
10383
  vContent: int | string | sap.ui.core.Control
10253
- ): sap.ui.core.Control;
10384
+ ): sap.ui.core.Control | null;
10254
10385
  /**
10255
10386
  * @SINCE 1.58
10256
10387
  *
@@ -10977,7 +11108,7 @@ declare namespace sap {
10977
11108
  * The action to remove or its index or id
10978
11109
  */
10979
11110
  vAction: int | string | sap.ui.core.Control
10980
- ): sap.ui.core.Control;
11111
+ ): sap.ui.core.Control | null;
10981
11112
  /**
10982
11113
  * Removes all the controls from the aggregation {@link #getActions actions}.
10983
11114
  *
@@ -11055,7 +11186,7 @@ declare namespace sap {
11055
11186
  * The content to remove or its index or id
11056
11187
  */
11057
11188
  vContent: int | string | sap.ui.core.Control
11058
- ): sap.ui.core.Control;
11189
+ ): sap.ui.core.Control | null;
11059
11190
  /**
11060
11191
  * Removes a expandedContent from the aggregation {@link #getExpandedContent expandedContent}.
11061
11192
  *
@@ -11066,7 +11197,7 @@ declare namespace sap {
11066
11197
  * The expandedContent to remove or its index or id
11067
11198
  */
11068
11199
  vExpandedContent: int | string | sap.ui.core.Control
11069
- ): sap.ui.core.Control;
11200
+ ): sap.ui.core.Control | null;
11070
11201
  /**
11071
11202
  * @SINCE 1.52
11072
11203
  *
@@ -11079,7 +11210,7 @@ declare namespace sap {
11079
11210
  * The navigationAction to remove or its index or id
11080
11211
  */
11081
11212
  vNavigationAction: int | string | sap.m.Button
11082
- ): sap.m.Button;
11213
+ ): sap.m.Button | null;
11083
11214
  /**
11084
11215
  * Removes a snappedContent from the aggregation {@link #getSnappedContent snappedContent}.
11085
11216
  *
@@ -11090,7 +11221,7 @@ declare namespace sap {
11090
11221
  * The snappedContent to remove or its index or id
11091
11222
  */
11092
11223
  vSnappedContent: int | string | sap.ui.core.Control
11093
- ): sap.ui.core.Control;
11224
+ ): sap.ui.core.Control | null;
11094
11225
  /**
11095
11226
  * @SINCE 1.54
11096
11227
  *
@@ -12779,7 +12910,7 @@ declare namespace sap {
12779
12910
  * The beginColumnPage to remove or its index or id
12780
12911
  */
12781
12912
  vBeginColumnPage: int | string | sap.ui.core.Control
12782
- ): sap.ui.core.Control;
12913
+ ): sap.ui.core.Control | null;
12783
12914
  /**
12784
12915
  * Removes a endColumnPage from the aggregation {@link #getEndColumnPages endColumnPages}.
12785
12916
  *
@@ -12790,7 +12921,7 @@ declare namespace sap {
12790
12921
  * The endColumnPage to remove or its index or id
12791
12922
  */
12792
12923
  vEndColumnPage: int | string | sap.ui.core.Control
12793
- ): sap.ui.core.Control;
12924
+ ): sap.ui.core.Control | null;
12794
12925
  /**
12795
12926
  * Removes a midColumnPage from the aggregation {@link #getMidColumnPages midColumnPages}.
12796
12927
  *
@@ -12801,7 +12932,7 @@ declare namespace sap {
12801
12932
  * The midColumnPage to remove or its index or id
12802
12933
  */
12803
12934
  vMidColumnPage: int | string | sap.ui.core.Control
12804
- ): sap.ui.core.Control;
12935
+ ): sap.ui.core.Control | null;
12805
12936
  /**
12806
12937
  * @SINCE 1.76
12807
12938
  *
@@ -13721,6 +13852,9 @@ declare namespace sap {
13721
13852
  * drag and drop. The difference is that the `{@link sap.f.dnd.GridDropInfo}` will provide a drop indicator,
13722
13853
  * which mimics the size of the dragged item and shows the potential drop position inside the grid.
13723
13854
  *
13855
+ * Drag and drop is enabled via keyboard using `Ctrl` + arrow keys (Windows) and `Control` + arrow keys
13856
+ * (Mac OS).
13857
+ *
13724
13858
  * Keyboard Navigation:: `GridContainer` provides support for two-dimensional keyboard navigation through
13725
13859
  * its contained controls. Navigating up/down or left/right using the arrow keys follows the configurable
13726
13860
  * two-dimensional grid mesh. This provides stable navigation paths in the cases when there are items of
@@ -15366,7 +15500,7 @@ declare namespace sap {
15366
15500
  * The content to remove or its index or id
15367
15501
  */
15368
15502
  vContent: int | string | sap.ui.core.Control
15369
- ): sap.ui.core.Control;
15503
+ ): sap.ui.core.Control | null;
15370
15504
  /**
15371
15505
  * Unbinds aggregation {@link #getContent content} from model data.
15372
15506
  *
@@ -15770,7 +15904,7 @@ declare namespace sap {
15770
15904
  * The item to remove or its index or id
15771
15905
  */
15772
15906
  vItem: int | string | sap.f.ProductSwitchItem
15773
- ): sap.f.ProductSwitchItem;
15907
+ ): sap.f.ProductSwitchItem | null;
15774
15908
  /**
15775
15909
  * Sets the `selectedItem` association.
15776
15910
  *
@@ -15887,6 +16021,9 @@ declare namespace sap {
15887
16021
  *
15888
16022
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
15889
16023
  *
16024
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
16025
+ * change} event of `sap.f.ProductSwitch`.
16026
+ *
15890
16027
  * @returns Value of property `targetSrc`
15891
16028
  */
15892
16029
  getTargetSrc(): sap.ui.core.URI;
@@ -15952,6 +16089,9 @@ declare namespace sap {
15952
16089
  *
15953
16090
  * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
15954
16091
  *
16092
+ * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
16093
+ * change} event of `sap.f.ProductSwitch`.
16094
+ *
15955
16095
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
15956
16096
  *
15957
16097
  * @returns Reference to `this` in order to allow method chaining
@@ -16427,7 +16567,7 @@ declare namespace sap {
16427
16567
  * The suggestionItem to remove or its index or id
16428
16568
  */
16429
16569
  vSuggestionItem: int | string | sap.m.SuggestionItem
16430
- ): sap.m.SuggestionItem;
16570
+ ): sap.m.SuggestionItem | null;
16431
16571
  /**
16432
16572
  * Sets a new value for property {@link #getEnabled enabled}.
16433
16573
  *
@@ -17515,7 +17655,7 @@ declare namespace sap {
17515
17655
  * The additionalContent to remove or its index or id
17516
17656
  */
17517
17657
  vAdditionalContent: int | string | sap.f.IShellBar
17518
- ): sap.f.IShellBar;
17658
+ ): sap.f.IShellBar | null;
17519
17659
  /**
17520
17660
  * Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
17521
17661
  *