@openui5/types 1.126.1 → 1.127.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/types",
-  "version": "1.126.1",
+  "version": "1.127.1",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://sap.github.io/ui5-typescript",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.1
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -1030,8 +1030,6 @@ declare module "sap/f/AvatarGroupItem" {
    * rendering each `AvatarGroupItem` instance in the {@link sap.f.AvatarGroup} control.
    *
    * @since 1.73
-   * @experimental (since 1.73) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export default class AvatarGroupItem extends Control {
     /**
@@ -1189,9 +1187,6 @@ declare module "sap/f/AvatarGroupItem" {
   }
   /**
    * Describes the settings that can be provided to the AvatarGroupItem constructor.
-   *
-   * @experimental (since 1.73) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export interface $AvatarGroupItemSettings extends $ControlSettings {
     /**
@@ -12863,8 +12858,6 @@ declare module "sap/f/ProductSwitch" {
    * A layout control that provides specific configuration about how the items should be displayed.
    *
    * @since 1.72
-   * @experimental (since 1.72) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export default class ProductSwitch extends Control {
     /**
@@ -13106,9 +13099,6 @@ declare module "sap/f/ProductSwitch" {
   }
   /**
    * Describes the settings that can be provided to the ProductSwitch constructor.
-   *
-   * @experimental (since 1.72) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export interface $ProductSwitchSettings extends $ControlSettings {
     /**
@@ -13165,8 +13155,6 @@ declare module "sap/f/ProductSwitchItem" {
    * **Note:** `ProductSwitchItem` is not supported when used outside of `ProductSwitch`.
    *
    * @since 1.72
-   * @experimental (since 1.72) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export default class ProductSwitchItem extends Control {
     /**
@@ -13373,9 +13361,6 @@ declare module "sap/f/ProductSwitchItem" {
   }
   /**
    * Describes the settings that can be provided to the ProductSwitchItem constructor.
-   *
-   * @experimental (since 1.72) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    */
   export interface $ProductSwitchItemSettings extends $ControlSettings {
     /**

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.1
 
 declare module "sap/f/library" {
   export interface IShellBar {
@@ -1300,6 +1300,15 @@ declare module "sap/m/library" {
      */
     InlineSvg = "InlineSvg",
   }
+  /**
+   * Interface for controls which are suitable to be added as items of sap.m.Menu.
+   *
+   * @since 1.127.0
+   */
+  export interface IMenuItem {
+    __implements__sap_m_IMenuItem: boolean;
+  }
+
   /**
    * The object contains accessibility state for a control.
    *
@@ -1975,9 +1984,12 @@ declare module "sap/m/library" {
    */
   export type OverflowToolbarConfig = {
     /**
-     * A boolean that tells whether the control can move to the overflow menu or not. **Note:** Even if `canOverflow`
-     * is set to `false`, the `propsUnrelatedToSize` field is taken into account, allowing to optimize the behavior
-     * of controls that do not need to overflow, but are used in an `sap.m.OverflowToolbar` regardless.
+     * A boolean that tells whether the control can move to the overflow menu or not. **Notes:**
+     * 	 - Even if `canOverflow` is set to `false`, the `propsUnrelatedToSize` field is taken into account,
+     *     allowing to optimize the behavior of controls that do not need to overflow, but are used in an `sap.m.OverflowToolbar`
+     *     regardless.
+     * 	 - If `canOverflow` is not provided, its default value is `false`. In this case, the control is shown
+     *     in the content of the `sap.m.OverflowToolbar` but it's not possible to enter the overflow area.
      */
     canOverflow?: boolean;
     /**
@@ -9006,7 +9018,6 @@ declare module "sap/m/Breadcrumbs" {
      * Determines the text of current/last element in the Breadcrumbs path.
      *
      * @since 1.34
-     * @deprecated (since 1.123) - Use the **currentLocation** aggregation instead.
      *
      * @returns Value of property `currentLocationText`
      */
@@ -9133,7 +9144,6 @@ declare module "sap/m/Breadcrumbs" {
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * @since 1.34
-     * @deprecated (since 1.123) - Use the **currentLocation** aggregation instead.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -9164,7 +9174,6 @@ declare module "sap/m/Breadcrumbs" {
      * Determines the text of current/last element in the Breadcrumbs path.
      *
      * @since 1.34
-     * @deprecated (since 1.123) - Use the **currentLocation** aggregation instead.
      */
     currentLocationText?: string | PropertyBindingInfo;
 
@@ -44104,6 +44113,11 @@ declare module "sap/m/Input" {
      * been pressed.
      */
     fromSuggestions?: boolean;
+
+    /**
+     * The event parameter is set to true, when the event is fired after keyboard interaction, otherwise false.
+     */
+    fromKeyboard?: boolean;
   }
 
   /**
@@ -53288,7 +53302,7 @@ declare module "sap/m/Menu" {
 
   import { IContextMenu, Dock } from "sap/ui/core/library";
 
-  import MenuItem from "sap/m/MenuItem";
+  import { IMenuItem } from "sap/m/library";
 
   import Event from "sap/ui/base/Event";
 
@@ -53301,6 +53315,8 @@ declare module "sap/m/Menu" {
 
   import UI5Element from "sap/ui/core/Element";
 
+  import MenuItem from "sap/m/MenuItem";
+
   /**
    * The `sap.m.Menu` control represents a hierarchical menu. When opened on mobile devices it occupies the
    * whole screen.
@@ -53384,7 +53400,7 @@ declare module "sap/m/Menu" {
       /**
        * The item to add; if empty, nothing is inserted
        */
-      oItem: MenuItem
+      oItem: IMenuItem
     ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.m.Menu`.
@@ -53573,7 +53589,17 @@ declare module "sap/m/Menu" {
      *
      * Defines the items contained within this control.
      */
-    getItems(): MenuItem[];
+    getItems(): IMenuItem[];
+    /**
+     * Returns an array containing the selected menu items. **Note:** Only items with `selected` property set
+     * that are members of `MenuItemGroup` with `ItemSelectionMode` property set to {@link sap.ui.core.ItemSelectionMode.SingleSelect }
+     * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}> are taken into account.
+     *
+     * @since 1.127.0
+     *
+     * @returns Array of all selected items
+     */
+    getSelectedItems(): any[];
     /**
      * Gets current value of property {@link #getTitle title}.
      *
@@ -53584,7 +53610,7 @@ declare module "sap/m/Menu" {
      */
     getTitle(): string;
     /**
-     * Checks for the provided `sap.m.MenuItem` in the aggregation {@link #getItems items}. and returns its
+     * Checks for the provided `sap.m.IMenuItem` in the aggregation {@link #getItems items}. and returns its
      * index if found or -1 otherwise.
      *
      *
@@ -53594,7 +53620,7 @@ declare module "sap/m/Menu" {
       /**
        * The item whose index is looked for
        */
-      oItem: MenuItem
+      oItem: IMenuItem
     ): int;
     /**
      * Initializes the control.
@@ -53610,7 +53636,7 @@ declare module "sap/m/Menu" {
       /**
        * The item to insert; if empty, nothing is inserted
        */
-      oItem: MenuItem,
+      oItem: IMenuItem,
       /**
        * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
        * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
@@ -53674,7 +53700,7 @@ declare module "sap/m/Menu" {
      *
      * @returns An array of the removed elements (might be empty)
      */
-    removeAllItems(): MenuItem[];
+    removeAllItems(): IMenuItem[];
     /**
      * Removes a item from the aggregation {@link #getItems items}.
      *
@@ -53685,8 +53711,8 @@ declare module "sap/m/Menu" {
       /**
        * The item to remove or its index or id
        */
-      vItem: int | string | MenuItem
-    ): MenuItem | null;
+      vItem: int | string | IMenuItem
+    ): IMenuItem | null;
     /**
      * Sets the title of the `Menu`.
      *
@@ -53719,7 +53745,7 @@ declare module "sap/m/Menu" {
     /**
      * Defines the items contained within this control.
      */
-    items?: MenuItem[] | MenuItem | AggregationBindingInfo | `{${string}}`;
+    items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
 
     /**
      * Fired when a `MenuItem` is selected.
@@ -54636,6 +54662,8 @@ declare module "sap/m/MenuButton" {
 declare module "sap/m/MenuItem" {
   import { default as Item, $ItemSettings } from "sap/ui/core/Item";
 
+  import { IMenuItem } from "sap/m/library";
+
   import Event from "sap/ui/base/Event";
 
   import {
@@ -54650,7 +54678,8 @@ declare module "sap/m/MenuItem" {
    *
    * @since 1.38
    */
-  export default class MenuItem extends Item {
+  export default class MenuItem extends Item implements IMenuItem {
+    __implements__sap_m_IMenuItem: boolean;
     /**
      * Constructor for a new `MenuItem`.
      *
@@ -54723,7 +54752,7 @@ declare module "sap/m/MenuItem" {
       /**
        * The item to add; if empty, nothing is inserted
        */
-      oItem: MenuItem
+      oItem: IMenuItem
     ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:aggregationChanged aggregationChanged} event
@@ -55001,14 +55030,26 @@ declare module "sap/m/MenuItem" {
      *
      * Defines the sub-items contained within this element.
      */
-    getItems(): MenuItem[];
+    getItems(): IMenuItem[];
+    /**
+     * Gets current value of property {@link #getSelected selected}.
+     *
+     * Determines whether the `MenuItem` is selected. A selected `MenuItem` has a check mark rendered at its
+     * end. **Note: ** selection functionality works only if the menu item is a member of `MenuItemGroup` with
+     * `itemSelectionMode` set to {@link sap.ui.core.ItemSelectionMode.SingleSelect} or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}.
+     *
+     * Default value is `false`.
+     *
+     * @since 1.127.0
+     *
+     * @returns Value of property `selected`
+     */
+    getSelected(): boolean;
     /**
      * Gets current value of property {@link #getShortcutText shortcutText}.
      *
      * Defines the shortcut text that should be displayed on the menu item on non-mobile devices. **Note:**
-     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute. There is no built-in
-     * functionality that selects the item when the corresponding shortcut is pressed. This should be implemented
-     * by the application developer.
+     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute.
      *
      * Default value is `empty string`.
      *
@@ -55041,7 +55082,7 @@ declare module "sap/m/MenuItem" {
      */
     getVisible(): boolean;
     /**
-     * Checks for the provided `sap.m.MenuItem` in the aggregation {@link #getItems items}. and returns its
+     * Checks for the provided `sap.m.IMenuItem` in the aggregation {@link #getItems items}. and returns its
      * index if found or -1 otherwise.
      *
      *
@@ -55051,7 +55092,7 @@ declare module "sap/m/MenuItem" {
       /**
        * The item whose index is looked for
        */
-      oItem: MenuItem
+      oItem: IMenuItem
     ): int;
     /**
      * Inserts a item into the aggregation {@link #getItems items}.
@@ -55063,7 +55104,7 @@ declare module "sap/m/MenuItem" {
       /**
        * The item to insert; if empty, nothing is inserted
        */
-      oItem: MenuItem,
+      oItem: IMenuItem,
       /**
        * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
        * at position 0; for a value greater than the current size of the aggregation, the item is inserted at
@@ -55079,7 +55120,7 @@ declare module "sap/m/MenuItem" {
      *
      * @returns An array of the removed elements (might be empty)
      */
-    removeAllItems(): MenuItem[];
+    removeAllItems(): IMenuItem[];
     /**
      * Removes a item from the aggregation {@link #getItems items}.
      *
@@ -55090,8 +55131,8 @@ declare module "sap/m/MenuItem" {
       /**
        * The item to remove or its index or id
        */
-      vItem: int | string | MenuItem
-    ): MenuItem | null;
+      vItem: int | string | IMenuItem
+    ): IMenuItem | null;
     /**
      * Sets a new value for property {@link #getIcon icon}.
      *
@@ -55112,9 +55153,7 @@ declare module "sap/m/MenuItem" {
      * Sets a new value for property {@link #getShortcutText shortcutText}.
      *
      * Defines the shortcut text that should be displayed on the menu item on non-mobile devices. **Note:**
-     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute. There is no built-in
-     * functionality that selects the item when the corresponding shortcut is pressed. This should be implemented
-     * by the application developer.
+     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -55190,11 +55229,18 @@ declare module "sap/m/MenuItem" {
      */
     visible?: boolean | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the `MenuItem` is selected. A selected `MenuItem` has a check mark rendered at its
+     * end. **Note: ** selection functionality works only if the menu item is a member of `MenuItemGroup` with
+     * `itemSelectionMode` set to {@link sap.ui.core.ItemSelectionMode.SingleSelect} or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}.
+     *
+     * @since 1.127.0
+     */
+    selected?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the shortcut text that should be displayed on the menu item on non-mobile devices. **Note:**
-     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute. There is no built-in
-     * functionality that selects the item when the corresponding shortcut is pressed. This should be implemented
-     * by the application developer.
+     * The text is only displayed and set as а value of the `aria-keyshortcuts` attribute.
      */
     shortcutText?: string | PropertyBindingInfo;
 
@@ -55207,7 +55253,7 @@ declare module "sap/m/MenuItem" {
     /**
      * Defines the sub-items contained within this element.
      */
-    items?: MenuItem[] | MenuItem | AggregationBindingInfo | `{${string}}`;
+    items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
 
     /**
      * Fired after the item has been pressed.
@@ -55290,6 +55336,232 @@ declare module "sap/m/MenuItem" {
   >;
 }
 
+declare module "sap/m/MenuItemGroup" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import { IMenuItem } from "sap/m/library";
+
+  import { ItemSelectionMode } from "sap/ui/core/library";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Group item to be used inside a menu. Represents a collection of menu items that can have the same selection
+   * mode (e.g. {@link sap.ui.core.ItemSelectionMode.None}, {@link sap.ui.core.ItemSelectionMode.SingleSelect},
+   * or {@link sap.ui.unified.ItemSelectionMode.MultiSelect}).
+   *
+   * @since 1.127.0
+   */
+  export default class MenuItemGroup extends UI5Element implements IMenuItem {
+    __implements__sap_m_IMenuItem: boolean;
+    /**
+     * Constructor for a new MenuItemGroup element.
+     *
+     * 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?: $MenuItemGroupSettings
+    );
+    /**
+     * Constructor for a new MenuItemGroup element.
+     *
+     * 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(
+      /**
+       * ID for the new control, generated automatically if no ID is given
+       */
+      sId?: string,
+      /**
+       * Initial settings for the new control
+       */
+      mSettings?: $MenuItemGroupSettings
+    );
+
+    /**
+     * Creates a new subclass of class sap.m.MenuItemGroup 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.core.Element.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, MenuItemGroup>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.m.MenuItemGroup.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Adds an item to `items` aggregation.
+     *
+     *
+     * @returns `this` to allow method chaining
+     */
+    addItem(
+      /**
+       * Menu item to be added
+       */
+      oItem: IMenuItem,
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): this;
+    /**
+     * Destroys all items from `items` aggregation.
+     *
+     *
+     * @returns `this` to allow method chaining
+     */
+    destroyItems(
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): this;
+    /**
+     * Gets content of aggregation {@link #getItems items}.
+     *
+     * The available items of the menu. **Note:** Adding MenuItemGroup as an item to the MenuItemGroup is not
+     * supported.
+     */
+    getItems(): IMenuItem[];
+    /**
+     * Gets current value of property {@link #getItemSelectionMode itemSelectionMode}.
+     *
+     * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
+     *
+     * Default value is `None`.
+     *
+     *
+     * @returns Value of property `itemSelectionMode`
+     */
+    getItemSelectionMode(): ItemSelectionMode;
+    /**
+     * Checks for the provided `sap.m.IMenuItem` in the aggregation {@link #getItems items}. and returns its
+     * index if found or -1 otherwise.
+     *
+     *
+     * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+     */
+    indexOfItem(
+      /**
+       * The item whose index is looked for
+       */
+      oItem: IMenuItem
+    ): int;
+    /**
+     * Inserts an item to the specified position in `items` aggregation.
+     *
+     *
+     * @returns `this` to allow method chaining
+     */
+    insertItem(
+      /**
+       * Menu item to be added
+       */
+      oItem: IMenuItem,
+      /**
+       * Index at which the item should be inserted
+       */
+      iIndex: int,
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): this;
+    /**
+     * Removes all items from `items` aggregation.
+     *
+     *
+     * @returns array containing the removed items, or `null` if there are no items to remove
+     */
+    removeAllItems(
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): any[] | null;
+    /**
+     * Removes an item from `items` aggregation.
+     *
+     *
+     * @returns the removed object, or `null` if there are no items to remove
+     */
+    removeItem(
+      /**
+       * Menu item to be removed (as index, ID or object)
+       */
+      vItem: int | string | IMenuItem,
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): IMenuItem | null;
+    /**
+     * Override of the default setter that also ensures single selection if necessary.
+     *
+     *
+     * @returns `this` to allow method chaining
+     */
+    setItemSelectionMode(
+      /**
+       * item selection mode to be set
+       */
+      sSelectionMode: string,
+      /**
+       * Whether to suppress the invalidation of the control
+       */
+      bSuppressInvalidate: boolean
+    ): this;
+  }
+  /**
+   * Describes the settings that can be provided to the MenuItemGroup constructor.
+   */
+  export interface $MenuItemGroupSettings extends $ElementSettings {
+    /**
+     * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
+     */
+    itemSelectionMode?: ItemSelectionMode | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * The available items of the menu. **Note:** Adding MenuItemGroup as an item to the MenuItemGroup is not
+     * supported.
+     */
+    items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/m/MessageBox" {
   import { TextDirection, CSSSize } from "sap/ui/core/library";
 
@@ -157854,7 +158126,7 @@ declare module "sap/m/upload/UploadSet" {
      * Required for receiving a `readyState` is to set the property `sendXHR` to true. This property is not
      * supported by Internet Explorer 9.
      */
-    readyState?: string;
+    readyState?: int;
 
     /**
      * Status of the XHR request.
@@ -157862,7 +158134,7 @@ declare module "sap/m/upload/UploadSet" {
      * Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported
      * by Internet Explorer 9.
      */
-    status?: string;
+    status?: int;
 
     /**
      * Http-Response which comes from the server.
@@ -171051,6 +171323,8 @@ declare namespace sap {
 
     "sap/m/MenuItem": undefined;
 
+    "sap/m/MenuItemGroup": undefined;
+
     "sap/m/MessageBox": undefined;
 
     "sap/m/MessageItem": undefined;

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.1
 
 declare module "sap/tnt/library" {
   /**