@openui5/ts-types 1.108.2 → 1.110.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.108.2",
+  "version": "1.110.0",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * OpenUI5
-* Copyright 2009-2022 SAP SE or an SAP affiliate company.
+* Copyright 2009-2023 SAP SE or an SAP affiliate company.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.2
+// For Library Version: 1.110.0
 
 declare namespace sap {
   /**
@@ -179,6 +179,16 @@ declare namespace sap {
          */
         number?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * @SINCE 1.109
+         *
+         * Whether the main numeric indicator is visible or not
+         */
+        numberVisible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Defines the unit of measurement (scaling prefix) for the main indicator. Financial characters can be
          * used for currencies and counters. The International System of Units (SI) prefixes can be used. If the
@@ -538,7 +548,11 @@ declare namespace sap {
           /**
            * The mapping of "aria-" prefixed attributes
            */
-          mAriaProps: object
+          mAriaProps: {
+            role: string;
+
+            level: string;
+          }
         ): void;
         /**
          * Fires event {@link #event:press press} to attached listeners.
@@ -1038,7 +1052,11 @@ declare namespace sap {
           /**
            * The mapping of "aria-" prefixed attributes
            */
-          mAriaProps: object
+          mAriaProps: {
+            role: string;
+
+            level: string;
+          }
         ): void;
         /**
          * Fires event {@link #event:press press} to attached listeners.
@@ -1080,6 +1098,18 @@ declare namespace sap {
          * @returns Value of property `number`
          */
         getNumber(): string;
+        /**
+         * @SINCE 1.109
+         *
+         * Gets current value of property {@link #getNumberVisible numberVisible}.
+         *
+         * Whether the main numeric indicator is visible or not
+         *
+         * Default value is `true`.
+         *
+         * @returns Value of property `numberVisible`
+         */
+        getNumberVisible(): boolean;
         /**
          * Gets current value of property {@link #getScale scale}.
          *
@@ -1286,6 +1316,25 @@ declare namespace sap {
            */
           sNumber: string
         ): this;
+        /**
+         * @SINCE 1.109
+         *
+         * Sets a new value for property {@link #getNumberVisible numberVisible}.
+         *
+         * Whether the main numeric indicator is visible or not
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setNumberVisible(
+          /**
+           * New value for property `numberVisible`
+           */
+          bNumberVisible?: boolean
+        ): this;
         /**
          * Sets a new value for property {@link #getScale scale}.
          *
@@ -1671,10 +1720,10 @@ declare namespace sap {
          *
          * If not specified or if the function returns `null`, the indicator size will be calculated automatically.
          *
-         * This callback will be called when the indicator is displayed, that happens during the drag over movement.
+         * This callback will be called when the indicator is displayed, which happens during the drag over movement.
          *
-         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: ,
-         * columns: }` or `null`.
+         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: int, columns:
+         * int}` or `null`.
          */
         dropIndicatorSize?:
           | Function
