@openui5/ts-types-esm 1.102.2 → 1.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types-esm",
-  "version": "1.102.2",
+  "version": "1.104.0",
   "description": "OpenUI5 TypeScript Definitions - ES Modules",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.102.2
+// For Library Version: 1.104.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -511,6 +511,8 @@ declare module "sap/f/AvatarGroup" {
 
   import Event from "sap/ui/base/Event";
 
+  import { AbsoluteCSSSize } from "sap/ui/core/library";
+
   import AvatarSize from "sap/m/AvatarSize";
 
   import { AvatarGroupType } from "sap/f/library";
@@ -720,6 +722,36 @@ declare module "sap/f/AvatarGroup" {
         avatarsDisplayed?: int;
       }
     ): this;
+    /**
+     * @SINCE 1.103
+     *
+     * Gets current value of property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
+     *
+     * Specifies a custom display size for each avatar.
+     *
+     * **Notes:**
+     * 	 - Supports only `px` and code>rem values.
+     * 	 - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     *
+     * Default value is `"3rem"`.
+     *
+     * @returns Value of property `avatarCustomDisplaySize`
+     */
+    getAvatarCustomDisplaySize(): AbsoluteCSSSize;
+    /**
+     * @SINCE 1.103
+     *
+     * Gets current value of property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
+     *
+     * Specifies a custom font size for each avatar.
+     *
+     * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     *
+     * Default value is `"1.125rem"`.
+     *
+     * @returns Value of property `avatarCustomFontSize`
+     */
+    getAvatarCustomFontSize(): AbsoluteCSSSize;
     /**
      * Gets current value of property {@link #getAvatarDisplaySize avatarDisplaySize}.
      *
@@ -793,7 +825,51 @@ declare module "sap/f/AvatarGroup" {
        * The item to remove or its index or id
        */
       vItem: int | string | AvatarGroupItem
-    ): AvatarGroupItem;
+    ): AvatarGroupItem | null;
+    /**
+     * @SINCE 1.103
+     *
+     * Sets a new value for property {@link #getAvatarCustomDisplaySize avatarCustomDisplaySize}.
+     *
+     * Specifies a custom display size for each avatar.
+     *
+     * **Notes:**
+     * 	 - Supports only `px` and code>rem values.
+     * 	 - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"3rem"`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setAvatarCustomDisplaySize(
+      /**
+       * New value for property `avatarCustomDisplaySize`
+       */
+      sAvatarCustomDisplaySize?: AbsoluteCSSSize
+    ): this;
+    /**
+     * @SINCE 1.103
+     *
+     * Sets a new value for property {@link #getAvatarCustomFontSize avatarCustomFontSize}.
+     *
+     * Specifies a custom font size for each avatar.
+     *
+     * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"1.125rem"`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setAvatarCustomFontSize(
+      /**
+       * New value for property `avatarCustomFontSize`
+       */
+      sAvatarCustomFontSize?: AbsoluteCSSSize
+    ): this;
     /**
      * Sets a new value for property {@link #getAvatarDisplaySize avatarDisplaySize}.
      *
@@ -847,6 +923,32 @@ declare module "sap/f/AvatarGroup" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * @SINCE 1.103
+     *
+     * Specifies a custom display size for each avatar.
+     *
+     * **Notes:**
+     * 	 - Supports only `px` and code>rem values.
+     * 	 - It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     */
+    avatarCustomDisplaySize?:
+      | AbsoluteCSSSize
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * @SINCE 1.103
+     *
+     * Specifies a custom font size for each avatar.
+     *
+     * **Note:** It takes effect only if the `avatarDisplaySize` property is set to `Custom`.
+     */
+    avatarCustomFontSize?:
+      | AbsoluteCSSSize
+      | PropertyBindingInfo
+      | `{${string}}`;
+
     /**
      * The `AvatarGroupItems` contained by the control.
      */
