@openui5/ts-types 1.130.0 → 1.131.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.130.0",
+  "version": "1.131.0",
   "description": "OpenUI5 TypeScript Definitions",
   "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.130.0
+// For Library Version: 1.131.0
 
 declare namespace sap {
   /**
@@ -129,6 +129,60 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the CardBadgeCustomData constructor.
+       */
+      interface $CardBadgeCustomDataSettings
+        extends sap.ui.core.$CustomDataSettings {
+        /**
+         * Icon URI. This may be either an icon font or image path.
+         *
+         * @since 1.128
+         */
+        icon?:
+          | sap.ui.core.URI
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Describes the corresponding visibility mode, see also {@link sap.f.CardBadgeVisibilityMode}.
+         *
+         * @since 1.128
+         */
+        visibilityMode?:
+          | sap.f.CardBadgeVisibilityMode
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Defines the color of the badge. The allowed values are from the enum type `sap.ui.core.IndicationColor`.
+         * Additionally values from `sap.ui.core.ValueState` can be used, but this is not recommended by design
+         * guidelines.
+         *
+         * @since 1.128
+         */
+        state?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * Defines the cards badge visibility.
+         *
+         * @since 1.128
+         */
+        visible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * Defines text which will is overriding default announcement.
+         *
+         * @since 1.128
+         */
+        announcementText?:
+          | string
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+      }
+
       /**
        * Describes the settings that can be provided to the Header constructor.
        */
@@ -871,9 +925,20 @@ declare namespace sap {
        *
        * @since 1.128
        */
-      class CardBadgeCustomData
-        extends /* was: sap..ui.core.CustomData */ Object
-      {
+      class CardBadgeCustomData extends sap.ui.core.CustomData {
+        /**
+         * Constructor for a new `CardBadgeCustomData` 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?: sap.f.cards.$CardBadgeCustomDataSettings
+        );
         /**
          * Constructor for a new `CardBadgeCustomData` element.
          *
@@ -889,14 +954,14 @@ declare namespace sap {
           /**
            * Initial settings for the new element
            */
-          mSettings?: object
+          mSettings?: sap.f.cards.$CardBadgeCustomDataSettings
         );
 
         /**
          * Creates a new subclass of class sap.f.cards.CardBadgeCustomData 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.CustomData.extend}.
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.CustomData.extend}.
          *
          *
          * @returns Created class / constructor function
@@ -922,7 +987,7 @@ declare namespace sap {
          *
          * @returns Metadata object describing this class
          */
-        static getMetadata(): sap.ui.base.Metadata;
+        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Gets current value of property {@link #getAnnouncementText announcementText}.
          *
@@ -2867,6 +2932,24 @@ declare namespace sap {
          */
         End = "End",
       }
+      /**
+       * Different options for the semantic role 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.SemanticRole'.
+       *
+       * @since 1.131
+       * @experimental
+       */
+      enum SemanticRole {
+        /**
+         * The card has interactive elements.
+         */
+        ListItem = "ListItem",
+        /**
+         * The card has no interactive elements.
+         */
+        Region = "Region",
+      }
       /**
        * Event object of the Header#press event.
        */
@@ -8319,8 +8402,6 @@ declare namespace sap {
      * Interface for controls suitable for the `additionalContent` aggregation of `{@link sap.f.ShellBar}`.
      *
      * @since 1.63
-     * @experimental (since 1.63) - that provides only limited functionality. Also, it can be removed in future
-     * versions.
      */
     interface IShellBar {
       __implements__sap_f_IShellBar: boolean;
@@ -8465,6 +8546,23 @@ declare namespace sap {
         | sap.ui.core.CSSSize
         | sap.ui.base.ManagedObject.PropertyBindingInfo
         | `{${string}}`;
+
+      /**
+       * Defines the role of the Card Header.
+       *
+       * @experimental (since 1.131)
+       */
+      semanticRole?:
+        | sap.f.cards.SemanticRole
+        | sap.ui.base.ManagedObject.PropertyBindingInfo
+        | `{${string}}`;
+
+      /**
+       * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+       *
+       * @experimental (since 1.131)
+       */
+      press?: (oEvent: sap.ui.base.Event) => void;
     }
 
     /**
@@ -10160,6 +10258,13 @@ declare namespace sap {
       avatarsDisplayed?: int;
     }
 
+    /**
+     * Parameters of the CardBase#press event.
+     *
+     * @experimental (since 1.131)
+     */
+    interface CardBase$PressEventParameters {}
+
     /**
      * Parameters of the DynamicPage#pinnedStateChange event.
      */
@@ -11712,6 +11817,88 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.CardBase`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.f.CardBase` itself.
+       *
+       * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+       *
+       * @experimental (since 1.131)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachPress(
+        /**
+         * An application-specific payload object that will be passed to the event handler along with the event
+         * object when firing the event
+         */
+        oData: object,
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.f.CardBase` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.CardBase`.
+       *
+       * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+       * otherwise it will be bound to this `sap.f.CardBase` itself.
+       *
+       * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+       *
+       * @experimental (since 1.131)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachPress(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.f.CardBase` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.f.CardBase`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       * @experimental (since 1.131)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachPress(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: sap.ui.base.Event) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Fires event {@link #event:press press} to attached listeners.
+       *
+       * @experimental (since 1.131)
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      firePress(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: object
+      ): this;
       /**
        * Returns the DOM Element that should get the focus.
        *
@@ -11731,6 +11918,18 @@ declare namespace sap {
        * @returns Value of property `height`
        */
       getHeight(): sap.ui.core.CSSSize;
+      /**
+       * Gets current value of property {@link #getSemanticRole semanticRole}.
+       *
+       * Defines the role of the Card Header.
+       *
+       * Default value is `Region`.
+       *
+       * @experimental (since 1.131)
+       *
+       * @returns Value of property `semanticRole`
+       */
+      getSemanticRole(): sap.f.cards.SemanticRole;
       /**
        * Gets current value of property {@link #getWidth width}.
        *
@@ -11760,6 +11959,25 @@ declare namespace sap {
          */
         sHeight?: sap.ui.core.CSSSize
       ): this;
+      /**
+       * Sets a new value for property {@link #getSemanticRole semanticRole}.
+       *
+       * Defines the role of the Card Header.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       *
+       * Default value is `Region`.
+       *
+       * @experimental (since 1.131)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      setSemanticRole(
+        /**
+         * New value for property `semanticRole`
+         */
+        sSemanticRole?: sap.f.cards.SemanticRole
+      ): this;
       /**
        * Sets a new value for property {@link #getWidth width}.
        *
@@ -22240,7 +22458,6 @@ declare namespace sap {
      * 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)
      */
     enum AvatarGroupType {
       /**
@@ -22549,6 +22766,16 @@ declare namespace sap {
       AvatarGroup
     >;
 
+    /**
+     * Event object of the CardBase#press event.
+     *
+     * @experimental (since 1.131)
+     */
+    type CardBase$PressEvent = sap.ui.base.Event<
+      CardBase$PressEventParameters,
+      CardBase
+    >;
+
     /**
      * Event object of the DynamicPage#pinnedStateChange event.
      */