@sapui5/ts-types-esm 1.130.2 → 1.131.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/richtexteditor/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/rta/api/startAdaptation" {
   import Control from "sap/ui/core/Control";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/suite/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/support/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/table/library" {
   import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -5476,7 +5476,8 @@ declare module "sap/ui/table/RowSettings" {
      *
      * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
      * highlights are visible. 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.ui.table.RowSettings#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -5526,7 +5527,8 @@ declare module "sap/ui/table/RowSettings" {
      *
      * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
      * highlights are visible. 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.ui.table.RowSettings#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`
@@ -5600,7 +5602,8 @@ declare module "sap/ui/table/RowSettings" {
      *
      * If the highlight is set to {@link sap.ui.core.MessageType sap.ui.core.MessageType.None} (default), no
      * highlights are visible. 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.ui.table.RowSettings#setHighlightText highlightText }
      * property. If the `highlight` property is set to a value of {@link sap.ui.core.MessageType}, the `highlightText`

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/testrecorder/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/unified/library" {
   /**
@@ -18067,6 +18067,55 @@ declare module "sap/ui/unified/Menu" {
        */
       oItem: IMenuItem
     ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.ui.unified.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.ui.unified.Menu` itself.
+     *
+     * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing. sinnce 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.ui.unified.Menu` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:beforeClose beforeClose} event of this `sap.ui.unified.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.ui.unified.Menu` itself.
+     *
+     * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing. sinnce 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.ui.unified.Menu` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.unified.Menu`.
      *
@@ -18178,6 +18227,24 @@ declare module "sap/ui/unified/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.ui.unified.Menu`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @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.ui.unified.Menu`.
      *
@@ -18215,6 +18282,22 @@ declare module "sap/ui/unified/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.
+     *
+     * @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.
      *
@@ -18596,8 +18679,27 @@ declare module "sap/ui/unified/Menu" {
      * @since 1.129
      */
     closed?: (oEvent: Event) => void;
+
+    /**
+     * Fired before the menu is closed. This event can be prevented which effectively prevents the menu from
+     * closing. sinnce 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.
    */
@@ -18641,7 +18743,10 @@ declare module "sap/ui/unified/MenuItem" {
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
 
   /**
    * Standard item to be used inside a menu. A menu item represents an action which can be selected by the
@@ -18725,10 +18830,43 @@ declare module "sap/ui/unified/MenuItem" {
        */
       vAriaLabelledBy: ID | Control
     ): this;
+    /**
+     * 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;
+    /**
+     * 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;
     /**
      * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
      */
     getAriaLabelledBy(): ID[];
+    /**
+     * 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}.
      *
@@ -18773,6 +18911,41 @@ declare module "sap/ui/unified/MenuItem" {
      * @returns Value of property `text`
      */
     getText(): string;
+    /**
+     * 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;
+    /**
+     * 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;
     /**
      * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
      *
@@ -18780,6 +18953,17 @@ declare module "sap/ui/unified/MenuItem" {
      * @returns An array of the removed elements (might be empty)
      */
     removeAllAriaLabelledBy(): ID[];
+    /**
+     * 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 an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
      *
@@ -18792,6 +18976,20 @@ declare module "sap/ui/unified/MenuItem" {
        */
       vAriaLabelledBy: int | ID | Control
     ): ID | null;
+    /**
+     * 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;
     /**
      * Sets a new value for property {@link #getIcon icon}.
      *
@@ -18898,6 +19096,15 @@ declare module "sap/ui/unified/MenuItem" {
      */
     shortcutText?: string | PropertyBindingInfo;
 
+    /**
+     * 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}}`;
+
     /**
      * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby).
      */
@@ -19939,10 +20146,17 @@ declare module "sap/ui/unified/NonWorkingPeriod" {
 }
 
 declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
-  import Metadata from "sap/ui/base/Metadata";
+  import {
+    default as NonWorkingPeriod,
+    $NonWorkingPeriodSettings,
+  } from "sap/ui/unified/NonWorkingPeriod";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { RecurrenceType } from "sap/ui/unified/library";
 
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
   /**
    * A `RecurringNonWorkingPeriod` for use in a `PlanningCalendar` and `SinglePlanningCalendar`.
    *
@@ -19951,9 +20165,20 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
    * @since 1.127.0
    * @experimental (since 1.127.0)
    */
-  export default class RecurringNonWorkingPeriod
-    extends /* was: sap.ui.unified. */ Object
-  {
+  export default class RecurringNonWorkingPeriod extends NonWorkingPeriod {
+    /**
+     * Constructor for a new `RecurringNonWorkingPeriod`.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * Initial settings for the new control
+       */
+      mSettings?: $RecurringNonWorkingPeriodSettings
+    );
     /**
      * Constructor for a new `RecurringNonWorkingPeriod`.
      *
@@ -19969,14 +20194,14 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
       /**
        * Initial settings for the new control
        */
-      mSettings?: object
+      mSettings?: $RecurringNonWorkingPeriodSettings
     );
 
     /**
      * Creates a new subclass of class sap.ui.unified.RecurringNonWorkingPeriod with name `sClassName` and enriches
      * it with the information contained in `oClassInfo`.
      *
-     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified..extend}.
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.NonWorkingPeriod.extend}.
      *
      *
      * @returns Created class / constructor function
@@ -20002,7 +20227,7 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
      *
      * @returns Metadata object describing this class
      */
-    static getMetadata(): Metadata;
+    static getMetadata(): ElementMetadata;
     /**
      * Gets current value of property {@link #getRecurrenceEndDate recurrenceEndDate}.
      *
@@ -20091,6 +20316,35 @@ declare module "sap/ui/unified/RecurringNonWorkingPeriod" {
       sRecurrenceType: RecurrenceType | keyof typeof RecurrenceType
     ): this;
   }
+  /**
+   * Describes the settings that can be provided to the RecurringNonWorkingPeriod constructor.
+   *
+   * @experimental (since 1.127.0)
+   */
+  export interface $RecurringNonWorkingPeriodSettings
+    extends $NonWorkingPeriodSettings {
+    /**
+     * The recurrenceType determines the pattern of recurrence for a given calendar item.
+     */
+    recurrenceType?:
+      | (RecurrenceType | keyof typeof RecurrenceType)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * Determines the end date of the calendar item, as a UI5Date or JavaScript Date object. It is considered
+     * as a local date.
+     */
+    recurrenceEndDate?: object | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * The recurrencePattern is an integer value which, in combination with the recurrenceType, sets the recurrence
+     * frequency for a calendar item. For example, if the recurrenceType is set to "Daily" and the recurrencePattern
+     * is set to 1, it signifies that repetition is set for every day. If the recurrencePattern is set to 3,
+     * this would imply the calendar item is recurring once for every three days.
+     */
+    recurrencePattern?: int | PropertyBindingInfo | `{${string}}`;
+  }
 }
 
 declare module "sap/ui/unified/Shell" {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/ux3/library" {
   /**

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/ui/vk/library" {
   /**
@@ -36849,6 +36849,15 @@ declare module "sap/ui/vk/tools/TooltipTool" {
      * @returns Value of property `offsetY`
      */
     getOffsetY(): float;
+    /**
+     * Gets current value of property {@link #getTimeout timeout}.
+     *
+     * Default value is `0`.
+     *
+     *
+     * @returns Value of property `timeout`
+     */
+    getTimeout(): int;
     /**
      * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should
      * be called using this method.
@@ -36926,6 +36935,22 @@ declare module "sap/ui/vk/tools/TooltipTool" {
        */
       fOffsetY?: float
     ): this;