@@ -1612,6 +1714,8 @@ declare module "sap/f/cards/Header" {
 
   import Event from "sap/ui/base/Event";
 
+  import Control from "sap/ui/core/Control";
+
   import AvatarColor from "sap/m/AvatarColor";
 
   import AvatarShape from "sap/m/AvatarShape";
@@ -1757,6 +1861,20 @@ declare module "sap/f/cards/Header" {
        */
       oListener?: object
     ): this;
+    /**
+     * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
+     * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
+     */
+    enhanceAccessibilityState(
+      /**
+       * The Control that gets rendered by the RenderManager
+       */
+      oElement: Control,
+      /**
+       * The mapping of "aria-" prefixed attributes
+       */
+      mAriaProps: object
+    ): void;
     /**
      * Fires event {@link #event:press press} to attached listeners.
      *
@@ -2140,6 +2258,8 @@ declare module "sap/f/cards/NumericHeader" {
 
   import Event from "sap/ui/base/Event";
 
+  import Control from "sap/ui/core/Control";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { ValueColor, DeviationIndicator } from "sap/m/library";
@@ -2306,6 +2426,20 @@ declare module "sap/f/cards/NumericHeader" {
        */
       oListener?: object
     ): this;
+    /**
+     * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
+     * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
+     */
+    enhanceAccessibilityState(
+      /**
+       * The Control that gets rendered by the RenderManager
+       */
+      oElement: Control,
+      /**
+       * The mapping of "aria-" prefixed attributes
+       */
+      mAriaProps: object
+    ): void;
     /**
      * Fires event {@link #event:press press} to attached listeners.
      *
@@ -2502,7 +2636,7 @@ declare module "sap/f/cards/NumericHeader" {
        * The sideIndicator to remove or its index or id
        */
       vSideIndicator: int | string | NumericSideIndicator
-    ): NumericSideIndicator;
+    ): NumericSideIndicator | null;
     /**
      * Sets a new value for property {@link #getDetails details}.
      *
@@ -4612,7 +4746,7 @@ declare module "sap/f/DynamicPageHeader" {
        * The content to remove or its index or id
        */
       vContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * @SINCE 1.58
      *
