@sapui5/ts-types 1.146.0 → 1.147.0

package/package.json

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

package/types/index.d.ts

@@ -79,6 +79,3 @@
 /// <reference path="./sap.uxap.d.ts"/>
 /// <reference path="./sap.ui.vbm.d.ts"/>
 /// <reference path="./sap.viz.d.ts"/>
-/// <reference path="./sap.ui.webc.common.d.ts"/>
-/// <reference path="./sap.ui.webc.fiori.d.ts"/>
-/// <reference path="./sap.ui.webc.main.d.ts"/>

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare namespace sap {
   /**
@@ -358,8 +358,7 @@ declare namespace sap {
         /**
          * The analytical extra information
          *
-         * @since 1.63
-         * @experimental
+         * @experimental As of version 1.63.
          */
         analyticalInfo?:
           | object
@@ -882,8 +881,7 @@ declare namespace sap {
          *
          * The analytical extra information
          *
-         * @since 1.63
-         * @experimental
+         * @experimental As of version 1.63.
          *
          * @returns Value of property `analyticalInfo`
          */
@@ -995,8 +993,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
-         * @since 1.63
-         * @experimental
+         * @experimental As of version 1.63.
          *
          * @returns Reference to `this` in order to allow method chaining
          */

package/types/sap.collaboration.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.1
+// For Library Version: 1.147.1
 
 declare namespace sap {
   namespace esh {
@@ -11,16 +11,12 @@ declare namespace sap {
           namespace basket {
             /**
              * Describes the settings that can be provided to the CustomBasket constructor.
-             *
-             * @experimental As of version 1.144.0.
              */
             interface $CustomBasketSettings
               extends sap.ui.layout.$VerticalLayoutSettings {}
 
             /**
              * Describes the settings that can be provided to the SearchBasketAddButton constructor.
-             *
-             * @experimental As of version 1.143.0.
              */
             interface $SearchBasketAddButtonSettings
               extends sap.m.$OverflowToolbarButtonSettings {}
@@ -31,7 +27,6 @@ declare namespace sap {
              * with control SearchCompositeControl by the Enterprise Search Team.
              *
              * @since 1.144.0
-             * @experimental As of version 1.144.0.
              */
             class CustomBasket extends sap.ui.layout.VerticalLayout {
               /**
@@ -54,7 +49,6 @@ declare namespace sap {
              * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team.
              *
              * @since 1.143.0
-             * @experimental As of version 1.143.0.
              */
             class SearchBasketAddButton extends sap.m.OverflowToolbarButton {
               /**
@@ -656,7 +650,6 @@ declare namespace sap {
            * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar".
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            */
           searchInputLocation?:
             | string
@@ -743,7 +736,6 @@ declare namespace sap {
            * 'facets'.
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            */
           facetToggleButtonLocation?:
             | string
@@ -755,7 +747,6 @@ declare namespace sap {
            * values are "Begin", "Middle" and "End".
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketButtonsLocation?:
             | string
@@ -767,7 +758,6 @@ declare namespace sap {
            * current result view page.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketLinkByResultViewItemSelection?:
             | boolean
@@ -778,7 +768,6 @@ declare namespace sap {
            * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketAddButtonIcon?:
             | string
@@ -789,7 +778,6 @@ declare namespace sap {
            * icon, only.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketAddButtonText?:
             | string
@@ -799,7 +787,6 @@ declare namespace sap {
            * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketAddButtonTooltip?:
             | string
@@ -810,7 +797,6 @@ declare namespace sap {
            * You can add more columns or adjust the sequence of columns.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            */
           basketInit?:
             | Function
@@ -822,7 +808,6 @@ declare namespace sap {
            * the new basket item You can adjust the model data of the basket item.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            */
           basketBeforeAddItem?:
             | Function
@@ -996,7 +981,6 @@ declare namespace sap {
            * result view and allows to toggle visibility of the basket ('selected' result list items).
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketShowHideButton?:
             | boolean
@@ -1008,7 +992,6 @@ declare namespace sap {
            * result view and allows to add result view items to the basket.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            */
           basketAddButton?:
             | boolean
@@ -1122,15 +1105,12 @@ declare namespace sap {
            * current number of items in basket
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            */
           basketChanged?: (oEvent: sap.ui.base.Event) => void;
         }
 
         /**
          * Parameters of the SearchCompositeControl#basketChanged event.
-         *
-         * @experimental As of version 1.144.0.
          */
         interface SearchCompositeControl$BasketChangedEventParameters {}
 
@@ -1263,7 +1243,6 @@ declare namespace sap {
            * current number of items in basket
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -1293,7 +1272,6 @@ declare namespace sap {
            * current number of items in basket
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -1712,7 +1690,6 @@ declare namespace sap {
            * The passed function and listener object must match the ones used for event registration.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -1850,7 +1827,6 @@ declare namespace sap {
            * Fires event {@link #event:basketChanged basketChanged} to attached listeners.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            * @ui5-protected Do not call from applications (only from related classes in the framework)
            *
            * @returns Reference to `this` in order to allow method chaining
@@ -1988,7 +1964,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketAddButton`
            */
@@ -1999,7 +1974,6 @@ declare namespace sap {
            * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4".
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketAddButtonIcon`
            */
@@ -2011,7 +1985,6 @@ declare namespace sap {
            * icon, only.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketAddButtonText`
            */
@@ -2022,7 +1995,6 @@ declare namespace sap {
            * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketAddButtonTooltip`
            */
@@ -2034,7 +2006,6 @@ declare namespace sap {
            * the new basket item You can adjust the model data of the basket item.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Value of property `basketBeforeAddItem`
            */
@@ -2049,7 +2020,6 @@ declare namespace sap {
            * Default value is `"End"`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketButtonsLocation`
            */
@@ -2061,7 +2031,6 @@ declare namespace sap {
            * You can add more columns or adjust the sequence of columns.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Value of property `basketInit`
            */
@@ -2070,7 +2039,6 @@ declare namespace sap {
            * Get items of the latest search basket ('selected items', JSON model) The model is read-only.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns A JSON model containing items of the search basket ('selected items')
            */
@@ -2085,7 +2053,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketLinkByResultViewItemSelection`
            */
@@ -2122,7 +2089,6 @@ declare namespace sap {
            * Get visibility status of basket panel
            *
            * @since 1.146.0
-           * @experimental As of version 1.143.0.
            *
            * @returns boolean The visibility status of basket panel
            */
@@ -2149,7 +2115,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Value of property `basketShowHideButton`
            */
@@ -2352,7 +2317,6 @@ declare namespace sap {
            * Default value is `"Begin"`.
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            *
            * @returns Value of property `facetToggleButtonLocation`
            */
@@ -2718,7 +2682,6 @@ declare namespace sap {
            * Default value is `"Top"`.
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            *
            * @returns Value of property `searchInputLocation`
            */
@@ -2941,7 +2904,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -2959,7 +2921,6 @@ declare namespace sap {
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -2978,7 +2939,6 @@ declare namespace sap {
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -2996,7 +2956,6 @@ declare namespace sap {
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3015,7 +2974,6 @@ declare namespace sap {
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3037,7 +2995,6 @@ declare namespace sap {
            * Default value is `"End"`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3056,7 +3013,6 @@ declare namespace sap {
            * When called with a value of `null` or `undefined`, the default value of the property will be restored.
            *
            * @since 1.144.0
-           * @experimental As of version 1.144.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3078,7 +3034,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3134,7 +3089,6 @@ declare namespace sap {
            * Set visibility status of basket panel
            *
            * @since 1.146.0
-           * @experimental As of version 1.143.0.
            *
            * @returns boolean The visibility status of basket panel
            */
@@ -3170,7 +3124,6 @@ declare namespace sap {
            * Default value is `false`.
            *
            * @since 1.143.0
-           * @experimental As of version 1.143.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3473,7 +3426,6 @@ declare namespace sap {
            * Default value is `"Begin"`.
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -3994,7 +3946,6 @@ declare namespace sap {
            * Default value is `"Top"`.
            *
            * @since 1.140.0
-           * @experimental As of version 1.140.0.
            *
            * @returns Reference to `this` in order to allow method chaining
            */
@@ -4168,8 +4119,6 @@ declare namespace sap {
 
         /**
          * Event object of the SearchCompositeControl#basketChanged event.
-         *
-         * @experimental As of version 1.144.0.
          */
         type SearchCompositeControl$BasketChangedEvent = sap.ui.base.Event<
           SearchCompositeControl$BasketChangedEventParameters,

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 declare namespace sap {
   /**
@@ -8328,6 +8328,14 @@ declare namespace sap {
        * @since 1.93
        */
       pinnedStateChange?: (oEvent: DynamicPage$PinnedStateChangeEvent) => void;
+
+      /**
+       * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
+       * based on the current screen size.
+       *
+       * @since 1.147
+       */
+      breakpointChange?: (oEvent: DynamicPage$BreakpointChangeEvent) => void;
     }
 
     /**
@@ -9878,6 +9886,21 @@ declare namespace sap {
      */
     interface CardBase$PressEventParameters {}
 
+    /**
+     * Parameters of the DynamicPage#breakpointChange event.
+     */
+    interface DynamicPage$BreakpointChangeEventParameters {
+      /**
+       * The current media range as defined by {@link sap.f.DynamicPageMediaRange}.
+       */
+      currentRange?: sap.f.DynamicPageMediaRange;
+
+      /**
+       * The current width of the control in pixels.
+       */
+      currentWidth?: int;
+    }
+
     /**
      * Parameters of the DynamicPage#pinnedStateChange event.
      */
@@ -11740,6 +11763,59 @@ declare namespace sap {
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
+       * this `sap.f.DynamicPage`.
+       *
+       * 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.DynamicPage` itself.
+       *
+       * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
+       * based on the current screen size.
+       *
+       * @since 1.147
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachBreakpointChange(
+        /**
+         * 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: DynamicPage$BreakpointChangeEvent) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.f.DynamicPage` itself
+         */
+        oListener?: object
+      ): this;
+      /**
+       * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
+       * this `sap.f.DynamicPage`.
+       *
+       * 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.DynamicPage` itself.
+       *
+       * The event is fired when the media breakpoint changes. Applications can use this event to adjust content
+       * based on the current screen size.
+       *
+       * @since 1.147
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      attachBreakpointChange(
+        /**
+         * The function to be called when the event occurs
+         */
+        fnFunction: (p1: DynamicPage$BreakpointChangeEvent) => void,
+        /**
+         * Context object to call the event handler with. Defaults to this `sap.f.DynamicPage` itself
+         */
+        oListener?: object
+      ): this;
       /**
        * Attaches event handler `fnFunction` to the {@link #event:pinnedStateChange pinnedStateChange} event of
        * this `sap.f.DynamicPage`.
@@ -11827,6 +11903,26 @@ declare namespace sap {
        * @returns Reference to `this` in order to allow method chaining
        */
       destroyTitle(): this;
+      /**
+       * Detaches event handler `fnFunction` from the {@link #event:breakpointChange breakpointChange} event of
+       * this `sap.f.DynamicPage`.
+       *
+       * The passed function and listener object must match the ones used for event registration.
+       *
+       * @since 1.147
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      detachBreakpointChange(
+        /**
+         * The function to be called, when the event occurs
+         */
+        fnFunction: (p1: DynamicPage$BreakpointChangeEvent) => void,
+        /**
+         * Context object on which the given function had to be called
+         */
+        oListener?: object
+      ): this;
       /**
        * Detaches event handler `fnFunction` from the {@link #event:pinnedStateChange pinnedStateChange} event
        * of this `sap.f.DynamicPage`.
@@ -11847,6 +11943,20 @@ declare namespace sap {
          */
         oListener?: object
       ): this;
+      /**
+       * Fires event {@link #event:breakpointChange breakpointChange} to attached listeners.
+       *
+       * @since 1.147
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
+       * @returns Reference to `this` in order to allow method chaining
+       */
+      fireBreakpointChange(
+        /**
+         * Parameters to pass along with the event
+         */
+        mParameters?: sap.f.DynamicPage$BreakpointChangeEventParameters
+      ): this;
       /**
        * Fires event {@link #event:pinnedStateChange pinnedStateChange} to attached listeners.
        *
@@ -22181,6 +22291,31 @@ declare namespace sap {
        */
       Persist = "Persist",
     }
+    /**
+     * Defines the media breakpoints for DynamicPage.
+     *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'DynamicPageMediaRange'.
+     *
+     * @since 1.147
+     */
+    enum DynamicPageMediaRange {
+      /**
+       * Desktop breakpoint (1025px to 1439px).
+       */
+      Desktop = "Desktop",
+      /**
+       * Desktop Extra Large breakpoint (1440px and above).
+       */
+      DesktopExtraLarge = "DesktopExtraLarge",
+      /**
+       * Phone breakpoint (up to 600px).
+       */
+      Phone = "Phone",
+      /**
+       * Tablet breakpoint (601px to 1024px).
+       */
+      Tablet = "Tablet",
+    }
     /**
      * Defines the areas within the `sap.f.DynamicPageTitle` control.
      *
@@ -22470,6 +22605,14 @@ declare namespace sap {
       CardBase
     >;
 
+    /**
+     * Event object of the DynamicPage#breakpointChange event.
+     */
+    type DynamicPage$BreakpointChangeEvent = sap.ui.base.Event<
+      DynamicPage$BreakpointChangeEventParameters,
+      DynamicPage
+    >;
+
     /**
      * Event object of the DynamicPage#pinnedStateChange event.
      */

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.146.0
+// For Library Version: 1.147.0
 
 
 declare namespace sap {

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

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

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

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

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

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