@@ -1767,36 +1816,41 @@ declare namespace sap {
          * Gets current value of property {@link #getDropIndicatorSize dropIndicatorSize}.
          *
          * A function which will define the desired drop indicator size. The drop indicator shows the user how the
-         * grid will rearrange after drop.
-         *
-         * Use when custom size needs to be defined. For example when an item is dragged from outside a grid and
-         * is dropped over the grid.
+         * grid will rearrange after drop. Use when custom size needs to be defined. For example, when an item is
+         * dragged from outside a grid and is dropped over the grid.
          *
          * If not specified or if the function returns `null`, the indicator size will be calculated automatically.
          *
-         * This callback will be called when the indicator is displayed, that happens during the drag over movement.
+         * This callback will be called when the indicator is displayed, which happens during the drag over movement.
          *
-         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: ,
-         * columns: }` or `null`.
+         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: int, columns:
+         * int}` or `null`.
          *
          * @returns Value of property `dropIndicatorSize`
          */
-        getDropIndicatorSize(): Function;
+        getDropIndicatorSize():
+          | ((
+              p1: sap.ui.core.Control
+            ) => {
+              rows: int;
+
+              columns: int;
+            })
+          | null
+          | undefined;
         /**
-         * Sets a new value for property {@link #getDropIndicatorSize dropIndicatorSize}.
+         * Sets a new value for property {@link #setDropIndicatorSize dropIndicatorSize}.
          *
          * A function which will define the desired drop indicator size. The drop indicator shows the user how the
-         * grid will rearrange after drop.
-         *
-         * Use when custom size needs to be defined. For example when an item is dragged from outside a grid and
-         * is dropped over the grid.
+         * grid will rearrange after drop. Use when custom size needs to be defined. For example when an item is
+         * dragged from outside a grid and is dropped over the grid.
          *
          * If not specified or if the function returns `null`, the indicator size will be calculated automatically.
          *
-         * This callback will be called when the indicator is displayed, that happens during the drag over movement.
+         * This callback will be called when the indicator is displayed, which happens during the drag over movement.
          *
-         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: ,
-         * columns: }` or `null`.
+         * The callback receives `draggedControl` as parameter and must return an object of type `{rows: int, columns:
+         * int}` or `null`.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
@@ -1806,7 +1860,15 @@ declare namespace sap {
           /**
            * New value for property `dropIndicatorSize`
            */
-          fnDropIndicatorSize: Function
+          fnDropIndicatorSize?:
+            | ((
+                p1: sap.ui.core.Control
+              ) => {
+                rows: int;
+
+                columns: int;
+              })
+            | null
         ): this;
       }
     }