@@ -5391,7 +5525,7 @@ declare module "sap/f/DynamicPageTitle" {
        * The action to remove or its index or id
        */
       vAction: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes all the controls from the aggregation {@link #getActions actions}.
      *
@@ -5469,7 +5603,7 @@ declare module "sap/f/DynamicPageTitle" {
        * The content to remove or its index or id
        */
       vContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes a expandedContent from the aggregation {@link #getExpandedContent expandedContent}.
      *
@@ -5480,7 +5614,7 @@ declare module "sap/f/DynamicPageTitle" {
        * The expandedContent to remove or its index or id
        */
       vExpandedContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * @SINCE 1.52
      *
@@ -5493,7 +5627,7 @@ declare module "sap/f/DynamicPageTitle" {
        * The navigationAction to remove or its index or id
        */
       vNavigationAction: int | string | Button
-    ): Button;
+    ): Button | null;
     /**
      * Removes a snappedContent from the aggregation {@link #getSnappedContent snappedContent}.
      *
@@ -5504,7 +5638,7 @@ declare module "sap/f/DynamicPageTitle" {
        * The snappedContent to remove or its index or id
        */
       vSnappedContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * @SINCE 1.54
      *
@@ -7422,7 +7556,7 @@ declare module "sap/f/FlexibleColumnLayout" {
        * The beginColumnPage to remove or its index or id
        */
       vBeginColumnPage: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes a endColumnPage from the aggregation {@link #getEndColumnPages endColumnPages}.
      *
@@ -7433,7 +7567,7 @@ declare module "sap/f/FlexibleColumnLayout" {
        * The endColumnPage to remove or its index or id
        */
       vEndColumnPage: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes a midColumnPage from the aggregation {@link #getMidColumnPages midColumnPages}.
      *
@@ -7444,7 +7578,7 @@ declare module "sap/f/FlexibleColumnLayout" {
        * The midColumnPage to remove or its index or id
        */
       vMidColumnPage: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * @SINCE 1.76
      *
@@ -8211,6 +8345,17 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * Gets current value of property {@link #getFirstColumnBackArrowLabel firstColumnBackArrowLabel}.
+     *
+     * Text that describes the landmark of the back arrow of the first column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * @returns Value of property `firstColumnBackArrowLabel`
+     */
+    getFirstColumnBackArrowLabel(): string;
     /**
      * Gets current value of property {@link #getFirstColumnLabel firstColumnLabel}.
      *
@@ -8222,6 +8367,17 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
      * @returns Value of property `firstColumnLabel`
      */
     getFirstColumnLabel(): string;
+    /**
+     * Gets current value of property {@link #getLastColumnForwardArrowLabel lastColumnForwardArrowLabel}.
+     *
+     * Text that describes the landmark of forward arrow of the last column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * @returns Value of property `lastColumnForwardArrowLabel`
+     */
+    getLastColumnForwardArrowLabel(): string;
     /**
      * Gets current value of property {@link #getLastColumnLabel lastColumnLabel}.
      *
@@ -8233,6 +8389,28 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
      * @returns Value of property `lastColumnLabel`
      */
     getLastColumnLabel(): string;
+    /**
+     * Gets current value of property {@link #getMiddleColumnBackArrowLabel middleColumnBackArrowLabel}.
+     *
+     * Text that describes the landmark of back arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * @returns Value of property `middleColumnBackArrowLabel`
+     */
+    getMiddleColumnBackArrowLabel(): string;
+    /**
+     * Gets current value of property {@link #getMiddleColumnForwardArrowLabel middleColumnForwardArrowLabel}.
+     *
+     * Text that describes the landmark of forward arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * @returns Value of property `middleColumnForwardArrowLabel`
+     */
+    getMiddleColumnForwardArrowLabel(): string;
     /**
      * Gets current value of property {@link #getMiddleColumnLabel middleColumnLabel}.
      *
@@ -8244,6 +8422,24 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
      * @returns Value of property `middleColumnLabel`
      */
     getMiddleColumnLabel(): string;
+    /**
+     * Sets a new value for property {@link #getFirstColumnBackArrowLabel firstColumnBackArrowLabel}.
+     *
+     * Text that describes the landmark of the back arrow of the first column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setFirstColumnBackArrowLabel(
+      /**
+       * New value for property `firstColumnBackArrowLabel`
+       */
+      sFirstColumnBackArrowLabel?: string
+    ): this;
     /**
      * Sets a new value for property {@link #getFirstColumnLabel firstColumnLabel}.
      *
@@ -8262,6 +8458,24 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
        */
       sFirstColumnLabel?: string
     ): this;
+    /**
+     * Sets a new value for property {@link #getLastColumnForwardArrowLabel lastColumnForwardArrowLabel}.
+     *
+     * Text that describes the landmark of forward arrow of the last column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setLastColumnForwardArrowLabel(
+      /**
+       * New value for property `lastColumnForwardArrowLabel`
+       */
+      sLastColumnForwardArrowLabel?: string
+    ): this;
     /**
      * Sets a new value for property {@link #getLastColumnLabel lastColumnLabel}.
      *
@@ -8280,6 +8494,42 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
        */
       sLastColumnLabel?: string
     ): this;
+    /**
+     * Sets a new value for property {@link #getMiddleColumnBackArrowLabel middleColumnBackArrowLabel}.
+     *
+     * Text that describes the landmark of back arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setMiddleColumnBackArrowLabel(
+      /**
+       * New value for property `middleColumnBackArrowLabel`
+       */
+      sMiddleColumnBackArrowLabel?: string
+    ): this;
+    /**
+     * Sets a new value for property {@link #getMiddleColumnForwardArrowLabel middleColumnForwardArrowLabel}.
+     *
+     * Text that describes the landmark of forward arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setMiddleColumnForwardArrowLabel(
+      /**
+       * New value for property `middleColumnForwardArrowLabel`
+       */
+      sMiddleColumnForwardArrowLabel?: string
+    ): this;
     /**
      * Sets a new value for property {@link #getMiddleColumnLabel middleColumnLabel}.
      *
@@ -8325,6 +8575,38 @@ declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
      * If not set, a predefined text is used.
      */
     lastColumnLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of the back arrow of the first column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    firstColumnBackArrowLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of forward arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    middleColumnForwardArrowLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of back arrow of the middle column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    middleColumnBackArrowLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of forward arrow of the last column in the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    lastColumnForwardArrowLabel?: string | PropertyBindingInfo;
   }
 }
 
@@ -8765,6 +9047,9 @@ declare module "sap/f/GridContainer" {
    * drag and drop. The difference is that the `{@link sap.f.dnd.GridDropInfo}` will provide a drop indicator,
    * which mimics the size of the dragged item and shows the potential drop position inside the grid.
    *
+   * Drag and drop is enabled via keyboard using `Ctrl` + arrow keys (Windows) and `Control` + arrow keys
+   * (Mac OS).
+   *
    * Keyboard Navigation:: `GridContainer` provides support for two-dimensional keyboard navigation through
    * its contained controls. Navigating up/down or left/right using the arrow keys follows the configurable
    * two-dimensional grid mesh. This provides stable navigation paths in the cases when there are items of
@@ -10652,7 +10937,7 @@ declare module "sap/f/GridListItem" {
        * The content to remove or its index or id
        */
       vContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Unbinds aggregation {@link #getContent content} from model data.
      *
@@ -11129,7 +11414,7 @@ declare module "sap/f/ProductSwitch" {
        * The item to remove or its index or id
        */
       vItem: int | string | ProductSwitchItem
-    ): ProductSwitchItem;
+    ): ProductSwitchItem | null;
     /**
      * Sets the `selectedItem` association.
      *
@@ -11278,6 +11563,9 @@ declare module "sap/f/ProductSwitchItem" {
      *
      * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
      *
+     * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
+     * change} event of `sap.f.ProductSwitch`.
+     *
      * @returns Value of property `targetSrc`
      */
     getTargetSrc(): URI;
@@ -11343,6 +11631,9 @@ declare module "sap/f/ProductSwitchItem" {
      *
      * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
      *
+     * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
+     * change} event of `sap.f.ProductSwitch`.
+     *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -11389,6 +11680,9 @@ declare module "sap/f/ProductSwitchItem" {
 
     /**
      * Defines the `ProductSwitchItem` target URI. Supports standard hyperlink behavior.
+     *
+     * **Note:** Redirection is handled via application logic, by subscribing to the {@link sap.f.ProductSwitch#event:change
+     * change} event of `sap.f.ProductSwitch`.
      */
     targetSrc?: URI | PropertyBindingInfo | `{${string}}`;
 
@@ -12472,7 +12766,7 @@ declare module "sap/f/SearchManager" {
        * The suggestionItem to remove or its index or id
        */
       vSuggestionItem: int | string | SuggestionItem
-    ): SuggestionItem;
+    ): SuggestionItem | null;
     /**
      * Sets a new value for property {@link #getEnabled enabled}.
      *
@@ -15663,7 +15957,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The customShareAction to remove or its index or id
        */
       vCustomShareAction: int | string | Button
-    ): Button;
+    ): Button | null;
     /**
      * Removes a footerCustomAction from the aggregation {@link #getFooterCustomActions footerCustomActions}.
      *
@@ -15674,7 +15968,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The footerCustomAction to remove or its index or id
        */
       vFooterCustomAction: int | string | Button
-    ): Button;
+    ): Button | null;
     /**
      * Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
      *
@@ -15685,7 +15979,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The headerContent to remove or its index or id
        */
       vHeaderContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * @SINCE 1.52
      *
