@openui5/ts-types 1.102.2 → 1.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.102.2",
+  "version": "1.104.0",
   "description": "OpenUI5 TypeScript Definitions",
   "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 namespace sap {
   /**
@@ -514,6 +514,20 @@ declare namespace sap {
            */
           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: sap.ui.core.Control,
+          /**
+           * The mapping of "aria-" prefixed attributes
+           */
+          mAriaProps: object
+        ): void;
         /**
          * Fires event {@link #event:press press} to attached listeners.
          *
@@ -969,6 +983,20 @@ declare namespace sap {
            */
           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: sap.ui.core.Control,
+          /**
+           * The mapping of "aria-" prefixed attributes
+           */
+          mAriaProps: object
+        ): void;
         /**
          * Fires event {@link #event:press press} to attached listeners.
          *
@@ -1163,7 +1191,7 @@ declare namespace sap {
            * The sideIndicator to remove or its index or id
            */
           vSideIndicator: int | string | sap.f.cards.NumericSideIndicator
-        ): sap.f.cards.NumericSideIndicator;
+        ): sap.f.cards.NumericSideIndicator | null;
         /**
          * Sets a new value for property {@link #getDetails details}.
          *
@@ -5802,7 +5830,7 @@ declare namespace sap {
            * The customShareAction to remove or its index or id
            */
           vCustomShareAction: int | string | sap.m.Button
-        ): sap.m.Button;
+        ): sap.m.Button | null;
         /**
          * Removes a footerCustomAction from the aggregation {@link #getFooterCustomActions footerCustomActions}.
          *
@@ -5813,7 +5841,7 @@ declare namespace sap {
            * The footerCustomAction to remove or its index or id
            */
           vFooterCustomAction: int | string | sap.m.Button
-        ): sap.m.Button;
+        ): sap.m.Button | null;
         /**
          * Removes a headerContent from the aggregation {@link #getHeaderContent headerContent}.
          *
@@ -5824,7 +5852,7 @@ declare namespace sap {
            * The headerContent to remove or its index or id
            */
           vHeaderContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * @SINCE 1.52
          *
@@ -5837,7 +5865,7 @@ declare namespace sap {
            * The titleContent to remove or its index or id
            */
           vTitleContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Removes a titleCustomIconAction from the aggregation {@link #getTitleCustomIconActions titleCustomIconActions}.
          *
@@ -5848,7 +5876,7 @@ declare namespace sap {
            * The titleCustomIconAction to remove or its index or id
            */
           vTitleCustomIconAction: int | string | sap.m.OverflowToolbarButton
-        ): sap.m.OverflowToolbarButton;
+        ): sap.m.OverflowToolbarButton | null;
         /**
          * Removes a titleCustomTextAction from the aggregation {@link #getTitleCustomTextActions titleCustomTextActions}.
          *
@@ -5859,7 +5887,7 @@ declare namespace sap {
            * The titleCustomTextAction to remove or its index or id
            */
           vTitleCustomTextAction: int | string | sap.m.Button
-        ): sap.m.Button;
+        ): sap.m.Button | null;
         /**
          * Removes a titleExpandedContent from the aggregation {@link #getTitleExpandedContent titleExpandedContent}.
          *
@@ -5870,7 +5898,7 @@ declare namespace sap {
            * The titleExpandedContent to remove or its index or id
            */
           vTitleExpandedContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Removes a titleSnappedContent from the aggregation {@link #getTitleSnappedContent titleSnappedContent}.
          *
@@ -5881,7 +5909,7 @@ declare namespace sap {
            * The titleSnappedContent to remove or its index or id
            */
           vTitleSnappedContent: int | string | sap.ui.core.Control
-        ): sap.ui.core.Control;
+        ): sap.ui.core.Control | null;
         /**
          * Sets the aggregated {@link #getAddAction addAction}.
          *
@@ -6852,6 +6880,32 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.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?:
+        | sap.ui.core.AbsoluteCSSSize
+        | sap.ui.base.ManagedObject.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?:
+        | sap.ui.core.AbsoluteCSSSize
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * The `AvatarGroupItems` contained by the control.
        */
