@sapui5/ts-types-esm 1.130.2 → 1.131.1

package/types/{mobile-1.130.0-esm-d.ts → mobile-1.131.0-esm-d.ts}

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/f/library" {
   export interface IShellBar {
@@ -2101,8 +2101,6 @@ declare module "sap/m/library" {
    * undefined
    *
    * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'P13nConditionOperation'.
-   *
-   * @experimental (since 1.26) - !!! THIS TYPE IS ONLY FOR INTERNAL USE !!!
    */
   export enum P13nConditionOperation {
     Ascending = "Ascending",
@@ -22329,29 +22327,35 @@ declare module "sap/m/Dialog" {
     /**
      * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
      *
+     * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+     * event object. The return value of this method indicates whether the default action should be executed.
+     *
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @returns Whether or not to prevent the default action
      */
     fireBeforeClose(
       /**
        * Parameters to pass along with the event
        */
       mParameters?: Dialog$BeforeCloseEventParameters
-    ): this;
+    ): boolean;
     /**
      * Fires event {@link #event:beforeOpen beforeOpen} to attached listeners.
      *
+     * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+     * event object. The return value of this method indicates whether the default action should be executed.
+     *
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @returns Whether or not to prevent the default action
      */
     fireBeforeOpen(
       /**
        * Parameters to pass along with the event
        */
       mParameters?: object
-    ): this;
+    ): boolean;
     /**
      * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}.
      */
@@ -52523,7 +52527,8 @@ declare module "sap/m/ListItemBase" {
      * Defines the highlight state of the list items.
      *
      * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-     * or {@link sap.ui.core.IndicationColor}.
+     * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+     * for accessibility contrast reasons).
      *
      * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -52676,7 +52681,8 @@ declare module "sap/m/ListItemBase" {
      * Defines the highlight state of the list items.
      *
      * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-     * or {@link sap.ui.core.IndicationColor}.
+     * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+     * for accessibility contrast reasons).
      *
      * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -52854,7 +52860,8 @@ declare module "sap/m/ListItemBase" {
      * Defines the highlight state of the list items.
      *
      * Valid values for the `highlight` property are values of the enumerations {@link sap.ui.core.MessageType }
-     * or {@link sap.ui.core.IndicationColor}.
+     * or {@link sap.ui.core.IndicationColor} (only values of `Indication01` to `Indication10` are supported
+     * for accessibility contrast reasons).
      *
      * Accessibility support is provided through the associated {@link sap.m.ListItemBase#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -53143,6 +53150,65 @@ declare module "sap/m/MaskInput" {
        */
       oListener?: object
     ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+     *
+     * 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.MaskInput` itself.
+     *
+     * This event is fired when user presses the Enter key on the Mask input.
+     *
+     * **Notes:**
+     * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+     *     the event is fired after the change event.
+     * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+     *
+     * @since 1.131.0
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachSubmit(
+      /**
+       * 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: MaskInput$SubmitEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.m.MaskInput` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+     *
+     * 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.MaskInput` itself.
+     *
+     * This event is fired when user presses the Enter key on the Mask input.
+     *
+     * **Notes:**
+     * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+     *     the event is fired after the change event.
+     * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+     *
+     * @since 1.131.0
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachSubmit(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: MaskInput$SubmitEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.m.MaskInput` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Destroys all the rules in the aggregation {@link #getRules rules}.
      *
@@ -53169,6 +53235,25 @@ declare module "sap/m/MaskInput" {
        */
       oListener?: object
     ): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:submit submit} event of this `sap.m.MaskInput`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     * @since 1.131.0
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachSubmit(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: MaskInput$SubmitEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
     /**
      * Fires event {@link #event:liveChange liveChange} to attached listeners.
      *
@@ -53183,6 +53268,20 @@ declare module "sap/m/MaskInput" {
        */
       mParameters?: MaskInput$LiveChangeEventParameters
     ): this;
+    /**
+     * Fires event {@link #event:submit submit} to attached listeners.
+     *
+     * @since 1.131.0
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireSubmit(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: MaskInput$SubmitEventParameters
+    ): this;
     /**
      * Gets current value of property {@link #getMask mask}.
      *
@@ -53390,6 +53489,18 @@ declare module "sap/m/MaskInput" {
      * @since 1.104.0
      */
     liveChange?: (oEvent: MaskInput$LiveChangeEvent) => void;
+
+    /**
+     * This event is fired when user presses the Enter key on the Mask input.
+     *
+     * **Notes:**
+     * 	 - The event is fired independent of whether there was a change before or not. If a change was performed,
+     *     the event is fired after the change event.
+     * 	 - The event is only fired on an input which allows text input (`editable` and `enabled`).
+     *
+     * @since 1.131.0
+     */
+    submit?: (oEvent: MaskInput$SubmitEvent) => void;
   }
 
   /**
@@ -53414,6 +53525,24 @@ declare module "sap/m/MaskInput" {
     MaskInput$LiveChangeEventParameters,
     MaskInput
   >;
+
+  /**
+   * Parameters of the MaskInput#submit event.
+   */
+  export interface MaskInput$SubmitEventParameters {
+    /**
+     * The new value of the Mask input.
+     */
+    value?: string;
+  }
+
+  /**
+   * Event object of the MaskInput#submit event.
+   */
+  export type MaskInput$SubmitEvent = Event<
+    MaskInput$SubmitEventParameters,
+    MaskInput
+  >;
 }
 
 declare module "sap/m/MaskInputRule" {
@@ -53672,6 +53801,57 @@ declare module "sap/m/Menu" {
        */
       oItem: IMenuItem
     ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} 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 before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing.
+     *
+     * @since 1.131
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeClose(
+      /**
+       * 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:beforeClose beforeClose} 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 before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing.
+     *
+     * @since 1.131
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeClose(
+      /**
+       * 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:closed closed} event of this `sap.m.Menu`.
      *
@@ -53792,6 +53972,25 @@ declare module "sap/m/Menu" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyItems(): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:beforeClose beforeClose} event of this `sap.m.Menu`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     * @since 1.131
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachBeforeClose(
+      /**
+       * 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:closed closed} event of this `sap.m.Menu`.
      *
@@ -53828,6 +54027,23 @@ declare module "sap/m/Menu" {
        */
       oListener?: object
     ): this;
+    /**
+     * Fires event {@link #event:beforeClose beforeClose} to attached listeners.
+     *
+     * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+     * event object. The return value of this method indicates whether the default action should be executed.
+     *
+     * @since 1.131
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Whether or not to prevent the default action
+     */
+    fireBeforeClose(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: object
+    ): boolean;
     /**
      * Fires event {@link #event:closed closed} to attached listeners.
      *
@@ -54026,8 +54242,29 @@ declare module "sap/m/Menu" {
      * Fired when the menu is closed.
      */
     closed?: (oEvent: Event) => void;
+
+    /**
+     * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing.
+     *
+     * @since 1.131
+     */
+    beforeClose?: (oEvent: Event) => void;
   }
 
+  /**
+   * Parameters of the Menu#beforeClose event.
+   */
+  export interface Menu$BeforeCloseEventParameters {}
+
+  /**
+   * Event object of the Menu#beforeClose event.
+   */
+  export type Menu$BeforeCloseEvent = Event<
+    Menu$BeforeCloseEventParameters,
+    Menu
+  >;
+
   /**
    * Parameters of the Menu#closed event.
    */
@@ -54934,6 +55171,8 @@ declare module "sap/m/MenuItem" {
 
   import { IMenuItem } from "sap/m/library";
 
+  import Control from "sap/ui/core/Control";
+
   import Event from "sap/ui/base/Event";
 
   import {
@@ -55012,6 +55251,20 @@ declare module "sap/m/MenuItem" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * Adds some endContent to the aggregation {@link #getEndContent endContent}.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    addEndContent(
+      /**
+       * The endContent to add; if empty, nothing is inserted
+       */
+      oEndContent: Control
+    ): this;
     /**
      * Adds some item to the aggregation {@link #getItems items}.
      *
@@ -55184,6 +55437,15 @@ declare module "sap/m/MenuItem" {
        */
       oBindingInfo: AggregationBindingInfo
     ): this;
+    /**
+     * Destroys all the endContent in the aggregation {@link #getEndContent endContent}.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    destroyEndContent(): this;
     /**
      * Destroys all the items in the aggregation {@link #getItems items}.
      *
@@ -55286,6 +55548,16 @@ declare module "sap/m/MenuItem" {
        */
       mParameters?: MenuItem$PropertyChangedEventParameters
     ): this;
+    /**
+     * Gets content of aggregation {@link #getEndContent endContent}.
+     *
+     * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
+     * of custom elements, such as icons and buttons.
+     *
+     * @since 1.131
+     * @experimental
+     */
+    getEndContent(): Control[];
     /**
      * Gets current value of property {@link #getIcon icon}.
      *
@@ -55351,6 +55623,21 @@ declare module "sap/m/MenuItem" {
      * @returns Value of property `visible`
      */
     getVisible(): boolean;
+    /**
+     * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getEndContent endContent}. and
+     * returns its index if found or -1 otherwise.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+     */
+    indexOfEndContent(
+      /**
+       * The endContent whose index is looked for
+       */
+      oEndContent: Control
+    ): int;
     /**
      * Checks for the provided `sap.m.IMenuItem` in the aggregation {@link #getItems items}. and returns its
      * index if found or -1 otherwise.
@@ -55364,6 +55651,26 @@ declare module "sap/m/MenuItem" {
        */
       oItem: IMenuItem
     ): int;
+    /**
+     * Inserts a endContent into the aggregation {@link #getEndContent endContent}.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    insertEndContent(
+      /**
+       * The endContent to insert; if empty, nothing is inserted
+       */
+      oEndContent: Control,
+      /**
+       * The `0`-based index the endContent should be inserted at; for a negative value of `iIndex`, the endContent
+       * is inserted at position 0; for a value greater than the current size of the aggregation, the endContent
+       * is inserted at the last position
+       */
+      iIndex: int
+    ): this;
     /**
      * Inserts a item into the aggregation {@link #getItems items}.
      *
@@ -55382,6 +55689,17 @@ declare module "sap/m/MenuItem" {
        */
       iIndex: int
     ): this;
