@sapui5/ts-types 1.108.2 → 1.109.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types",
-  "version": "1.108.2",
+  "version": "1.109.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.0
+// For Library Version: 1.109.0
 
 declare namespace sap {
   namespace ca {
@@ -13819,8 +13819,6 @@ declare namespace sap {
 
     "sap/ca/ui/DatePicker": undefined;
 
-    "sap/ca/ui/dialog/factory": undefined;
-
     "sap/ca/ui/ExpansibleFeedListItem": undefined;
 
     "sap/ca/ui/FileUpload": undefined;

package/types/sap.chart.d.ts

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

package/types/sap.collaboration.d.ts

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

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.0
+// For Library Version: 1.109.0
 
 declare namespace sap {
   namespace esh {

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.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
@@ -1080,6 +1090,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 +1308,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}.
          *
@@ -8338,6 +8379,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 +8398,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.
        */
@@ -18194,12 +18292,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 +18303,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 +18323,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 +18331,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 +18352,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 +18604,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 +18814,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
+       */
+      setSidePanelResizable(
+        /**
+         * New value for property `sidePanelResizable`
+         */
+        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
        */
-      setSidePanelWidth(
+      setSidePanelResizeStep(
         /**
-         * New value for property `sidePanelWidth`
+         * New value for property `sidePanelResizeStep`
          */
-        sSidePanelWidth?: sap.ui.core.CSSSize
+        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:
      *

package/types/sap.fe.common.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare namespace sap {
   /**
@@ -838,24 +838,7 @@ declare namespace sap {
             /**
              * The current navigation parameter
              */
-            oNavParameter: {
-              /**
-               * The actual navigation type
-               */
-              navigationType: any;
-              /**
-               * Defines whether the standard variant must be used in variant management
-               */
-              requiresStandardVariant?: boolean;
-              /**
-               * The selectionVariant from the navigation
-               */
-              selectionVariant?: object;
-              /**
-               * The selectionVariant defaults from the navigation
-               */
-              selectionVariantDefaults?: object;
-            }
+            oNavParameter: /* was: sap.fe.core.NavigationParameter */ any
           ): Promise<any>;
           /**
            * Hook to react when state for given view was applied.
@@ -908,6 +891,28 @@ declare namespace sap {
            */
           retrieveViewState(): Promise<any>;
         }
+
+        /**
+         * Definition of a custom action to be used inside the table toolbar
+         */
+        type NavigationParameter = {
+          /**
+           *  The actual navigation type.
+           */
+          navigationType: string;
+          /**
+           * Defines whether the standard variant must be used in variant management
+           */
+          requiresStandardVariant: boolean;
+          /**
+           * The selectionVariant from the navigation.
+           */
+          selectionVariant: object;
+          /**
+           * The selectionVariant defaults from the navigation
+           */
+          selectionVariantDefaults: object;
+        };
       }
       /**
        * Collection of classes provided by SAP Fiori elements for the Flexible Programming Model
@@ -959,6 +964,12 @@ declare namespace sap {
           /* was: sap.fe.core.RootViewBaseController */ extends Object {
           constructor();
 
+          /**
+           * Method that creates a new Page to display the IllustratedMessage containing the current error.
+           *
+           * @returns A promise that creates a Page to display the error
+           */
+          displayErrorPage(): Promise<any>;
           /**
            * @SINCE 1.91.0
            *
@@ -1024,6 +1035,32 @@ declare namespace sap {
        */
       class AppComponent extends sap.ui.core.UIComponent {
         constructor();
+
+        /**
+         * Changes the page configuration of SAP Fiori elements.
+         * This method enables you to change the page configuration of SAP Fiori elements.
+         */
+        changePageConfiguration(
+          /**
+           * The ID of the page for which the configuration is to be changed.
+           */
+          pageId: string,
+          /**
+           * The path in the page settings for which the configuration is to be changed.
+           */
+          path: string,
+          /**
+           * The new value of the configuration. This could be a plain value like a string, or a Boolean, or a structured
+           * object.
+           */
+          value: unknown
+        ): void;
+        /**
+         * Provides a hook to initialize feature toggles.
+         * This hook is being called by the SAP Fiori elements AppComponent at the time feature toggles can be initialized.
+         * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration} method.
+         */
+        initializeFeatureToggles(): void;
       }
       /**
        * @SINCE 1.90.0
@@ -1192,7 +1229,7 @@ declare namespace sap {
          *
          * @returns A promise that resolves with the new app state object.
          */
-        updateAppState(): undefined | Promise<any>;
+        updateAppState(): Promise<any>;
       }
       /**
        * @SINCE 1.88.0

package/types/sap.fe.macros.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare namespace sap {
   namespace fe {
@@ -15,6 +15,17 @@ declare namespace sap {
        */
       export const FormElement: undefined;
 
+      namespace field {
+        interface $TextAreaExSettings extends sap.m.$TextAreaSettings {}
+
+        /**
+         * Extension of the TextArea control to add a check for the maximum length when setting the value.
+         */
+        class TextAreaEx extends sap.m.TextArea {
+          constructor();
+        }
+      }
+
       namespace table {
         /**
          * Definition of a custom action to be used inside the table toolbar
@@ -682,6 +693,13 @@ declare namespace sap {
          * Maximum number of characters from the beginning of the text field that are shown initially.
          */
         textMaxCharactersDisplay: number;
+        /**
+         * Defines the maximum number of characters for the multiline text value.
+         *
+         * If a multiline text exceeds the maximum number of allowed characters, the counter below the input field
+         * displays the exact number.
+         */
+        textMaxLength: number;
         /**
          * Maximum number of lines that multiline texts in edit mode can grow to.
          */
@@ -725,6 +743,8 @@ declare namespace sap {
 
     "sap/fe/macros/field/FieldAPI": undefined;
 
+    "sap/fe/macros/field/TextAreaEx": undefined;
+
     "sap/fe/macros/filterBar/FilterBarAPI": undefined;
 
     "sap/fe/macros/form/FormAPI": undefined;

package/types/sap.fe.navigation.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare namespace sap {
   namespace fe {

package/types/sap.fe.templates.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare namespace sap {
   namespace fe {
@@ -211,7 +211,7 @@ declare namespace sap {
            *
            * @returns A promise that resolves with the new app state object.
            */
-          updateAppState(): undefined | Promise<any>;
+          updateAppState(): Promise<any>;
         }
       }
 
@@ -393,7 +393,7 @@ declare namespace sap {
            *
            * @returns A promise that resolves with the new app state object.
            */
-          updateAppState(): undefined | Promise<any>;
+          updateAppState(): Promise<any>;
         }
       }
     }