@sapui5/ts-types 1.126.2 → 1.127.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {
@@ -5737,6 +5737,15 @@ declare namespace sap {
           YearPicker
         >;
       }
+      /**
+       * Interface for controls which are suitable to add as items of sap.m.Menu.
+       *
+       * @since 1.127.0
+       */
+      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:
@@ -7605,8 +7614,8 @@ declare namespace sap {
          * The available actions to be displayed as items of the menu.
          */
         items?:
-          | sap.ui.unified.MenuItemBase[]
-          | sap.ui.unified.MenuItemBase
+          | sap.ui.unified.IMenuItem[]
+          | sap.ui.unified.IMenuItem
           | sap.ui.base.ManagedObject.AggregationBindingInfo
           | `{${string}}`;
 
@@ -7644,6 +7653,19 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.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
+          | sap.ui.base.ManagedObject.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
@@ -7701,6 +7723,29 @@ declare namespace sap {
         select?: (oEvent: MenuItemBase$SelectEvent) => void;
       }
 
+      /**
+       * Describes the settings that can be provided to the MenuItemGroup constructor.
+       */
+      interface $MenuItemGroupSettings extends sap.ui.core.$ElementSettings {
+        /**
+         * Defines the selection mode of the child items (e.g. `None`, `SingleSelect`, `MultiSelect`)
+         */
+        itemSelectionMode?:
+          | sap.ui.core.ItemSelectionMode
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * The available items of the menu. **Note:** Adding MenuItemGroup as an item to the MenuItemGroup is not
+         * supported.
+         */
+        items?:
+          | sap.ui.unified.IMenuItem[]
+          | sap.ui.unified.IMenuItem
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
+      }
+
       /**
        * Describes the settings that can be provided to the MenuTextFieldItem constructor.
        */
@@ -17922,7 +17967,7 @@ declare namespace sap {
           /**
            * The item to add; if empty, nothing is inserted
            */
-          oItem: sap.ui.unified.MenuItemBase
+          oItem: sap.ui.unified.IMenuItem
         ): this;
         /**
          * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.ui.unified.Menu`.
@@ -18050,7 +18095,7 @@ declare namespace sap {
          *
          * The available actions to be displayed as items of the menu.
          */
-        getItems(): sap.ui.unified.MenuItemBase[];
+        getItems(): sap.ui.unified.IMenuItem[];
         /**
          * Gets current value of property {@link #getMaxVisibleItems maxVisibleItems}.
          *
@@ -18083,8 +18128,18 @@ declare namespace sap {
          */
         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
@@ -18093,7 +18148,7 @@ declare namespace sap {
           /**
            * The item whose index is looked for
            */
-          oItem: sap.ui.unified.MenuItemBase
+          oItem: sap.ui.unified.IMenuItem
         ): int;
         /**
          * Inserts a item into the aggregation {@link #getItems items}.
@@ -18105,7 +18160,7 @@ declare namespace sap {
           /**
            * The item to insert; if empty, nothing is inserted
            */
-          oItem: sap.ui.unified.MenuItemBase,
+          oItem: sap.ui.unified.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
@@ -18190,7 +18245,7 @@ declare namespace sap {
          *
          * @returns An array of the removed elements (might be empty)
          */
-        removeAllItems(): sap.ui.unified.MenuItemBase[];
+        removeAllItems(): sap.ui.unified.IMenuItem[];
         /**
          * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
          *
@@ -18214,8 +18269,8 @@ declare namespace sap {
           /**
            * The item to remove or its index or id
            */
-          vItem: int | string | sap.ui.unified.MenuItemBase
-        ): sap.ui.unified.MenuItemBase | null;
+          vItem: int | string | sap.ui.unified.IMenuItem
+        ): sap.ui.unified.IMenuItem | null;
         /**
          * Sets a new value for property {@link #getAriaDescription ariaDescription}.
          *
@@ -18304,7 +18359,11 @@ declare namespace sap {
        *
        * @since 1.21.0
        */
-      class MenuItem extends sap.ui.unified.MenuItemBase {
+      class MenuItem
+        extends sap.ui.unified.MenuItemBase
+        implements sap.ui.unified.IMenuItem
+      {
+        __implements__sap_ui_unified_IMenuItem: boolean;
         /**
          * Constructor for a new MenuItem element.
          *
@@ -18395,6 +18454,13 @@ declare namespace sap {
          * @returns Value of property `icon`
          */
         getIcon(): sap.ui.core.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}.
          *
@@ -18458,6 +18524,20 @@ declare namespace sap {
            */
           sIcon?: sap.ui.core.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}.
          *
@@ -18825,6 +18905,204 @@ declare namespace sap {
           bVisible?: boolean
         ): this;
       }
+      /**
+       * 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
+       */
+      class MenuItemGroup
+        extends sap.ui.core.Element
+        implements sap.ui.unified.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?: sap.ui.unified.$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?: sap.ui.unified.$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, sap.ui.unified.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(): sap.ui.core.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: sap.ui.unified.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(): sap.ui.unified.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(): sap.ui.core.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: sap.ui.unified.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: sap.ui.unified.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 | sap.ui.unified.IMenuItem,
+          /**
+           * Whether to suppress the invalidation of the control
+           */
+          bSuppressInvalidate: boolean
+        ): sap.ui.unified.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;
+      }
       /**
        * Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter
        * implementations. The aggregation `submenu` (inherited from parent class) is not supported for this type
@@ -18832,7 +19110,11 @@ declare namespace sap {
        *
        * @since 1.21.0
        */