@@ -15698,7 +15992,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The titleContent to remove or its index or id
        */
       vTitleContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes a titleCustomIconAction from the aggregation {@link #getTitleCustomIconActions titleCustomIconActions}.
      *
@@ -15709,7 +16003,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The titleCustomIconAction to remove or its index or id
        */
       vTitleCustomIconAction: int | string | OverflowToolbarButton
-    ): OverflowToolbarButton;
+    ): OverflowToolbarButton | null;
     /**
      * Removes a titleCustomTextAction from the aggregation {@link #getTitleCustomTextActions titleCustomTextActions}.
      *
@@ -15720,7 +16014,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The titleCustomTextAction to remove or its index or id
        */
       vTitleCustomTextAction: int | string | Button
-    ): Button;
+    ): Button | null;
     /**
      * Removes a titleExpandedContent from the aggregation {@link #getTitleExpandedContent titleExpandedContent}.
      *
@@ -15731,7 +16025,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The titleExpandedContent to remove or its index or id
        */
       vTitleExpandedContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Removes a titleSnappedContent from the aggregation {@link #getTitleSnappedContent titleSnappedContent}.
      *
@@ -15742,7 +16036,7 @@ declare module "sap/f/semantic/SemanticPage" {
        * The titleSnappedContent to remove or its index or id
        */
       vTitleSnappedContent: int | string | Control
-    ): Control;
+    ): Control | null;
     /**
      * Sets the aggregated {@link #getAddAction addAction}.
      *
@@ -18215,7 +18509,7 @@ declare module "sap/f/ShellBar" {
        * The additionalContent to remove or its index or id
        */
       vAdditionalContent: int | string | IShellBar
-    ): IShellBar;
+    ): IShellBar | null;
     /**
      * Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
      *