@openui5/ts-types-esm 1.101.0 → 1.102.2

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare module "sap/ui/mdc/filterbar/vh/FilterContainer" {
   import Metadata from "sap/ui/base/Metadata";
@@ -29,6 +29,8 @@ declare module "sap/ui/mdc/filterbar/vh/FilterContainer" {
      * it with the information contained in `oClassInfo`.
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.filterbar.IFilterContainer.extend}.
+     *
+     * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
       /**
@@ -47,6 +49,8 @@ declare module "sap/ui/mdc/filterbar/vh/FilterContainer" {
     ): Function;
     /**
      * Returns a metadata object for class sap.ui.mdc.filterbar.vh.FilterContainer.
+     *
+     * @returns Metadata object describing this class
      */
     static getMetadata(): Metadata;
   }

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare module "sap/ui/rta/api/startAdaptation" {
   import Control from "sap/ui/core/Control";
@@ -12,6 +12,8 @@ declare module "sap/ui/rta/api/startAdaptation" {
    * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
    * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
    * be called on start, failed and stop events.
+   *
+   * @returns Resolves when UI adaptation was successfully started
    */
   export default function startAdaptation(
     /**
@@ -67,6 +69,8 @@ declare module "sap/ui/rta/api/startKeyUserAdaptation" {
    *
    * Starts key user adaptation, initiated for an application at the passed root control instance. It subsequently
    * extends to all valid child controls.
+   *
+   * @returns Resolves when UI adaptation was successfully started
    */
   export default function startKeyUserAdaptation(
     /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare module "sap/ui/suite/library" {
   /**
@@ -79,6 +79,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * information contained in `oClassInfo`.
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+     *
+     * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
       /**
@@ -97,10 +99,14 @@ declare module "sap/ui/suite/TaskCircle" {
     ): Function;
     /**
      * Returns a metadata object for class sap.ui.suite.TaskCircle.
+     *
+     * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     addAriaDescribedBy(
       /**
@@ -110,6 +116,8 @@ declare module "sap/ui/suite/TaskCircle" {
     ): this;
     /**
      * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     addAriaLabelledBy(
       /**
@@ -124,6 +132,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
      *
      * Event is fired when the user clicks the control.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     attachPress(
       /**
@@ -147,6 +157,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself.
      *
      * Event is fired when the user clicks the control.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     attachPress(
       /**
@@ -162,6 +174,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`.
      *
      * The passed function and listener object must match the ones used for event registration.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     detachPress(
       /**
@@ -175,6 +189,8 @@ declare module "sap/ui/suite/TaskCircle" {
     ): this;
     /**
      * Fires event {@link #event:press press} to attached listeners.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     firePress(
       /**
@@ -202,6 +218,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * Color of the circle. The default color is red.
      *
      * Default value is `Gray`.
+     *
+     * @returns Value of property `color`
      */
     getColor(): TaskCircleColor | keyof typeof TaskCircleColor;
     /**
@@ -210,6 +228,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * Upper limit of the displayed values. Default is 100.
      *
      * Default value is `100`.
+     *
+     * @returns Value of property `maxValue`
      */
     getMaxValue(): int;
     /**
@@ -218,6 +238,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * Lower limit of the displayed values. Default is 0.
      *
      * Default value is `0`.
+     *
+     * @returns Value of property `minValue`
      */
     getMinValue(): int;
     /**
@@ -227,18 +249,26 @@ declare module "sap/ui/suite/TaskCircle" {
      * it controls the size of the circle.
      *
      * Default value is `0`.
+     *
+     * @returns Value of property `value`
      */
     getValue(): int;
     /**
      * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns An array of the removed elements (might be empty)
      */
     removeAllAriaDescribedBy(): ID[];
     /**
      * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns An array of the removed elements (might be empty)
      */
     removeAllAriaLabelledBy(): ID[];
     /**
      * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns The removed ariaDescribedBy or `null`
      */
     removeAriaDescribedBy(
       /**
@@ -248,6 +278,8 @@ declare module "sap/ui/suite/TaskCircle" {
     ): ID;
     /**
      * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns The removed ariaLabelledBy or `null`
      */
     removeAriaLabelledBy(
       /**
@@ -263,6 +295,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * Default value is `Gray`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     setColor(
       /**
@@ -278,6 +312,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * 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
      */
     setMaxValue(
       /**
@@ -293,6 +329,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * Default value is `0`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     setMinValue(
       /**
@@ -309,6 +347,8 @@ declare module "sap/ui/suite/TaskCircle" {
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * Default value is `0`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     setValue(
       /**
@@ -323,24 +363,25 @@ declare module "sap/ui/suite/TaskCircle" {
      * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue
      * it controls the size of the circle.
      */
-    value?: int | PropertyBindingInfo;
+    value?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
      * Upper limit of the displayed values. Default is 100.
      */
-    maxValue?: int | PropertyBindingInfo;
+    maxValue?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
      * Lower limit of the displayed values. Default is 0.
      */
-    minValue?: int | PropertyBindingInfo;
+    minValue?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
      * Color of the circle. The default color is red.
      */
     color?:
       | (TaskCircleColor | keyof typeof TaskCircleColor)
-      | PropertyBindingInfo;
+      | PropertyBindingInfo
+      | `{${string}}`;
 
     /**
      * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).
@@ -413,6 +454,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * it with the information contained in `oClassInfo`.
      *
      * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+     *
+     * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
       /**
@@ -431,10 +474,14 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
     ): Function;
     /**
      * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
+     *
+     * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
     /**
      * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     addAriaDescribedBy(
       /**
@@ -444,6 +491,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
     ): this;
     /**
      * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     addAriaLabelledBy(
       /**
@@ -458,6 +507,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
      *
      * Event is fired when the user clicks the control.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     attachPress(
       /**
@@ -482,6 +533,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself.
      *
      * Event is fired when the user clicks the control.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     attachPress(
       /**
@@ -498,6 +551,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`.
      *
      * The passed function and listener object must match the ones used for event registration.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     detachPress(
       /**
@@ -511,6 +566,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
     ): this;
     /**
      * Fires event {@link #event:press press} to attached listeners.
+     *
+     * @returns Reference to `this` in order to allow method chaining
      */
     firePress(
       /**
@@ -537,18 +594,26 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      *
      * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
      * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
+     *
+     * @returns Value of property `percentage`
      */
     getPercentage(): int;
     /**
      * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns An array of the removed elements (might be empty)
      */
     removeAllAriaDescribedBy(): ID[];
     /**
      * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns An array of the removed elements (might be empty)
      */
     removeAllAriaLabelledBy(): ID[];
     /**
      * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}.
+     *
+     * @returns The removed ariaDescribedBy or `null`
      */
     removeAriaDescribedBy(
       /**
@@ -558,6 +623,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
     ): ID;
     /**
      * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
+     *
+     * @returns The removed ariaLabelledBy or `null`
      */
     removeAriaLabelledBy(
       /**
@@ -569,6 +636,8 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * Property setter for the Percentage, which determines the height of the vertical bar. Values higher than
      * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not
      * necessary, only the bar will be moved
+     *
+     * @returns `this` to allow method chaining
      */
     setPercentage(iPercentage: int): this;
   }
@@ -578,7 +647,7 @@ declare module "sap/ui/suite/VerticalProgressIndicator" {
      * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher
      * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.
      */
-    percentage?: int | PropertyBindingInfo;
+    percentage?: int | PropertyBindingInfo | `{${string}}`;
 
     /**
      * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.101.0
+// For Library Version: 1.102.2
 
 declare module "sap/ui/support/library" {
   /**
@@ -188,6 +188,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
      * @SINCE 1.60
      *
      * Adds new temporary rule when in silent mode
+     *
+     * @returns Rule creation status. Possible values are "success" or description of why adding failed.
      */
     addRule(
       /**
@@ -201,6 +203,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
      *
      * Allows to choose a particular execution scope - desired part of the UI to be checked and a flexible way
      * to specify the list of rules to be used.
+     *
+     * @returns Notifies the finished state by starting the Analyzer
      */
     analyze(
       /**
@@ -235,10 +239,15 @@ declare module "sap/ui/support/RuleAnalyzer" {
     ): Promise<any>;
     /**
      * Returns the history of all executed analyses.
+     *
+     * @returns Array of history objects in the order of analyses performed. The results of the last analysis
+     * are contained in the last element in the array.
      */
     getAnalysisHistory(): AnalysisResult[];
     /**
      * Returns the history of all executed analyses into formatted output depending on the passed format.
+     *
+     * @returns All analysis history objects in the correct format.
      */
     getFormattedAnalysisHistory(
       /**
@@ -248,6 +257,8 @@ declare module "sap/ui/support/RuleAnalyzer" {
     ): any;
     /**
      * Returns the result of the last analysis performed.
+     *
+     * @returns Last analysis history.
      */
     getLastAnalysisHistory(): AnalysisResult;
   }
@@ -275,6 +286,8 @@ declare namespace sap {
       namespace RuleSet {
         /**
          * Adds rules to RuleSet.
+         *
+         * @returns sRuleVerificationStatus Verification status
          */
         function addRule(
           /**
@@ -288,6 +301,8 @@ declare namespace sap {
         function clearAllRuleSets(): void;
         /**
          * Gets all rules from the RuleSet.
+         *
+         * @returns All rules within the current RuleSet
          */
         function getRules(): object;
         /**
@@ -320,6 +335,8 @@ declare namespace sap {
         ): void;
         /**
          * Updates rules from the RuleSet.
+         *
+         * @returns sRuleVerification Rule Verification status
          */
         function updateRule(
           /**
@@ -355,6 +372,10 @@ declare namespace sap {
       class ExecutionScope {
         constructor();
 
+        /**
+         *
+         * @returns Array of matched elements
+         */
         static getElements(
           /**
            * Object with specific filtering options
@@ -376,6 +397,8 @@ declare namespace sap {
         ): any[];
         /**
          * Gets elements by their type
+         *
+         * @returns Array of matched elements
          */
         static getElementsByClassName(
           /**
@@ -385,6 +408,8 @@ declare namespace sap {
         ): any[];
         /**
          * Gets the logged objects by object type
+         *
+         * @returns Array of logged objects
          */
         static getLoggedObjects(
           /**
@@ -394,10 +419,14 @@ declare namespace sap {
         ): any[];
         /**
          * Returns all public elements, i.e. elements that are part of public API aggregations
+         *
+         * @returns Array of matched elements
          */
         static getPublicElements(): any[];
         /**
          * Gets the type of the execution scope
+         *
+         * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
          */
         static getType(): string;
       }