@@ -7651,6 +7705,46 @@ declare namespace sap {
        * If not set, a predefined text is used.
        */
       lastColumnLabel?: string | sap.ui.base.ManagedObject.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
+        | sap.ui.base.ManagedObject.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
+        | sap.ui.base.ManagedObject.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
+        | sap.ui.base.ManagedObject.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
+        | sap.ui.base.ManagedObject.PropertyBindingInfo;
     }
 
     interface $GridContainerSettings extends sap.ui.core.$ControlSettings {
@@ -7951,6 +8045,9 @@ declare namespace sap {
 
       /**
        * 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?:
         | sap.ui.core.URI
@@ -8503,6 +8600,36 @@ declare namespace sap {
           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(): sap.ui.core.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(): sap.ui.core.AbsoluteCSSSize;
       /**
        * Gets current value of property {@link #getAvatarDisplaySize avatarDisplaySize}.
        *
@@ -8576,7 +8703,51 @@ declare namespace sap {
          * The item to remove or its index or id
          */
         vItem: int | string | sap.f.AvatarGroupItem
-      ): sap.f.AvatarGroupItem;
+      ): sap.f.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?: sap.ui.core.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?: sap.ui.core.AbsoluteCSSSize
+      ): this;
       /**
        * Sets a new value for property {@link #getAvatarDisplaySize avatarDisplaySize}.
        *
@@ -10250,7 +10421,7 @@ declare namespace sap {
          * The content to remove or its index or id
          */
         vContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * @SINCE 1.58
        *
@@ -10977,7 +11148,7 @@ declare namespace sap {
          * The action to remove or its index or id
          */
         vAction: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Removes all the controls from the aggregation {@link #getActions actions}.
        *
@@ -11055,7 +11226,7 @@ declare namespace sap {
          * The content to remove or its index or id
          */
         vContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Removes a expandedContent from the aggregation {@link #getExpandedContent expandedContent}.
        *
@@ -11066,7 +11237,7 @@ declare namespace sap {
          * The expandedContent to remove or its index or id
          */
         vExpandedContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * @SINCE 1.52
        *
@@ -11079,7 +11250,7 @@ declare namespace sap {
          * The navigationAction to remove or its index or id
          */
         vNavigationAction: int | string | sap.m.Button
-      ): sap.m.Button;
+      ): sap.m.Button | null;
       /**
        * Removes a snappedContent from the aggregation {@link #getSnappedContent snappedContent}.
        *
@@ -11090,7 +11261,7 @@ declare namespace sap {
          * The snappedContent to remove or its index or id
          */
         vSnappedContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * @SINCE 1.54
        *
@@ -12779,7 +12950,7 @@ declare namespace sap {
          * The beginColumnPage to remove or its index or id
          */
         vBeginColumnPage: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Removes a endColumnPage from the aggregation {@link #getEndColumnPages endColumnPages}.
        *
@@ -12790,7 +12961,7 @@ declare namespace sap {
          * The endColumnPage to remove or its index or id
          */
         vEndColumnPage: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Removes a midColumnPage from the aggregation {@link #getMidColumnPages midColumnPages}.
        *
@@ -12801,7 +12972,7 @@ declare namespace sap {
          * The midColumnPage to remove or its index or id
          */
         vMidColumnPage: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * @SINCE 1.76
        *
@@ -13372,6 +13543,17 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.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}.
        *
@@ -13383,6 +13565,17 @@ declare namespace sap {
        * @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}.
        *
@@ -13394,6 +13587,28 @@ declare namespace sap {
        * @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}.
        *
@@ -13405,6 +13620,24 @@ declare namespace sap {
        * @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}.
        *
@@ -13423,6 +13656,24 @@ declare namespace sap {
          */
         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}.
        *
@@ -13441,6 +13692,42 @@ declare namespace sap {
          */
         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}.
        *
@@ -13721,6 +14008,9 @@ declare namespace sap {
      * 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
@@ -15366,7 +15656,7 @@ declare namespace sap {
          * The content to remove or its index or id
          */
         vContent: int | string | sap.ui.core.Control
-      ): sap.ui.core.Control;
+      ): sap.ui.core.Control | null;
       /**
        * Unbinds aggregation {@link #getContent content} from model data.
        *
@@ -15770,7 +16060,7 @@ declare namespace sap {
          * The item to remove or its index or id
          */
         vItem: int | string | sap.f.ProductSwitchItem
-      ): sap.f.ProductSwitchItem;
+      ): sap.f.ProductSwitchItem | null;
       /**
        * Sets the `selectedItem` association.
        *
@@ -15887,6 +16177,9 @@ declare namespace sap {
        *
        * 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(): sap.ui.core.URI;
@@ -15952,6 +16245,9 @@ declare namespace sap {
        *
        * 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
@@ -16427,7 +16723,7 @@ declare namespace sap {
          * The suggestionItem to remove or its index or id
          */
         vSuggestionItem: int | string | sap.m.SuggestionItem
-      ): sap.m.SuggestionItem;
+      ): sap.m.SuggestionItem | null;
       /**
        * Sets a new value for property {@link #getEnabled enabled}.
        *
@@ -17515,7 +17811,7 @@ declare namespace sap {
          * The additionalContent to remove or its index or id
          */
         vAdditionalContent: int | string | sap.f.IShellBar
-      ): sap.f.IShellBar;
+      ): sap.f.IShellBar | null;
       /**
        * Removes all the controls from the aggregation {@link #getAdditionalContent additionalContent}.
        *