@openui5/types 1.126.0 → 1.127.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare module "sap/ui/unified/library" {
   /**
@@ -283,6 +283,15 @@ declare module "sap/ui/unified/library" {
      */
     Expanded = "Expanded",
   }
+  /**
+   * Interface for controls which are suitable to add as items of sap.m.Menu.
+   *
+   * @since 1.127.0
+   */
+  export interface IMenuItem {
+    __implements__sap_ui_unified_IMenuItem: boolean;
+  }
+
   /**
    * Marker interface for controls that process instances of `window.Blob`, such as `window.File`. The implementation
    * of this Interface should implement the following Interface methods:
@@ -17840,7 +17849,7 @@ declare module "sap/ui/unified/Menu" {
 
   import { IContextMenu, ID, Dock, Collision } from "sap/ui/core/library";
 
-  import MenuItemBase from "sap/ui/unified/MenuItemBase";
+  import { IMenuItem } from "sap/ui/unified/library";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
@@ -17851,6 +17860,8 @@ declare module "sap/ui/unified/Menu" {
     AggregationBindingInfo,
   } from "sap/ui/base/ManagedObject";
 
+  import MenuItemBase from "sap/ui/unified/MenuItemBase";
+
   import Event from "sap/ui/base/Event";
 
   /**
@@ -17947,7 +17958,7 @@ declare module "sap/ui/unified/Menu" {
       /**
        * The item to add; if empty, nothing is inserted
        */
-      oItem: MenuItemBase
+      oItem: IMenuItem
     ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
@@ -18075,7 +18086,7 @@ declare module "sap/ui/unified/Menu" {
      *
      * The available actions to be displayed as items of the menu.
      */
-    getItems(): MenuItemBase[];
+    getItems(): IMenuItem[];
     /**
      * Gets current value of property {@link #getMaxVisibleItems maxVisibleItems}.
      *
@@ -18108,8 +18119,18 @@ declare module "sap/ui/unified/Menu" {
      */
     getPageSize(): int;
     /**
-     * Checks for the provided `sap.ui.unified.MenuItemBase` in the aggregation {@link #getItems items}. and
-     * returns its index if found or -1 otherwise.
+     * Returns all items that have `selected` properties set to `true`. **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[];
+    /**
+     * Checks for the provided `sap.ui.unified.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
@@ -18118,7 +18139,7 @@ declare module "sap/ui/unified/Menu" {
       /**
        * The item whose index is looked for
        */
-      oItem: MenuItemBase
+      oItem: IMenuItem
     ): int;
     /**
      * Inserts a item into the aggregation {@link #getItems items}.
@@ -18130,7 +18151,7 @@ declare module "sap/ui/unified/Menu" {
       /**
        * The item to insert; if empty, nothing is inserted
        */
-      oItem: MenuItemBase,
+      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
@@ -18215,7 +18236,7 @@ declare module "sap/ui/unified/Menu" {
      *
      * @returns An array of the removed elements (might be empty)
      */
-    removeAllItems(): MenuItemBase[];
+    removeAllItems(): IMenuItem[];
     /**
      * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
      *
@@ -18239,8 +18260,8 @@ declare module "sap/ui/unified/Menu" {
       /**
        * The item to remove or its index or id
        */
-      vItem: int | string | MenuItemBase
-    ): MenuItemBase | null;
+      vItem: int | string | IMenuItem
+    ): IMenuItem | null;
     /**
      * Sets a new value for property {@link #getAriaDescription ariaDescription}.
      *
@@ -18363,11 +18384,7 @@ declare module "sap/ui/unified/Menu" {
     /**
      * The available actions to be displayed as items of the menu.
      */
