@openui5/ts-types 1.144.0 → 1.146.0

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare module "sap/m/p13n/Engine" {
   /**
@@ -253,6 +253,20 @@ declare namespace sap {
          * @returns The enablement of the vertical scrolling enablement for the `sap.m.p13n.Popup`.
          */
         getVerticalScrolling?(): boolean;
+        /**
+         * Optional hook that will be executed when the panel is used by a `sap.m.p13n.Popup` that is called before
+         * the popup is closed
+         *
+         * @since 1.145
+         *
+         * @returns A Promise that is fullfilled if the panel is ready to be closed
+         */
+        onBeforeClose?(
+          /**
+           * reason for closing the container
+           */
+          sReason: string
+        ): Promise<any>;
         /**
          * Optional hook that will be executed when the panel is used by a `sap.m.p13n.Popup` that may trigger a
          * reset on the panel
@@ -27996,8 +28010,10 @@ declare namespace sap {
        * Defines how many pages are displayed in the visible area of the `Carousel` control. Value should be a
        * positive number.
        *
-       * **Note:** When this property is set to something different than the default value, the `loop` property
+       * **Note:** When this property is set to something different from the default value, the `loop` property
        * of `Carousel` is ignored.
+       *
+       * **Note:** This property is ignored when the `responsive` property is set to `true`.
        */
       visiblePagesCount?:
         | int
@@ -28017,6 +28033,35 @@ declare namespace sap {
         | sap.m.CarouselScrollMode
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
+
+      /**
+       * Activates the responsive layout mode, where the number of visible carousel pages automatically adjusts
+       * based on the available width and the specified page width.
+       *
+       * When this option is enabled, the carousel dynamically calculates and displays as many items as can fit
+       * within the viewport while adhering to the `minPageWidth` constraint.
+       *
+       * **Note:** Enabling this option overrides the `visiblePagesCount` property and disables the `loop` functionality
+       * of the carousel.
+       */
+      responsive?:
+        | boolean
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * Defines the minimum width, in pixels, for each page to be displayed in the `Carousel` control.
+       *
+       * This property is used as a constraint when `responsive` mode is enabled, ensuring that pages are never
+       * rendered smaller than this specified width. The carousel automatically calculates the number of pages
+       * that can fit within the available viewport while respecting the specified minimum width requirement.
+       *
+       * **Note:** This property is only effective when the `responsive` property is set to `true`.
+       */
+      minPageWidth?:
+        | int
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
     }
 
     /**
@@ -28220,7 +28265,6 @@ declare namespace sap {
        * The last selected color in the ColorPalette.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        */
       selectedColor?:
         | sap.ui.core.CSSColor
@@ -28267,7 +28311,6 @@ declare namespace sap {
        * The last selected color in the ColorPalette.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        */
       selectedColor?:
         | sap.ui.core.CSSColor
@@ -30846,6 +30889,7 @@ declare namespace sap {
        * 	 - `strong`
        * 	 - `span`
        * 	 - `u`
+       * 	 - `s`
        * 	 - `dl`
        * 	 - `dt`
        * 	 - `dd`
@@ -31824,8 +31868,7 @@ declare namespace sap {
       /**
        * Specifies the interaction mode.
        *
-       * @experimental As of version 1.121. Disclaimer: this property is in a beta state - incompatible API changes
-       * may be done before its official public release. Use at your own discretion.
+       * @experimental As of version 1.121.
        */
       interactionMode?:
         | sap.m.IconTabFilterInteractionMode
@@ -34208,6 +34251,13 @@ declare namespace sap {
        */
       closed?: (oEvent: sap.ui.base.Event) => void;
 
+      /**
+       * Fired when the menu is opened.
+       *
+       * @since 1.146
+       */
+      open?: (oEvent: sap.ui.base.Event) => void;
+
       /**
        * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
        * closing.
@@ -37946,7 +37996,7 @@ declare namespace sap {
       /**
        * The (optional) custom header of this page. Use this aggregation only when a custom header is constructed
        * where the default header consisting of title text + nav button is not sufficient. If this aggregation
-       * is set, the simple properties "title", "showNavButton", "NavButtonText" and "icon" are not used.
+       * is set, the simple properties "title", "showNavButton", "navButtonText" and "icon" are not used.
        */
       customHeader?: sap.m.IBar;
 
@@ -42845,7 +42895,8 @@ declare namespace sap {
       description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
       /**
-       * Defines the list item icon.
+       * Defines the list item icon. **Note:** The icon is decorative. For more advanced use cases and configuration
+       * options, use the `avatar` aggregation.
        */
       icon?:
         | sap.ui.core.URI
@@ -43546,8 +43597,7 @@ declare namespace sap {
         | `{${string}}`;
 
       /**
-       * Enables alternating table row colors. **Note:** This property can only be used with the Belize and Belize
-       * Deep themes. Alternate row coloring is not available for the High Contrast Black/White themes.
+       * Enables alternating table row colors.
        *
        * @since 1.52
        */
@@ -45919,6 +45969,11 @@ declare namespace sap {
        */
       manageCancel?: (oEvent: sap.ui.base.Event) => void;
 
+      /**
+       * This event is fired when users opens the Manage Views dialog.
+       */
+      manageOpen?: (oEvent: sap.ui.base.Event) => void;
+
       /**
        * This event is fired when users apply changes variant information in the Manage Views dialog. Some
        * of the parameters may be ommitted, depending on user selection.
@@ -47587,6 +47642,11 @@ declare namespace sap {
       item?: sap.m.IMenuItem;
     }
 
+    /**
+     * Parameters of the Menu#open event.
+     */
+    interface Menu$OpenEventParameters {}
+
     /**
      * Parameters of the MenuButton#beforeMenuOpen event.
      */
@@ -50388,6 +50448,11 @@ declare namespace sap {
      */
     interface VariantManagement$ManageCancelEventParameters {}
 
+    /**
+     * Parameters of the VariantManagement#manageOpen event.
+     */
+    interface VariantManagement$ManageOpenEventParameters {}
+
     /**
      * Parameters of the VariantManagement#save event.
      */
@@ -58767,6 +58832,8 @@ declare namespace sap {
      *     the navigation arrows.
      * 	 - On desktop, navigation is done with the navigation arrows.
      * 	 - The paging indicator (when activated) is visible on each form factor.
+     * 	 - When using {@link sap.m.CarouselLayout CarouselLayout} with the `responsive` property set to `true`,
+     *     the number of visible pages adjusts automatically based on the available width and the specified `minPageWidth`.
      */
     class Carousel extends sap.ui.core.Control {
       /**
@@ -59737,6 +59804,41 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.base.ManagedObjectMetadata;
+      /**
+       * Gets current value of property {@link #getMinPageWidth minPageWidth}.
+       *
+       * Defines the minimum width, in pixels, for each page to be displayed in the `Carousel` control.
+       *
+       * This property is used as a constraint when `responsive` mode is enabled, ensuring that pages are never
+       * rendered smaller than this specified width. The carousel automatically calculates the number of pages
+       * that can fit within the available viewport while respecting the specified minimum width requirement.
+       *
+       * **Note:** This property is only effective when the `responsive` property is set to `true`.
+       *
+       * Default value is `148`.
+       *
+       *
+       * @returns Value of property `minPageWidth`
+       */
+      getMinPageWidth(): int;
+      /**
+       * Gets current value of property {@link #getResponsive responsive}.
+       *
+       * Activates the responsive layout mode, where the number of visible carousel pages automatically adjusts
+       * based on the available width and the specified page width.
+       *
+       * When this option is enabled, the carousel dynamically calculates and displays as many items as can fit
+       * within the viewport while adhering to the `minPageWidth` constraint.
+       *
+       * **Note:** Enabling this option overrides the `visiblePagesCount` property and disables the `loop` functionality
+       * of the carousel.
+       *
+       * Default value is `false`.
+       *
+       *
+       * @returns Value of property `responsive`
+       */
+      getResponsive(): boolean;
       /**
        * Gets current value of property {@link #getScrollMode scrollMode}.
        *
@@ -59759,15 +59861,66 @@ declare namespace sap {
        * Defines how many pages are displayed in the visible area of the `Carousel` control. Value should be a
        * positive number.
        *
-       * **Note:** When this property is set to something different than the default value, the `loop` property
+       * **Note:** When this property is set to something different from the default value, the `loop` property
        * of `Carousel` is ignored.
        *
+       * **Note:** This property is ignored when the `responsive` property is set to `true`.
+       *
        * Default value is `1`.
        *
        *
        * @returns Value of property `visiblePagesCount`
        */
       getVisiblePagesCount(): int;
+      /**
+       * Sets a new value for property {@link #getMinPageWidth minPageWidth}.
+       *
+       * Defines the minimum width, in pixels, for each page to be displayed in the `Carousel` control.
+       *
+       * This property is used as a constraint when `responsive` mode is enabled, ensuring that pages are never
+       * rendered smaller than this specified width. The carousel automatically calculates the number of pages
+       * that can fit within the available viewport while respecting the specified minimum width requirement.
+       *
+       * **Note:** This property is only effective when the `responsive` property is set to `true`.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `148`.
+       *
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setMinPageWidth(
+        /**
+         * New value for property `minPageWidth`
+         */
+        iMinPageWidth?: int
+      ): this;
+      /**
+       * Sets a new value for property {@link #getResponsive responsive}.
+       *
+       * Activates the responsive layout mode, where the number of visible carousel pages automatically adjusts
+       * based on the available width and the specified page width.
+       *
+       * When this option is enabled, the carousel dynamically calculates and displays as many items as can fit
+       * within the viewport while adhering to the `minPageWidth` constraint.
+       *
+       * **Note:** Enabling this option overrides the `visiblePagesCount` property and disables the `loop` functionality
+       * of the carousel.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `false`.
+       *
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setResponsive(
+        /**
+         * New value for property `responsive`
+         */
+        bResponsive?: boolean
+      ): this;
       /**
        * Sets a new value for property {@link #getScrollMode scrollMode}.
        *
@@ -59797,9 +59950,11 @@ declare namespace sap {
        * Defines how many pages are displayed in the visible area of the `Carousel` control. Value should be a
        * positive number.
        *
-       * **Note:** When this property is set to something different than the default value, the `loop` property
+       * **Note:** When this property is set to something different from the default value, the `loop` property
        * of `Carousel` is ignored.
        *
+       * **Note:** This property is ignored when the `responsive` property is set to `true`.
+       *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * Default value is `1`.
@@ -60904,7 +61059,6 @@ declare namespace sap {
        * The last selected color in the ColorPalette.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        *
        * @returns Value of property `selectedColor`
        */
@@ -60948,7 +61102,6 @@ declare namespace sap {
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -61234,7 +61387,6 @@ declare namespace sap {
        * The last selected color in the ColorPalette.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        *
        * @returns Value of property `selectedColor`
        */
@@ -61365,7 +61517,6 @@ declare namespace sap {
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        * @since 1.122
-       * @experimental As of version 1.122. this property is in a beta state.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -75541,6 +75692,7 @@ declare namespace sap {
        * 	 - `strong`
        * 	 - `span`
        * 	 - `u`
+       * 	 - `s`
        * 	 - `dl`
        * 	 - `dt`
        * 	 - `dd`
@@ -79781,8 +79933,7 @@ declare namespace sap {
        *
        * Default value is `Auto`.
        *
-       * @experimental As of version 1.121. Disclaimer: this property is in a beta state - incompatible API changes
-       * may be done before its official public release. Use at your own discretion.
+       * @experimental As of version 1.121.
        *
        * @returns Value of property `interactionMode`
        */
@@ -80085,8 +80236,7 @@ declare namespace sap {
        *
        * Default value is `Auto`.
        *
-       * @experimental As of version 1.121. Disclaimer: this property is in a beta state - incompatible API changes
-       * may be done before its official public release. Use at your own discretion.
+       * @experimental As of version 1.121.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
@@ -92801,6 +92951,55 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.m.Menu`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.Menu` itself.
+       *
+       * Fired when the menu is opened.
+       *
+       * @since 1.146
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachOpen(
+        /**
+         * An application-specific payload object that will be passed to the event handler along with the event
+         * object when firing the event
+         */
+        oData: object,
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.m.Menu`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.Menu` itself.
+       *
+       * Fired when the menu is opened.
+       *
+       * @since 1.146
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachOpen(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.Menu` itself
+         */
+        oListener?: object
+      ): this;
       /**
        * Binds aggregation {@link #getItems items} to model data.
        *
@@ -92890,6 +93089,25 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:open open} event of this `sap.m.Menu`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       * @since 1.146
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachOpen(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
       /**
        * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
        *
@@ -92933,6 +93151,20 @@ declare namespace sap {
          */
         mParameters?: sap.m.Menu$ItemSelectedEventParameters
       ): this;
+      /**
+       * Fires event {@link #event:open open} to attached listeners.
+       *
+       * @since 1.146
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      fireOpen(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: object
+      ): this;
       /**
        * Gets content of aggregation {@link #getItems items}.
        *
@@ -114571,7 +114803,7 @@ declare namespace sap {
        *
        * The (optional) custom header of this page. Use this aggregation only when a custom header is constructed
        * where the default header consisting of title text + nav button is not sufficient. If this aggregation
-       * is set, the simple properties "title", "showNavButton", "NavButtonText" and "icon" are not used.
+       * is set, the simple properties "title", "showNavButton", "navButtonText" and "icon" are not used.
        */
       getCustomHeader(): sap.m.IBar;
       /**
@@ -142971,7 +143203,8 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getIcon icon}.
        *
-       * Defines the list item icon.
+       * Defines the list item icon. **Note:** The icon is decorative. For more advanced use cases and configuration
+       * options, use the `avatar` aggregation.
        *
        *
        * @returns Value of property `icon`
@@ -143182,7 +143415,8 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getIcon icon}.
        *
-       * Defines the list item icon.
+       * Defines the list item icon. **Note:** The icon is decorative. For more advanced use cases and configuration
+       * options, use the `avatar` aggregation.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -146524,8 +146758,7 @@ declare namespace sap {
       /**
        * Gets current value of property {@link #getAlternateRowColors alternateRowColors}.
        *
-       * Enables alternating table row colors. **Note:** This property can only be used with the Belize and Belize
-       * Deep themes. Alternate row coloring is not available for the High Contrast Black/White themes.
+       * Enables alternating table row colors.
        *
        * Default value is `false`.
        *
@@ -146748,8 +146981,7 @@ declare namespace sap {
       /**
        * Sets a new value for property {@link #getAlternateRowColors alternateRowColors}.
        *
-       * Enables alternating table row colors. **Note:** This property can only be used with the Belize and Belize
-       * Deep themes. Alternate row coloring is not available for the High Contrast Black/White themes.
+       * Enables alternating table row colors.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
@@ -160540,6 +160772,53 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:manageOpen manageOpen} event of this `sap.m.VariantManagement`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.VariantManagement` itself.
+       *
+       * This event is fired when users opens the Manage Views dialog.
+       *
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachManageOpen(
+        /**
+         * An application-specific payload object that will be passed to the event handler along with the event
+         * object when firing the event
+         */
+        oData: object,
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.VariantManagement` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:manageOpen manageOpen} event of this `sap.m.VariantManagement`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.m.VariantManagement` itself.
+       *
+       * This event is fired when users opens the Manage Views dialog.
+       *
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachManageOpen(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.m.VariantManagement` itself
+         */
+        oListener?: object
+      ): this;
       /**
        * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.m.VariantManagement`.
        *
@@ -160695,6 +160974,24 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:manageOpen manageOpen} event of this `sap.m.VariantManagement`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachManageOpen(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
       /**
        * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.m.VariantManagement`.
        *
@@ -160770,6 +161067,19 @@ declare namespace sap {
          */
         mParameters?: object
       ): this;
+      /**
+       * Fires event {@link #event:manageOpen manageOpen} to attached listeners.
+       *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      fireManageOpen(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: object
+      ): this;
       /**
        * Fires event {@link #event:save save} to attached listeners.
        *
@@ -167415,8 +167725,6 @@ declare namespace sap {
        * feature works under the Browser's Cross-Origin Resource Sharing (CORS) policy. This means that a web
        * application using those APIs can only request resources from the same origin the application was loaded
        * from unless the response from other origins includes the right CORS headers.
-       *
-       * @experimental As of version 1.106.
        */
       InlineSvg = "InlineSvg",
     }
@@ -169390,6 +169698,12 @@ declare namespace sap {
      * @since 1.54
      */
     enum TimePickerMaskMode {
+      /**
+       * The mask will always be enforced for any time patterns. **Note:** The mask functions correctly only with
+       * fixed-length time formats. Using the `Enforce` value with time formats that do not have a fixed length
+       * may lead to unpredictable behavior.
+       */
+      Enforce = "Enforce",
       /**
        * The mask is disabled for the `sap.m.TimePicker`.
        */
@@ -170591,6 +170905,11 @@ declare namespace sap {
       Menu
     >;
 
+    /**
+     * Event object of the Menu#open event.
+     */
+    type Menu$OpenEvent = sap.ui.base.Event<Menu$OpenEventParameters, Menu>;
+
     /**
      * Event object of the MenuButton#beforeMenuOpen event.
      */
@@ -172202,6 +172521,14 @@ declare namespace sap {
       VariantManagement
     >;
 
+    /**
+     * Event object of the VariantManagement#manageOpen event.
+     */
+    type VariantManagement$ManageOpenEvent = sap.ui.base.Event<
+      VariantManagement$ManageOpenEventParameters,
+      VariantManagement
+    >;
+
     /**
      * Event object of the VariantManagement#save event.
      */