-      class MenuTextFieldItem extends sap.ui.unified.MenuItemBase {
+      class MenuTextFieldItem
+        extends sap.ui.unified.MenuItemBase
+        implements sap.ui.unified.IMenuItem
+      {
+        __implements__sap_ui_unified_IMenuItem: boolean;
         /**
          * Constructor for a new MenuTextFieldItem element.
          *
@@ -21952,6 +22234,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/{ux3-1.126.0-d.ts → sap.ui.ux3.d.ts}

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {
@@ -4054,7 +4054,7 @@ declare namespace sap {
            * New value for property `tooltip`. NOTE: in sap.ui.vtm.Column you can ONLY use a string, not a TooltipBase,
            * even though the API formally allows it for TypeScript compatibility reasons.
            */
-          sTooltip: string | sap.ui.core.TooltipBase
+          vTooltip: string | sap.ui.core.TooltipBase
         ): this;
         /**
          * Sets a new value for property {@link #getTooltipFormatter tooltipFormatter}.

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace ui {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace uiext {

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.1
 
 declare namespace sap {
   /**
@@ -662,6 +662,9 @@ declare namespace sap {
           /**
            * Creates an item in the side pane.
            *
+           * The `controlType` can be any control and is by default a {@link sap.m.Button}. The `controlProperties`
+           * are passed to the constructor of the control.
+           *
            * @since 1.124.0
            *
            * @returns The newly created item.
@@ -676,7 +679,7 @@ declare namespace sap {
              */
             parameters?: {
               /**
-               * Defines the `controlType`.
+               * Defines the `controlType` of the item.
                */
               controlType?: string;
             }
@@ -732,6 +735,8 @@ declare namespace sap {
 
           /**
            * Creates an item in the tool area.
+           * See:
+           * 	sap.ushell.ui.shell.ToolAreaItem
            *
            * @since 1.124.0
            *
@@ -739,7 +744,7 @@ declare namespace sap {
            */
           createItem(
             /**
-             * The properties that will be passed to the created control.
+             * The properties that will be passed to the {@link sap.ushell.ui.shell.ToolAreaItem}.
              */
             controlProperties: object
           ): Promise<sap.ushell.services.FrameBoundExtension.Item>;
@@ -4616,6 +4621,8 @@ declare namespace sap {
         ): Promise<sap.ushell.services.Extension.Item>;
         /**
          * Creates a user action in the user action menu.
+         *  The `controlType` can be any control and is by default a {@link sap.ushell.ui.launchpad.ActionItem}.
+         * The `controlProperties` are passed to the constructor of the control.
          *  **Restrictions:**
          * 	 - The control properties are only allowed to contain primitive properties and event handlers. Aggregations,
          *     controls and types with prototypes are not allowed!
@@ -4635,7 +4642,7 @@ declare namespace sap {
            */
           parameters?: {
             /**
-             * Defines the `controlType`.
+             * Defines the `controlType` of the item.
              */
             controlType?: string;
           }
@@ -4713,6 +4720,9 @@ declare namespace sap {
         /**
          * Creates a new footer which is positioned below the launchpad content.
          *
+         * The `controlType` can be any control and is by default a {@link sap.m.Bar}. The `controlProperties` are
+         * passed to the constructor of the control.
+         *
          * **Note:** Only one footer is displayed at once. Any new footer will replace the previous one **Restriction:**
          * NOT available for apps running in an iframe
          *
@@ -4760,6 +4770,9 @@ declare namespace sap {
         /**
          * Creates a new sub header which is positioned below the header.
          *
+         * The `controlType` can be any control and is by default a {@link sap.m.Bar}. The `controlProperties` are
+         * passed to the constructor of the control.
+         *
          * **Note:** Only one sub header is displayed at once **Restriction:** NOT available for apps
          * running in an iframe
          *
@@ -4785,6 +4798,9 @@ declare namespace sap {
         /**
          * Creates a user action in the user action menu.
          *
+         * The `controlType` can be any control and is by default a {@link sap.ushell.ui.launchpad.ActionItem}.
+         * The `controlProperties` are passed to the constructor of the control.
+         *
          * @since 1.124.0
          *
          * @returns The newly created user action.
@@ -4799,7 +4815,7 @@ declare namespace sap {
            */
           parameters?: {
             /**
-             * Defines the `controlType`.
+             * Defines the `controlType` of the item.
              */
             controlType?: string;
           }

package/types/sap.ushell_abap.d.ts

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

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.1
+// For Library Version: 1.127.0
 
 declare namespace sap {
   /**

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace zen {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace zen {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   namespace zen {