@openui5/types 1.120.10 → 1.121.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/types",
-  "version": "1.120.10",
+  "version": "1.121.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.120.10
+// For Library Version: 1.121.1
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -40,6 +40,8 @@ declare module "sap/f/library" {
   /**
    * Group modes for the {@link sap.f.AvatarGroup} control.
    *
+   * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'AvatarGroupType'.
+   *
    * @since 1.73
    * @experimental (since 1.73)
    */
@@ -98,6 +100,8 @@ declare module "sap/f/library" {
   /**
    * Defines the areas within the `sap.f.DynamicPageTitle` control.
    *
+   * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'DynamicPageTitleArea'.
+   *
    * @since 1.50
    * @deprecated (since 1.54) - Consumers of the {@link sap.f.DynamicPageTitle} control should now use the
    * `areaShrinkRatio` property instead of the `primaryArea` property.
@@ -182,19 +186,25 @@ declare module "sap/f/library" {
    * Layouts, representing the number of columns to be displayed and their relative widths for a {@link sap.f.FlexibleColumnLayout }
    * control.
    *
-   * Each layout has a predefined ratio for the three columns, depending on device size. Based on the device
-   * and layout, some columns are hidden. For more information, refer to the ratios (in %) for each value,
-   * listed below: (dash "-" means non-accessible columns).
+   * Each layout has a default predefined ratio for the three columns, depending on device size. Based on
+   * the device and layout, some columns are hidden. For more information, refer to the ratios (in %) for
+   * each value, listed below: (dash "-" means non-accessible columns).
    *
-   * **Note:** Please note that on a phone device, due to the limited screen size, only one column can be
-   * displayed at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column
-   * layouts - the `End` column, even though the respective column may be hidden on desktop and tablet for
-   * that particular layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example)
-   * are representative of the desktop scenario only.
+   * **Notes:**
+   * 	 - The user is allowed to customize the default ratio by dragging the column separators to resize the
+   *     columns. The user preferences are then internally saved (in browser localStorage) and automatically re-applied
+   *     whenever the user re-visits the same layout.
+   * 	 - Please note that on a phone device, due to the limited screen size, only one column can be displayed
+   *     at a time. For all two-column layouts, this column is the `Mid` column, and for all three-column layouts
+   *     - the `End` column, even though the respective column may be hidden on desktop and tablet for that particular
+   *     layout. Therefore some of the names (such as `ThreeColumnsMidExpandedEndHidden` for example) are representative
+   *     of the desktop scenario only.
    *
    * For more information, see {@link https://ui5.sap.com/#/topic/3b9f760da5b64adf8db7f95247879086 Types of Layout }
    * in the documentation.
    *
+   * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'LayoutType'.
+   *
    * @since 1.46
    */
   export enum LayoutType {
@@ -229,20 +239,23 @@ declare module "sap/f/library" {
      */
     OneColumn = "OneColumn",
     /**
-     * Desktop: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
+     * Desktop: default ratio is 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by
+     * dragging the column separators
      *
-     * Tablet: 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by layout arrows
+     * Tablet: default ratio is 67/33/0 Begin (expanded) and Mid columns are displayed, End is accessible by
+     * dragging the column separators
      *
      * Phone: -/-/100 only the End column is displayed
      *
      * Use to display the master and detail pages when the user should focus on the master. The detail-detail
-     * is still loaded and easily accessible with layout arrows.
+     * is still loaded and easily accessible by dragging the column separators.
      */
     ThreeColumnsBeginExpandedEndHidden = "ThreeColumnsBeginExpandedEndHidden",
     /**
-     * Desktop: 25/25/50 Begin, Mid and End (expanded) columns are displayed
+     * Desktop: default ratio is 25/25/50 Begin, Mid and End (expanded) columns are displayed
      *
-     * Tablet: 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by layout arrows
+     * Tablet: default ratio is 0/33/67 Mid and End (expanded) columns are displayed, Begin is accessible by
+     * dragging the column separator to expand the column
      *
      * Phone: -/-/100 (only the End column is displayed)
      *
@@ -250,9 +263,10 @@ declare module "sap/f/library" {
      */
     ThreeColumnsEndExpanded = "ThreeColumnsEndExpanded",
     /**
-     * Desktop: 25/50/25 Begin, Mid (expanded) and End columns are displayed
+     * Desktop: default ratio is 25/50/25 Begin, Mid (expanded) and End columns are displayed
      *
-     * Tablet: 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by a layout arrow
+     * Tablet: default ratio is 0/67/33 Mid (expanded) and End columns are displayed, Begin is accessible by
+     * dragging its adjacent column separator to expand the column.
      *
      * Phone: -/-/100 only the End column is displayed
      *
@@ -260,20 +274,22 @@ declare module "sap/f/library" {
      */
     ThreeColumnsMidExpanded = "ThreeColumnsMidExpanded",
     /**
-     * Desktop: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
+     * Desktop: default ratio is 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by
+     * dragging the column-separator to expand the column.
      *
-     * Tablet: 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by a layout arrow
+     * Tablet: default ratio is 33/67/0 Begin and Mid (expanded) columns are displayed, End is accessible by
+     * dragging the column-separator to expand the column.
      *
      * Phone: -/-/100 only the End column is displayed
      *
      * Use to display the master and detail pages when the user should focus on the detail. The detail-detail
-     * is still loaded and easily accessible with a layout arrow.
+     * is still loaded and easily accessible upon dragging the column-separator to expand the column.
      */
     ThreeColumnsMidExpandedEndHidden = "ThreeColumnsMidExpandedEndHidden",
     /**
-     * Desktop: 67/33/- Begin (expanded) and Mid columns are displayed
+     * Desktop: default ratio is 67/33/- Begin (expanded) and Mid columns are displayed
      *
-     * Tablet: 67/33/- Begin (expanded) and Mid columns are displayed
+     * Tablet: default ratio is 67/33/- Begin (expanded) and Mid columns are displayed
      *
      * Phone: -/100/- only the Mid column is displayed
      *
@@ -281,9 +297,9 @@ declare module "sap/f/library" {
      */
     TwoColumnsBeginExpanded = "TwoColumnsBeginExpanded",
     /**
-     * Desktop: 33/67/- Begin and Mid (expanded) columns are displayed
+     * Desktop: default ratio is 33/67/- Begin and Mid (expanded) columns are displayed
      *
-     * Tablet: 33/67/- Begin and Mid (expanded) columns are displayed
+     * Tablet: default ratio is 33/67/- Begin and Mid (expanded) columns are displayed
      *
      * Phone: -/100/- only the Mid column is displayed
      *
@@ -294,6 +310,8 @@ declare module "sap/f/library" {
   /**
    * Enumeration for different navigation directions.
    *
+   * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'NavigationDirection'.
+   *
    * @since 1.85
    */
   export enum NavigationDirection {
@@ -317,6 +335,8 @@ declare module "sap/f/library" {
   /**
    * Enumeration for different SidePanel position.
    *
+   * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'SidePanelPosition'.
+   *
    * @since 1.104
    */
   export enum SidePanelPosition {
@@ -344,6 +364,8 @@ declare module "sap/f/library" {
     /**
      * Different options for the position of the header in controls that implement the {@link sap.f.ICard} interface.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'cards.HeaderPosition'.
+     *
      * @since 1.65
      */
     enum HeaderPosition {
@@ -359,6 +381,8 @@ declare module "sap/f/library" {
     /**
      * Different options for the alignment of the side indicators in the numeric header.
      *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'cards.NumericHeaderSideIndicatorsAlignment'.
+     *
      * @since 1.96
      */
     enum NumericHeaderSideIndicatorsAlignment {
@@ -544,8 +568,6 @@ declare module "sap/f/AvatarGroup" {
    * 	 - You want to use it for other visual content than avatars.
    *
    * @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 AvatarGroup extends Control {
     /**
@@ -1769,6 +1791,30 @@ declare module "sap/f/cards/BaseHeader" {
        */
       vBannerLine: int | string | Text
     ): Text | null;
+    /**
+     * Sets a new value for property {@link #getDataTimestamp dataTimestamp}.
+     *
+     * Defines the timestamp of the oldest data in the card. Use this to show to the end user how fresh the
+     * information in the card is.
+     *
+     * Must be specified in ISO 8601 format.
+     *
+     * Will be shown as a relative time like "5 minutes ago".
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `empty string`.
+     *
+     * @experimental (since 1.89) - this feature is experimental and the API may change.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setDataTimestamp(
+      /**
+       * New value for property `dataTimestamp`
+       */
+      sDataTimestamp?: string
+    ): this;
     /**
      * Sets a new value for property {@link #getStatusVisible statusVisible}.
      *
@@ -4541,7 +4587,7 @@ declare module "sap/f/DynamicPage" {
      *
      * @since 1.65
      */
-    getStickySubheaderProvider(): ID;
+    getStickySubheaderProvider(): ID | null;
     /**
      * Gets content of aggregation {@link #getTitle title}.
      *
@@ -6883,7 +6929,11 @@ declare module "sap/f/FlexibleColumnLayout" {
    * The width of the three columns is variable.
    *
    * There are several possible layouts that can be changed either with the control's API, or by the user
-   * with the help of layout arrows.
+   * with the help of the draggable column separators. The draggable column separators allow the user to customize
+   * the column widths for the current layout, or to switch to a new layout (if the user drags the column
+   * separator past a breakpoint that delimits two different layouts). After the user customized the column
+   * widths for a given layout, these user preferences are internally saved and automatically re-applied whenever
+   * the user re-visits the same layout.
    *
    * Internally the control makes use of three instances of {@link sap.m.NavContainer}, thus forming the three
    * columns.
@@ -7413,9 +7463,10 @@ declare module "sap/f/FlexibleColumnLayout" {
      * displayed at once.
      *
      *  The interactions that may lead to a state change are:
-     * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-     * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-     *     can be displayed at once.
+     * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+     *     on its arrow (where arrow is available).
+     * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+     *     that can be displayed at once.
      *
      *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
      * it gets a non-zero width
@@ -7448,9 +7499,10 @@ declare module "sap/f/FlexibleColumnLayout" {
      * displayed at once.
      *
      *  The interactions that may lead to a state change are:
-     * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-     * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-     *     can be displayed at once.
+     * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+     *     on its arrow (where arrow is available).
+     * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+     *     that can be displayed at once.
      *
      *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
      * it gets a non-zero width
@@ -8034,17 +8086,17 @@ declare module "sap/f/FlexibleColumnLayout" {
      * ID of the element which is the current target of the association {@link #getInitialBeginColumnPage initialBeginColumnPage},
      * or `null`.
      */
-    getInitialBeginColumnPage(): ID;
+    getInitialBeginColumnPage(): ID | null;
     /**
      * ID of the element which is the current target of the association {@link #getInitialEndColumnPage initialEndColumnPage},
      * or `null`.
      */
-    getInitialEndColumnPage(): ID;
+    getInitialEndColumnPage(): ID | null;
     /**
      * ID of the element which is the current target of the association {@link #getInitialMidColumnPage initialMidColumnPage},
      * or `null`.
      */
-    getInitialMidColumnPage(): ID;
+    getInitialMidColumnPage(): ID | null;
     /**
      * Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
      *
@@ -8903,9 +8955,10 @@ declare module "sap/f/FlexibleColumnLayout" {
      * displayed at once.
      *
      *  The interactions that may lead to a state change are:
-     * 	 - the property `layout` was changed indirectly by the user clicking a layout arrow
-     * 	 - the user resized the browser beyond a breakpoint, thus changing the maximum number of columns that
-     *     can be displayed at once.
+     * 	 - The property `layout` was changed indirectly by the user dragging the column separator or clicking
+     *     on its arrow (where arrow is available).
+     * 	 - The user resized the browser window beyond a breakpoint, thus changing the maximum number of columns
+     *     that can be displayed at once.
      *
      *  **Note: **The event is suppressed while the control has zero width and will be fired the first time
      * it gets a non-zero width
@@ -9362,12 +9415,14 @@ declare module "sap/f/FlexibleColumnLayout" {
     maxColumnsCount?: int;
 
     /**
-     * Indicates whether the layout changed as a result of the user clicking a layout arrow
+     * Indicates whether the layout changed as a result of the user clicking a column separator's arrow or dragging
+     * the column separators
      */
     isNavigationArrow?: boolean;
 
     /**
-     * Indicates whether the maximum number of columns that can be displayed at once changed
+     * Indicates whether the maximum number of columns that can be displayed at once changed due to resize of
+     * the entire browser window
      */
     isResize?: boolean;
   }
@@ -10860,7 +10915,7 @@ declare module "sap/f/GridContainer" {
       /**
        * The item to remove or its index or ID.
        */
-      vItem: int | string | Control
+      vItem: int | ID | Control
     ): Control | null;
     /**
      * Sets a new value for property {@link #getAllowDenseFill allowDenseFill}.
@@ -12706,7 +12761,7 @@ declare module "sap/f/ProductSwitch" {
      * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
      * or `null`.
      */
-    getSelectedItem(): ID;
+    getSelectedItem(): ID | null;
     /**
      * Checks for the provided `sap.f.ProductSwitchItem` in the aggregation {@link #getItems items}. and returns
      * its index if found or -1 otherwise.
@@ -12771,7 +12826,7 @@ declare module "sap/f/ProductSwitch" {
        * the item with this ID becomes the `selectedItem` association. Alternatively, a `sap.f.ProductSwitchItem`
        * instance may be given or `null` to clear the selection.
        */
-      vItem: string | ProductSwitchItem | null
+      vItem: ID | ProductSwitchItem | null
     ): this;
   }
 
@@ -20149,6 +20204,25 @@ declare module "sap/f/ShellBar" {
        */
       oMenu: Menu
     ): this;
+    /**
+     * Sets a new value for property {@link #getNotificationsNumber notificationsNumber}.
+     *
+     * Defines the displayed number of upcoming notifications.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `empty string`.
+     *
+     * @since 1.64
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setNotificationsNumber(
+      /**
+       * New value for property `notificationsNumber`
+       */
+      sNotificationsNumber?: string
+    ): this;
     /**
      * Sets the aggregated {@link #getProfile profile}.
      *
@@ -20472,6 +20546,11 @@ declare module "sap/f/ShellBar" {
      * Reference to the button that has been pressed
      */
     image?: Image;
+
+    /**
+     * Reference to the button that has been pressed
+     */
+    button?: Button;
   }
 
   export type ShellBar$CopilotPressedEvent = Event<
@@ -20887,7 +20966,7 @@ declare module "sap/f/SidePanel" {
      * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem},
      * or `null`.
      */
-    getSelectedItem(): ID;
+    getSelectedItem(): ID | null;
     /**
      * Gets current value of property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
      *