+    /**
+     * Removes all the controls from the aggregation {@link #getEndContent endContent}.
+     *
+     * Additionally, it unregisters them from the hosting UIArea.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns An array of the removed elements (might be empty)
+     */
+    removeAllEndContent(): Control[];
     /**
      * Removes all the controls from the aggregation {@link #getItems items}.
      *
@@ -55391,6 +55709,20 @@ declare module "sap/m/MenuItem" {
      * @returns An array of the removed elements (might be empty)
      */
     removeAllItems(): IMenuItem[];
+    /**
+     * Removes a endContent from the aggregation {@link #getEndContent endContent}.
+     *
+     * @since 1.131
+     * @experimental
+     *
+     * @returns The removed endContent or `null`
+     */
+    removeEndContent(
+      /**
+       * The endContent to remove or its index or id
+       */
+      vEndContent: int | string | Control
+    ): Control | null;
     /**
      * Removes a item from the aggregation {@link #getItems items}.
      *
@@ -55525,6 +55857,15 @@ declare module "sap/m/MenuItem" {
      */
     items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
 
+    /**
+     * Defines the content that is displayed at the end of a menu item. This aggregation allows for the addition
+     * of custom elements, such as icons and buttons.
+     *
+     * @since 1.131
+     * @experimental
+     */
+    endContent?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
+
     /**
      * Fired after the item has been pressed.
      */
