@openui5/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/f/library" {
   export interface IShellBar {
@@ -1658,8 +1658,6 @@ declare module "sap/m/library" {
      * 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",
   }
@@ -3996,6 +3994,12 @@ declare module "sap/m/library" {
    * @since 1.54
    */
   export 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`.
      */
@@ -4539,6 +4543,20 @@ declare module "sap/m/library" {
        * @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
@@ -12134,6 +12152,8 @@ declare module "sap/m/Carousel" {
    *     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`.
    */
   export default class Carousel extends Control {
     /**
@@ -13363,6 +13383,41 @@ declare module "sap/m/CarouselLayout" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): 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}.
      *
@@ -13385,15 +13440,66 @@ declare module "sap/m/CarouselLayout" {
      * 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}.
      *
@@ -13423,9 +13529,11 @@ declare module "sap/m/CarouselLayout" {
      * 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`.
@@ -13448,8 +13556,10 @@ declare module "sap/m/CarouselLayout" {
      * 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 | PropertyBindingInfo | `{${string}}`;
 
@@ -13466,6 +13576,29 @@ declare module "sap/m/CarouselLayout" {
       | (CarouselScrollMode | keyof typeof CarouselScrollMode)
       | 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 | 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 | PropertyBindingInfo | `{${string}}`;
   }
 }
 
@@ -14767,7 +14900,6 @@ declare module "sap/m/ColorPalette" {
      * 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`
      */
@@ -14811,7 +14943,6 @@ declare module "sap/m/ColorPalette" {
      * 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
      */
@@ -14835,7 +14966,6 @@ declare module "sap/m/ColorPalette" {
      * The last selected color in the ColorPalette.
      *
      * @since 1.122
-     * @experimental As of version 1.122. this property is in a beta state.
      */
     selectedColor?: CSSColor | PropertyBindingInfo | `{${string}}`;
 
@@ -15223,7 +15353,6 @@ declare module "sap/m/ColorPalettePopover" {
      * 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`
      */
@@ -15356,7 +15485,6 @@ declare module "sap/m/ColorPalettePopover" {
      * 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
      */
@@ -15442,7 +15570,6 @@ declare module "sap/m/ColorPalettePopover" {
      * The last selected color in the ColorPalette.
      *
      * @since 1.122
-     * @experimental As of version 1.122. this property is in a beta state.
      */
     selectedColor?: CSSColor | PropertyBindingInfo | `{${string}}`;
 
@@ -32963,6 +33090,7 @@ declare module "sap/m/FormattedText" {
      * 	 - `strong`
      * 	 - `span`
      * 	 - `u`
+     * 	 - `s`
      * 	 - `dl`
      * 	 - `dt`
      * 	 - `dd`
@@ -33248,6 +33376,7 @@ declare module "sap/m/FormattedText" {
      * 	 - `strong`
      * 	 - `span`
      * 	 - `u`
+     * 	 - `s`
      * 	 - `dl`
      * 	 - `dt`
      * 	 - `dd`
@@ -38281,8 +38410,7 @@ declare module "sap/m/IconTabFilter" {
      *
      * 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`
      */
@@ -38585,8 +38713,7 @@ declare module "sap/m/IconTabFilter" {
      *
      * 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
      */
@@ -38697,8 +38824,7 @@ declare module "sap/m/IconTabFilter" {
     /**
      * 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?:
       | (
@@ -55961,6 +56087,55 @@ declare module "sap/m/Menu" {
        */
       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: 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: 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.
      *
@@ -56050,6 +56225,25 @@ declare module "sap/m/Menu" {
        */
       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: 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.
      *
@@ -56093,6 +56287,20 @@ declare module "sap/m/Menu" {
        */
       mParameters?: 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}.
      *
@@ -56251,6 +56459,13 @@ declare module "sap/m/Menu" {
      */
     closed?: (oEvent: Event) => void;
 
+    /**
+     * Fired when the menu is opened.
+     *
+     * @since 1.146
+     */
+    open?: (oEvent: Event) => void;
+
     /**
      * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
      * closing.
@@ -56305,6 +56520,16 @@ declare module "sap/m/Menu" {
     Menu$ItemSelectedEventParameters,
     Menu
   >;
+
+  /**
+   * Parameters of the Menu#open event.
+   */
+  export interface Menu$OpenEventParameters {}
+
+  /**
+   * Event object of the Menu#open event.
+   */
+  export type Menu$OpenEvent = Event<Menu$OpenEventParameters, Menu>;
 }
 
 declare module "sap/m/MenuButton" {
@@ -86235,7 +86460,7 @@ declare module "sap/m/Page" {
      *
      * 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(): IBar;
     /**
@@ -87062,7 +87287,7 @@ declare module "sap/m/Page" {
     /**
      * 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?: IBar;
 
@@ -135965,7 +136190,8 @@ declare module "sap/m/StandardListItem" {
     /**
      * 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`
@@ -136176,7 +136402,8 @@ declare module "sap/m/StandardListItem" {
     /**
      * 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.
      *
@@ -136411,7 +136638,8 @@ declare module "sap/m/StandardListItem" {
     description?: string | 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?: URI | PropertyBindingInfo | `{${string}}`;
 
@@ -140325,8 +140553,7 @@ declare module "sap/m/Table" {
     /**
      * 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`.
      *
@@ -140549,8 +140776,7 @@ declare module "sap/m/Table" {
     /**
      * 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.
      *
@@ -140826,8 +141052,7 @@ declare module "sap/m/Table" {
     showOverlay?: boolean | PropertyBindingInfo | `{${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
      */
@@ -169767,6 +169992,53 @@ declare module "sap/m/VariantManagement" {
        */
       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: 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: 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`.
      *
@@ -169922,6 +170194,24 @@ declare module "sap/m/VariantManagement" {
        */
       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: 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`.
      *
@@ -169997,6 +170287,19 @@ declare module "sap/m/VariantManagement" {
        */
       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.
      *
@@ -170727,6 +171030,11 @@ declare module "sap/m/VariantManagement" {
      */
     manageCancel?: (oEvent: Event) => void;
 
+    /**
+     * This event is fired when users opens the Manage Views dialog.
+     */
+    manageOpen?: (oEvent: 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.
@@ -170810,6 +171118,19 @@ declare module "sap/m/VariantManagement" {
     VariantManagement
   >;
 
+  /**
+   * Parameters of the VariantManagement#manageOpen event.
+   */
+  export interface VariantManagement$ManageOpenEventParameters {}
+
+  /**
+   * Event object of the VariantManagement#manageOpen event.
+   */
+  export type VariantManagement$ManageOpenEvent = Event<
+    VariantManagement$ManageOpenEventParameters,
+    VariantManagement
+  >;
+
   /**
    * Parameters of the VariantManagement#save event.
    */