@openui5/ts-types-esm 1.93.3 → 1.96.2

package/package.json

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

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.93.3
+// For Library Version: 1.96.2
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -425,6 +425,21 @@ declare module "sap/f/library" {
        */
       Top = "Top",
     }
+    /**
+     * @SINCE 1.96
+     *
+     * Different options for the alignment of the side indicators in the numeric header.
+     */
+    enum NumericHeaderSideIndicatorsAlignment {
+      /**
+       * Sets the alignment to the beginning (left or right depending on LTR/RTL).
+       */
+      Begin = "Begin",
+      /**
+       * Explicitly sets the alignment to the end (left or right depending on LTR/RTL).
+       */
+      End = "End",
+    }
   }
 
   export namespace dnd {
@@ -1960,8 +1975,8 @@ declare module "sap/f/cards/NumericHeader" {
    * Displays general information in the header of the {@link sap.f.Card} and allows the configuration of
    * a numeric value visualization.
    *
-   * You can configure the title, subtitle, status text and icon, using the provided properties. To add more
-   * side number indicators, use the `sideIndicators` aggregation.
+   * You can configure the title, subtitle, and status text, using the provided properties. To add more side
+   * number indicators, use the `sideIndicators` aggregation.
    *
    * **Notes:**
    * 	 - You should always set a title.
@@ -2134,6 +2149,16 @@ declare module "sap/f/cards/NumericHeader" {
      * should be used.
      */
     getSideIndicators(): NumericSideIndicator[];
+    /**
+     * Gets current value of property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+     *
+     * The alignment of the side indicators.
+     *
+     * Default value is `"Begin"`.
+     */
+    getSideIndicatorsAlignment():
+      | cards.NumericHeaderSideIndicatorsAlignment
+      | keyof typeof cards.NumericHeaderSideIndicatorsAlignment;
     /**
      * @EXPERIMENTAL (since 1.64)
      *
@@ -2245,6 +2270,23 @@ declare module "sap/f/cards/NumericHeader" {
        */
       sValue: string
     ): this;
+    /**
+     * Sets a new value for property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+     *
+     * The alignment of the side indicators.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"Begin"`.
+     */
+    setSideIndicatorsAlignment(
+      /**
+       * New value for property `sideIndicatorsAlignment`
+       */
+      sSideIndicatorsAlignment?:
+        | cards.NumericHeaderSideIndicatorsAlignment
+        | keyof typeof cards.NumericHeaderSideIndicatorsAlignment
+    ): this;
     /**
      * Sets the semantic color which represents the state of the main number indicator.
      */
@@ -2360,6 +2402,16 @@ declare module "sap/f/cards/NumericHeader" {
      */
     details?: string | PropertyBindingInfo;
 
+    /**
+     * The alignment of the side indicators.
+     */
+    sideIndicatorsAlignment?:
+      | (
+          | cards.NumericHeaderSideIndicatorsAlignment
+          | keyof typeof cards.NumericHeaderSideIndicatorsAlignment
+        )
+      | PropertyBindingInfo;
+
     /**
      * Additional side number indicators. For example "Deviation" and "Target". Not more than two side indicators
      * should be used.
@@ -2381,6 +2433,8 @@ declare module "sap/f/cards/NumericSideIndicator" {
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
+  import { ValueColor } from "sap/m/library";
+
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
@@ -2451,6 +2505,16 @@ declare module "sap/f/cards/NumericSideIndicator" {
      * The numeric value
      */
     getNumber(): string;
+    /**
+     * @EXPERIMENTAL (since 1.95)
+     *
+     * Gets current value of property {@link #getState state}.
+     *
+     * The semantic color which represents the state of the side indicator.
+     *
+     * Default value is `"None"`.
+     */
+    getState(): ValueColor | keyof typeof ValueColor;
     /**
      * Gets current value of property {@link #getTitle title}.
      *
@@ -2472,6 +2536,23 @@ declare module "sap/f/cards/NumericSideIndicator" {
        */
       sValue: string
     ): this;
+    /**
+     * @EXPERIMENTAL (since 1.95)
+     *
+     * Sets a new value for property {@link #getState state}.
+     *
+     * The semantic color which represents the state of the side indicator.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"None"`.
+     */
+    setState(
+      /**
+       * New value for property `state`
+       */
+      sState?: ValueColor | keyof typeof ValueColor
+    ): this;
     /**
      * Sets the title.
      */
@@ -2507,6 +2588,13 @@ declare module "sap/f/cards/NumericSideIndicator" {
      * Defines the unit of measurement (scaling prefix) for the numeric value
      */
     unit?: string | PropertyBindingInfo;
+
+    /**
+     * @EXPERIMENTAL (since 1.95)
+     *
+     * The semantic color which represents the state of the side indicator.
+     */
+    state?: (ValueColor | keyof typeof ValueColor) | PropertyBindingInfo;
   }
 }
 
@@ -5072,6 +5160,8 @@ declare module "sap/f/FlexibleColumnLayout" {
 
   import { BackgroundDesign } from "sap/m/library";
 
+  import FlexibleColumnLayoutAccessibleLandmarkInfo from "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import {
@@ -5751,6 +5841,12 @@ declare module "sap/f/FlexibleColumnLayout" {
      * Destroys all the endColumnPages in the aggregation {@link #getEndColumnPages endColumnPages}.
      */
     destroyEndColumnPages(): this;
+    /**
+     * @SINCE 1.95
+     *
+     * Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
+     */
+    destroyLandmarkInfo(): this;
     /**
      * Destroys all the midColumnPages in the aggregation {@link #getMidColumnPages midColumnPages}.
      */
@@ -6355,6 +6451,16 @@ declare module "sap/f/FlexibleColumnLayout" {
      * or `null`.
      */
     getInitialMidColumnPage(): ID;
+    /**
+     * @SINCE 1.95
+     *
+     * Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
+     *
+     * Accessible landmark settings to be applied on the containers of the `sap.f.FlexibleColumnLayout` control.
+     *
+     * If not set, no landmarks will be written.
+     */
+    getLandmarkInfo(): FlexibleColumnLayoutAccessibleLandmarkInfo;
     /**
      * Gets current value of property {@link #getLayout layout}.
      *
@@ -6390,22 +6496,6 @@ declare module "sap/f/FlexibleColumnLayout" {
      * Default value is `false`.
      */
     getRestoreFocusOnBackNavigation(): boolean;
-    /**
-     * @SINCE 1.91
-     *
-     * Hides the placeholder on the corresponding column for the provided aggregation name.
-     */
-    hidePlaceholder(
-      /**
-       * Object containing the aggregation name
-       */
-      mSettings: {
-        /**
-         * The aggregation name to decide on which column/container the placeholder should be hidden
-         */
-        aggregation: string;
-      }
-    ): void;
     /**
      * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBeginColumnPages beginColumnPages}.
      * and returns its index if found or -1 otherwise.
@@ -6645,6 +6735,17 @@ declare module "sap/f/FlexibleColumnLayout" {
        */
       oInitialMidColumnPage: ID | Control
     ): this;
+    /**
+     * @SINCE 1.95
+     *
+     * Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
+     */
+    setLandmarkInfo(
+      /**
+       * The landmarkInfo to set
+       */
+      oLandmarkInfo: FlexibleColumnLayoutAccessibleLandmarkInfo
+    ): this;
     /**
      * Sets a new value for property {@link #getLayout layout}.
      *
@@ -6680,22 +6781,6 @@ declare module "sap/f/FlexibleColumnLayout" {
        */
       bRestoreFocusOnBackNavigation?: boolean
     ): this;
-    /**
-     * @SINCE 1.91
-     *
-     * Shows the placeholder on the corresponding column for the provided aggregation name.
-     */
-    showPlaceholder(
-      /**
-       * Object containing the aggregation name
-       */
-      mSettings: {
-        /**
-         * The aggregation name to decide on which column/container the placeholder should be shown
-         */
-        aggregation: string;
-      }
-    ): void;
     /**
      * Navigates to the given page inside the FlexibleColumnLayout. Columns are scanned for the page in the
      * following order: `Begin`, `Mid`, `End`.
@@ -7076,6 +7161,15 @@ declare module "sap/f/FlexibleColumnLayout" {
      */
     endColumnPages?: Control[] | Control | AggregationBindingInfo;
 
+    /**
+     * @SINCE 1.95
+     *
+     * Accessible landmark settings to be applied on the containers of the `sap.f.FlexibleColumnLayout` control.
+     *
+     * If not set, no landmarks will be written.
+     */
+    landmarkInfo?: FlexibleColumnLayoutAccessibleLandmarkInfo;
+
     /**
      * Sets the initial `Begin` column page, which is displayed on application launch.
      */
@@ -7156,6 +7250,182 @@ declare module "sap/f/FlexibleColumnLayout" {
   }
 }
 
+declare module "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo" {
+  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * @SINCE 1.95
+   *
+   * Settings for accessible landmarks which can be applied to the container elements of a `sap.f.FlexibleColumnLayout`
+   * control. For example, these landmarks are used by assistive technologies (such as screen readers) to
+   * provide a meaningful columns overview.
+   */
+  export default class FlexibleColumnLayoutAccessibleLandmarkInfo extends UI5Element {
+    /**
+     * Constructor for a new `sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo` 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 element
+       */
+      mSettings?: $FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+    );
+    /**
+     * Constructor for a new `sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo` 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 element, generated automatically if no ID is given
+       */
+      sId?: string,
+      /**
+       * Initial settings for the new element
+       */
+      mSettings?: $FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+    );
+
+    /**
+     * Creates a new subclass of class sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo 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}.
+     */
+    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, FlexibleColumnLayoutAccessibleLandmarkInfo>,
+      /**
+       * 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.f.FlexibleColumnLayoutAccessibleLandmarkInfo.
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Gets current value of property {@link #getFirstColumnLabel firstColumnLabel}.
+     *
+     * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    getFirstColumnLabel(): string;
+    /**
+     * Gets current value of property {@link #getLastColumnLabel lastColumnLabel}.
+     *
+     * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    getLastColumnLabel(): string;
+    /**
+     * Gets current value of property {@link #getMiddleColumnLabel middleColumnLabel}.
+     *
+     * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    getMiddleColumnLabel(): string;
+    /**
+     * Sets a new value for property {@link #getFirstColumnLabel firstColumnLabel}.
+     *
+     * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     */
+    setFirstColumnLabel(
+      /**
+       * New value for property `firstColumnLabel`
+       */
+      sFirstColumnLabel?: string
+    ): this;
+    /**
+     * Sets a new value for property {@link #getLastColumnLabel lastColumnLabel}.
+     *
+     * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     */
+    setLastColumnLabel(
+      /**
+       * New value for property `lastColumnLabel`
+       */
+      sLastColumnLabel?: string
+    ): this;
+    /**
+     * Sets a new value for property {@link #getMiddleColumnLabel middleColumnLabel}.
+     *
+     * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     */
+    setMiddleColumnLabel(
+      /**
+       * New value for property `middleColumnLabel`
+       */
+      sMiddleColumnLabel?: string
+    ): this;
+  }
+
+  export interface $FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+    extends $ElementSettings {
+    /**
+     * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    firstColumnLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    middleColumnLabel?: string | PropertyBindingInfo;
+
+    /**
+     * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+     * control.
+     *
+     * If not set, a predefined text is used.
+     */
+    lastColumnLabel?: string | PropertyBindingInfo;
+  }
+}
+
 declare module "sap/f/FlexibleColumnLayoutSemanticHelper" {
   import FlexibleColumnLayout from "sap/f/FlexibleColumnLayout";
 
@@ -10328,8 +10598,10 @@ declare module "sap/f/routing/Router" {
    * The difference to the `{@link sap.ui.core.routing.Router}` are the `viewLevel`, `transition`, and `transitionParameters`
    * properties that you can specify in every Route or Target created by this router.
    *
-   * Additionally, the `layout` property can be specified in every Route, in which case it is applied to the
-   * root control.
+   * The difference to the `{@link sap.m.routing.Router}` is the additional `layout` property that can be
+   * specified in every Route, in which case it is applied to the root control. Also, the `sap.f.routing.Router`
+   * supports navigations that involve both change of `{@link sap.f.LayoutType}` and change of the current
+   * page within a single column of the `sap.f.FlexibleColumnLayout`.
    *
    * See `{@link sap.ui.core.routing.Router}` for the constructor arguments.
    */
@@ -10397,8 +10669,11 @@ declare module "sap/f/routing/TargetHandler" {
    * Used for closing dialogs and showing transitions in `NavContainers` when targets are displayed.
    *
    * **Note:** You should not create an own instance of this class. It is created when using `{@link sap.f.routing.Router}`
-   * or `{@link sap.f.routing.Targets}`. You may use the `{@link #setCloseDialogs}` function to specify if
-   * dialogs should be closed on displaying other views.
+   * or `{@link sap.f.routing.Targets}`.
+   *
+   * **Note:** You may use the `{@link #setCloseDialogs}` function to specify if dialogs should be closed
+   * on displaying other views. The dialogs are closed when a different target is displayed than the previously
+   * displayed one, otherwise the dialogs are kept open.
    */
   export default class TargetHandler extends BaseObject {
     /**
@@ -10406,10 +10681,10 @@ declare module "sap/f/routing/TargetHandler" {
      */
     constructor(
       /**
-       * Closes all open dialogs before navigating, if set to `true` (default). If set to `false`, it just navigates
-       * without closing dialogs.
+       * Closes all open dialogs before navigating to a different target, if set to `true` (default). If set to
+       * `false`, it will just navigate without closing dialogs.
        */
-      bCloseDialogs: boolean
+      closeDialogs: boolean
     );
 
     /**
@@ -10443,6 +10718,9 @@ declare module "sap/f/routing/TargetHandler" {
     getCloseDialogs(): boolean;
     /**
      * Sets if a navigation should close dialogs.
+     *
+     * **Note:** The dialogs are closed when a different target is displayed than the previous one, otherwise
+     * the dialogs are kept open even when `bCloseDialogs` is `true`.
      */
     setCloseDialogs(
       /**
@@ -13494,6 +13772,8 @@ declare module "sap/f/semantic/SemanticPage" {
      * The `customShareActions` are placed in the `ShareMenu` area of the `SemanticPage` title, right after
      * the semantic actions.
      *
+     * The text and icon of the button inside the `customShareActions` aggregation, can be customized.
+     *
      * **Note:** If the `titleSnappedOnMobile` aggregation is set, its content overrides this aggregation when
      * the control is viewed on a phone mobile device and the `SemanticPage` header is in its collapsed (snapped)
      * state.
@@ -15166,6 +15446,8 @@ declare module "sap/f/semantic/SemanticPage" {
      * The `customShareActions` are placed in the `ShareMenu` area of the `SemanticPage` title, right after
      * the semantic actions.
      *
+     * The text and icon of the button inside the `customShareActions` aggregation, can be customized.
+     *
      * **Note:** If the `titleSnappedOnMobile` aggregation is set, its content overrides this aggregation when
      * the control is viewed on a phone mobile device and the `SemanticPage` header is in its collapsed (snapped)
      * state.
@@ -16868,6 +17150,8 @@ declare namespace sap {
 
     "sap/f/FlexibleColumnLayout": undefined;
 
+    "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo": undefined;
+
     "sap/f/FlexibleColumnLayoutSemanticHelper": undefined;
 
     "sap/f/GridContainer": undefined;