@@ -8338,6 +8400,15 @@ declare namespace sap {
        */
       ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+      /**
+       * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+       * desktop or tablet devices.
+       */
+      sidePanelResizable?:
+        | boolean
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
        * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
@@ -8348,6 +8419,54 @@ declare namespace sap {
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
 
+      /**
+       * @SINCE 1.109.0
+       *
+       * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
+       */
+      sidePanelMinWidth?:
+        | sap.ui.core.CSSSize
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * @SINCE 1.109.0
+       *
+       * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
+       */
+      sidePanelMaxWidth?:
+        | sap.ui.core.CSSSize
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * @SINCE 1.109.0
+       *
+       * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+       * is focused.
+       */
+      sidePanelResizeStep?:
+        | int
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * @SINCE 1.109.0
+       *
+       * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+       * the resize splitter is focused.
+       */
+      sidePanelResizeLargerStep?:
+        | int
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
       /**
        * The list of controls for the main content.
        */
@@ -11471,7 +11590,7 @@ declare namespace sap {
     /**
      * @SINCE 1.46
      *
-     * Implements the master-detail-detail paradigm by displaying up to three pages in separate columns.
+     * Implements the list-detail-detail paradigm by displaying up to three pages in separate columns.
      *
      * Overview:
      *
@@ -13859,10 +13978,10 @@ declare namespace sap {
      * them should lead.
      *
      * Calling `getNextUIState(2)` will return information about the expected layout and action buttons if the
-     * application should display three views (master-detail-detail), based on the current state.
+     * application should display three views (list-detail-detail), based on the current state.
      *
      * Similarly, calling `getNextUIState(0)` will return information about the expected layout and action buttons
-     * if the application should display the initial view only (master), based on the current state.
+     * if the application should display the initial view only (list), based on the current state.
      *
      * For more information, see {@link sap.f.FlexibleColumnLayoutSemanticHelper#getCurrentUIState} and {@link
      * sap.f.FlexibleColumnLayoutSemanticHelper#getNextUIState}
@@ -13978,7 +14097,7 @@ declare namespace sap {
        */
       getNextUIState(
         /**
-         * the view level that should be represented. 0 means initial (master only), 1 - master-detail, 2 - master-detail-detail,
+         * the view level that should be represented. 0 means initial (list only), 1 - list-detail, 2 - list-detail-detail,
          * 3 and above - subsequent views
          */
         iNextLevel: int
@@ -17773,7 +17892,7 @@ declare namespace sap {
        *
        * @returns with all available contexts
        */
-      getContext(): Object;
+      getContext(): sap.m.BarContexts;
       /**
        * Gets current value of property {@link #getHomeIcon homeIcon}.
        *
@@ -18194,12 +18313,10 @@ declare namespace sap {
     }
     /**
      * @SINCE 1.107
-     * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
-     * the API might be changed in future.
      *
      * Overview:
      *
-     * `SidePanel` is a layout control that allows primary and additional content to be displayed by clicking/tapping
+     * `SidePanel` is a layout control that allows primary and additional content to be displayed by choosing
      * the action items from its action bar.
      *
      * Usage:
@@ -18207,8 +18324,8 @@ declare namespace sap {
      * Action bar with action items have two states - collapsed and expanded. In collapsed state only icons
      * are displayed, and in expanded state both icons and titles are displayed.
      *
-     * Each action item can have a content and click/tap on action item toggles the display of its content.
-     * The content can be added to the action item's `content` aggregation, or can be added or changed later.
+     * Each action item can have a content and choose an action item toggles the display of its content. The
+     * content can be added to the action item's `content` aggregation, or can be added or changed later.
      *
      * Each click/tap fires an event, and in the event handler specific content can be added/changed to the
      * `content` aggregation of the clicked/tapped action item or data can be retreived from the same aggregation
@@ -18227,15 +18344,7 @@ declare namespace sap {
      * an overflow icon is displayed, and it toggles ON/OFF an overflow menu with the rest of the action items
      * that are not visible at the moment.
      *
-     * Screen width > 1440 px
-     *
-     *
-     * 	 - When expanded, the side content shrinks the main content.
-     *
-     * Screen width <= 1440 px
-     *
-     *
-     * 	 - When expanded, the side content is placed over the main content.
+     * When expanded, the side content shrinks the main content.
      *
      * **On mobile device**
      *
@@ -18243,6 +18352,14 @@ declare namespace sap {
      * and when expanded, the side content is displayed above the action bar. If there is not enough room for
      * all action items, the action bar can be swiped to access the rest of the action items.
      *
+     * Resizing:
+     *
+     * Resizing functionality only affects desktop or tablet devices.
+     *
+     * By setting the `sidePanelResizable` property, the expanded side panel can be resized by mouse (by drag
+     * or by double click on resize splitter), by keyboard or by choosing one of three predefined positions
+     * in the side panel's context menu (min, max and default widths)
+     *
      * Keyboard shortcuts:
      *
      *
@@ -18256,6 +18373,22 @@ declare namespace sap {
      * 			opened side content panel to the action items
      * 	 - [F6] / [Shift] + [F6] - Navigate back and forth between main content, side panel and side content
      * 			groups [Esc] - Close the opened side content panel and set focus back to main content
+     *
+     * If the side panel's `sidePanelResizable` property is set, there is an action item chosen, and the resize
+     * splitter is focused:
+     *
+     *
+     * 	 - [Home] - set the expanded side panel width to the minimum value defined in `sidePanelMinWidth` property
+     *
+     * 	 - [End] - set the expanded side panel width to the maximum value defined in `sidePanelMaxWidth` property
+     *
+     * 	 - [Enter] - set the expanded side panel width to the default value defined in `sidePanelWidth` property
+     *
+     * 	 - [Shift]+[F10] or [Context menu] - show the resize context menu
+     * 	 - [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with the regular
+     * 			step
+     * 	 - [Shift] + [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with
+     * 			the larger step
      */
     class SidePanel extends sap.ui.core.Control {
       /**
@@ -18492,6 +18625,73 @@ declare namespace sap {
        * or `null`.
        */
       getSelectedItem(): sap.ui.core.ID;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Gets current value of property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
+       *
+       * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
+       *
+       * Default value is `"90%"`.
+       *
+       * @returns Value of property `sidePanelMaxWidth`
+       */
+      getSidePanelMaxWidth(): sap.ui.core.CSSSize;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Gets current value of property {@link #getSidePanelMinWidth sidePanelMinWidth}.
+       *
+       * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
+       *
+       * Default value is `"15rem"`.
+       *
+       * @returns Value of property `sidePanelMinWidth`
+       */
+      getSidePanelMinWidth(): sap.ui.core.CSSSize;
+      /**
+       * Gets current value of property {@link #getSidePanelResizable sidePanelResizable}.
+       *
+       * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+       * desktop or tablet devices.
+       *
+       * Default value is `false`.
+       *
+       * @returns Value of property `sidePanelResizable`
+       */
+      getSidePanelResizable(): boolean;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Gets current value of property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
+       *
+       * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+       * the resize splitter is focused.
+       *
+       * Default value is `100`.
+       *
+       * @returns Value of property `sidePanelResizeLargerStep`
+       */
+      getSidePanelResizeLargerStep(): int;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Gets current value of property {@link #getSidePanelResizeStep sidePanelResizeStep}.
+       *
+       * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+       * is focused.
+       *
+       * Default value is `10`.
+       *
+       * @returns Value of property `sidePanelResizeStep`
+       */
+      getSidePanelResizeStep(): int;
       /**
        * Gets current value of property {@link #getSidePanelWidth sidePanelWidth}.
        *
@@ -18635,29 +18835,110 @@ declare namespace sap {
         sAriaLabel?: string
       ): this;
       /**
-       * Sets a new value for property {@link #getSidePanelWidth sidePanelWidth}.
+       * @SINCE 1.109.0
        *
-       * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
-       * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
-       * it's calculated in absolute units.
+       * Sets a new value for property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
+       *
+       * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
-       * Default value is `"20rem"`.
+       * Default value is `"90%"`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSidePanelMaxWidth(
+        /**
+         * New value for property `sidePanelMaxWidth`
+         */
+        sSidePanelMaxWidth?: sap.ui.core.CSSSize
+      ): this;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Sets a new value for property {@link #getSidePanelMinWidth sidePanelMinWidth}.
+       *
+       * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+       * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+       * otherwise it's calculated in absolute units.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `"15rem"`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSidePanelMinWidth(
+        /**
+         * New value for property `sidePanelMinWidth`
+         */
+        sSidePanelMinWidth?: sap.ui.core.CSSSize
+      ): this;
+      /**
+       * Sets a new value for property {@link #getSidePanelResizable sidePanelResizable}.
+       *
+       * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+       * desktop or tablet devices.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `false`.
        *
        * @returns Reference to `this` in order to allow method chaining
        */
-      setSidePanelWidth(
+      setSidePanelResizable(
         /**
-         * New value for property `sidePanelWidth`
+         * New value for property `sidePanelResizable`
          */
-        sSidePanelWidth?: sap.ui.core.CSSSize
+        bSidePanelResizable?: boolean
+      ): this;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Sets a new value for property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
+       *
+       * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+       * the resize splitter is focused.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `100`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSidePanelResizeLargerStep(
+        /**
+         * New value for property `sidePanelResizeLargerStep`
+         */
+        iSidePanelResizeLargerStep?: int
+      ): this;
+      /**
+       * @SINCE 1.109.0
+       *
+       * Sets a new value for property {@link #getSidePanelResizeStep sidePanelResizeStep}.
+       *
+       * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+       * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+       * is focused.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `10`.
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSidePanelResizeStep(
+        /**
+         * New value for property `sidePanelResizeStep`
+         */
+        iSidePanelResizeStep?: int
       ): this;
     }
     /**
      * @SINCE 1.107
-     * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
-     * the API might be changed in future.
      *
      * Overview:
      *