-    items?:
-      | MenuItemBase[]
-      | MenuItemBase
-      | AggregationBindingInfo
-      | `{${string}}`;
+    items?: IMenuItem[] | IMenuItem | AggregationBindingInfo | `{${string}}`;
 
     /**
      * Reference to accessible labels (ids of existing DOM elements or controls) for assistive technologies
@@ -18410,6 +18427,8 @@ declare module "sap/ui/unified/MenuItem" {
     $MenuItemBaseSettings,
   } from "sap/ui/unified/MenuItemBase";
 
+  import { IMenuItem } from "sap/ui/unified/library";
+
   import { ID, URI } from "sap/ui/core/library";
 
   import Control from "sap/ui/core/Control";
@@ -18424,7 +18443,8 @@ declare module "sap/ui/unified/MenuItem" {
    *
    * @since 1.21.0
    */
-  export default class MenuItem extends MenuItemBase {
+  export default class MenuItem extends MenuItemBase implements IMenuItem {
+    __implements__sap_ui_unified_IMenuItem: boolean;
     /**
      * Constructor for a new MenuItem element.
      *
@@ -18515,6 +18535,13 @@ declare module "sap/ui/unified/MenuItem" {
      * @returns Value of property `icon`
      */
     getIcon(): URI;
+    /**
+     * @since 1.127.0
+     *
+     * @returns Returns `true` if the `MenuItem` is selected and is part of group with single or multi selection
+     * mode, `false` otherwise.
+     */
+    getSelected(): boolean;
     /**
      * Gets current value of property {@link #getShortcutText shortcutText}.
      *
@@ -18578,6 +18605,20 @@ declare module "sap/ui/unified/MenuItem" {
        */
       sIcon?: URI
     ): this;
+    /**
+     * Sets the `selected` state of the `MenuItem` and deselect other selected `MenuItem` controls if selection
+     * mode is `SingleSelect`.
+     *
+     * @since 1.127.0
+     *
+     * @returns Returns `this` to allow method chaining
+     */
+    setSelected(
+      /**
+       * Whether the state is selected or not
+       */
+      bState: boolean
+    ): this;
     /**
      * Sets a new value for property {@link #getShortcutText shortcutText}.
      *
@@ -18633,6 +18674,16 @@ declare module "sap/ui/unified/MenuItem" {
      */
     icon?: URI | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the `MenuItem` is selected (default is set to `false`). 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
@@ -19041,12 +19092,240 @@ declare module "sap/ui/unified/MenuItemBase" {
   >;
 }
 
+declare module "sap/ui/unified/MenuItemGroup" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import { IMenuItem } from "sap/ui/unified/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. A menu items group 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_ui_unified_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.ui.unified.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.ui.unified.MenuItemGroup.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Override of the default setter that adds a group reference to the item's `group` association.
+     *
+     *
+     * @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.ui.unified.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;
+    /**
+     * Override of the default setter that adds a group reference to the item's `group` association.
+     *
+     *
+     * @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/ui/unified/MenuTextFieldItem" {
   import {
     default as MenuItemBase,
     $MenuItemBaseSettings,
   } from "sap/ui/unified/MenuItemBase";
 
+  import { IMenuItem } from "sap/ui/unified/library";
+
   import { URI, ValueState } from "sap/ui/core/library";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -19062,7 +19341,11 @@ declare module "sap/ui/unified/MenuTextFieldItem" {
    *
    * @since 1.21.0
    */
-  export default class MenuTextFieldItem extends MenuItemBase {
+  export default class MenuTextFieldItem
+    extends MenuItemBase
+    implements IMenuItem
+  {
+    __implements__sap_ui_unified_IMenuItem: boolean;
     /**
      * Constructor for a new MenuTextFieldItem element.
      *
@@ -22022,6 +22305,8 @@ declare namespace sap {
 
     "sap/ui/unified/MenuItemBase": undefined;
 
+    "sap/ui/unified/MenuItemGroup": undefined;
+
     "sap/ui/unified/MenuTextFieldItem": undefined;
 
     "sap/ui/unified/Shell": undefined;

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

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

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

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

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

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

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

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

package/types/sap.uxap.d.ts

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