@@ -72751,7 +73092,6 @@ declare module "sap/m/OverflowToolbar" {
    * 	 - {@link sap.m.ComboBox}
    * 	 - {@link sap.m.DatePicker}
    * 	 - {@link sap.m.DateRangeSelection}
-   * 	 - {@link sap.m.DateTimeInput}
    * 	 - {@link sap.m.DateTimePicker}
    * 	 - {@link sap.m.GenericTag}
    * 	 - {@link sap.m.Input}
@@ -73908,7 +74248,6 @@ declare module "sap/m/p13n/Engine" {
      * Applies a state to a control by passing an object that contains the registered controller key and an
      * object matching the inner subcontroller logic.
      *
-     * @experimental (since 1.104) - Please note that the API of this control is not yet finalized!
      *
      * @returns A Promise resolving after the state has been applied
      */
@@ -73990,7 +74329,6 @@ declare module "sap/m/p13n/Engine" {
      * modification handler appliance). After the returned `Promise` has been resolved, the returned state is
      * in sync with the related state object of the control.
      *
-     * @experimental (since 1.104) - Please note that the API of this control is not yet finalized!
      *
      * @returns A Promise resolving in the current control state
      */
@@ -76787,7 +77125,6 @@ declare module "sap/m/P13nConditionPanel" {
    *
    * @since 1.26.0
    * @deprecated (since 1.124) - replaced by the artifacts in {@link sap.m.p13n}.
-   * @experimental (since 1.26) - !!! THIS CONTROL IS ONLY FOR INTERNAL USE !!!
    */
   export default class P13nConditionPanel extends Control {
     /**
@@ -77398,7 +77735,6 @@ declare module "sap/m/P13nConditionPanel" {
    * Describes the settings that can be provided to the P13nConditionPanel constructor.
    *
    * @deprecated (since 1.124) - replaced by the artifacts in {@link sap.m.p13n}.
-   * @experimental (since 1.26) - !!! THIS CONTROL IS ONLY FOR INTERNAL USE !!!
    */
   export interface $P13nConditionPanelSettings extends $ControlSettings {
     /**
@@ -79282,7 +79618,6 @@ declare module "sap/m/P13nFilterPanel" {
      *
      * Event raised if a filter item has been changed. reason can be added, updated or removed.
      *
-     * @experimental (since 1.56)
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -79310,7 +79645,6 @@ declare module "sap/m/P13nFilterPanel" {
      *
      * Event raised if a filter item has been changed. reason can be added, updated or removed.
      *
-     * @experimental (since 1.56)
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -79476,7 +79810,6 @@ declare module "sap/m/P13nFilterPanel" {
      *
      * The passed function and listener object must match the ones used for event registration.
      *
-     * @experimental (since 1.56)
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -79544,7 +79877,6 @@ declare module "sap/m/P13nFilterPanel" {
     /**
      * Fires event {@link #event:filterItemChanged filterItemChanged} to attached listeners.
      *
-     * @experimental (since 1.56)
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -79987,8 +80319,6 @@ declare module "sap/m/P13nFilterPanel" {
 
     /**
      * Event raised if a filter item has been changed. reason can be added, updated or removed.
-     *
-     * @experimental (since 1.56)
      */
     filterItemChanged?: (
       oEvent: P13nFilterPanel$FilterItemChangedEvent
@@ -80010,8 +80340,6 @@ declare module "sap/m/P13nFilterPanel" {
 
   /**
    * Parameters of the P13nFilterPanel#filterItemChanged event.
-   *
-   * @experimental (since 1.56)
    */
   export interface P13nFilterPanel$FilterItemChangedEventParameters {
     /**
@@ -80038,8 +80366,6 @@ declare module "sap/m/P13nFilterPanel" {
 
   /**
    * Event object of the P13nFilterPanel#filterItemChanged event.
-   *
-   * @experimental (since 1.56)
    */
   export type P13nFilterPanel$FilterItemChangedEvent = Event<
     P13nFilterPanel$FilterItemChangedEventParameters,
@@ -98327,6 +98653,7 @@ declare module "sap/m/ProgressIndicator" {
      *
      * Default value is `true`.
      *
+     * @deprecated (since 1.130) - with no replacement.
      *
      * @returns Value of property `enabled`
      */
@@ -98509,6 +98836,7 @@ declare module "sap/m/ProgressIndicator" {
      *
      * Default value is `true`.
      *
+     * @deprecated (since 1.130) - with no replacement.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -98639,6 +98967,8 @@ declare module "sap/m/ProgressIndicator" {
   export interface $ProgressIndicatorSettings extends $ControlSettings {
     /**
      * Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.
+     *
+     * @deprecated (since 1.130) - with no replacement.
      */
     enabled?: boolean | PropertyBindingInfo | `{${string}}`;
 

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/apf/library" {}
 

package/types/sap.ca.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/ca/ui/library" {
   export namespace charts {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.1
 
 declare module "sap/chart/library" {
   import Dimension from "sap/chart/data/Dimension";

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/collaboration/library" {
   /**