+    /**
+     * Sets a new value for property {@link #getTimeout timeout}.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `0`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setTimeout(
+      /**
+       * New value for property `timeout`
+       */
+      iTimeout?: int
+    ): this;
     /**
      * Sets the tooltip title
      *
@@ -36951,6 +36976,8 @@ declare module "sap/ui/vk/tools/TooltipTool" {
 
     offsetY?: float | PropertyBindingInfo | `{${string}}`;
 
+    timeout?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * This event will be fired when mouse hover occurs.
      */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/ui/vtm/library" {
   import Vtm from "sap/ui/vtm/Vtm";

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/webc/common/library" {}
 

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/webc/fiori/library" {
   /**

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ui/webc/main/library" {
   /**

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/uiext/inbox/library" {}
 

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/ushell/library" {
   /**
@@ -13533,7 +13533,8 @@ declare module "sap/ushell/ui5service/ShellUIService" {
    * also overwrite each other's settings. Nested components have to define the service in their own manifest
    * as well.
    *
-   * **Note:** The ShellUIService is intended for use by applications only and should not be used by plugins.
+   * **Note:** The ShellUIService is intended for use by the active app only. Calls from other types of components
+   * (e.g. plugins) or inactive components (e.g. from a hidden app) are ignored.
    *
    * Auto Title and Hierarchy:
    *
@@ -13641,8 +13642,8 @@ declare module "sap/ushell/ui5service/ShellUIService" {
       aRelatedApps?: AppInfo[]
     ): void;
     /**
-     * Displays the given title in the shell header. This method should not be called if the app calling the
-     * method is not currently displayed in the Fiori Launchpad.
+     * Displays the given title in the shell header. This method should not be called - and will be without
+     * effect - if the app calling the method is not currently displayed in the Fiori launchpad.
      *
      * @since 1.38.0
      */
@@ -13908,6 +13909,8 @@ declare namespace sap {
   }
 
   interface IUI5DefineDependencyNames {
+    "sap/ushell/api/BootstrapObserver": undefined;
+
     "sap/ushell/api/Copilot": undefined;
 
     "sap/ushell/api/Inbox": undefined;

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.uxap.d.ts

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

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/viz/library" {
   export namespace ui5 {

package/types/sap.webanalytics.core.d.ts

@@ -1,3 +1,3 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {}

package/types/sap.zen.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.3
+// For Library Version: 1.131.0
 
 declare module "sap/zen/commons/library" {}
 

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.3
+// For Library Version: 1.131.0
 
 declare module "sap/zen/crosstab/library" {}
 

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.3
+// For Library Version: 1.131.0
 
 declare module "sap/zen/dsh/library" {}