@sapui5/ts-types-esm 1.147.2 → 1.148.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +7 -7
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +51 -11
  7. package/types/sap.esh.search.ui.d.ts +175 -34
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +52 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +19 -2
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +3 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +19 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/{mobile-1.147.0-esm-d.ts → sap.m.d.ts} +193 -36
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +2 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +1 -1
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/{tnt-1.147.0-esm-d.ts → sap.tnt.d.ts} +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/{commons-1.147.0-esm-d.ts → sap.ui.commons.d.ts} +1 -1
  36. package/types/sap.ui.comp.d.ts +198 -4
  37. package/types/{core-1.147.0-esm-d.ts → sap.ui.core.d.ts} +264 -20
  38. package/types/{dt-1.147.0-esm-d.ts → sap.ui.dt.d.ts} +1 -1
  39. package/types/sap.ui.export.d.ts +150 -1
  40. package/types/sap.ui.fl.d.ts +25 -1
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +6 -3
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/{mdc-1.147.0-esm-d.ts → sap.ui.mdc.d.ts} +237 -3
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +4 -4
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/{ux3-1.147.0-esm-d.ts → sap.ui.ux3.d.ts} +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +1 -1
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.uiext.inbox.d.ts +1 -1
  59. package/types/sap.ushell.d.ts +3 -3
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +1 -1
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. package/types/sap.zen.dsh.d.ts +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types-esm",
3
- "version": "1.147.2",
3
+ "version": "1.148.1",
4
4
  "description": "SAPUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/index.d.ts CHANGED
@@ -17,10 +17,10 @@
17
17
  /// <reference path="./sap.zen.dsh.d.ts"/>
18
18
  /// <reference path="./sap.zen.commons.d.ts"/>
19
19
  /// <reference path="./sap.sac.df.d.ts"/>
20
- /// <reference path="./commons-1.147.0-esm-d.ts"/>
20
+ /// <reference path="./sap.ui.commons.d.ts"/>
21
21
  /// <reference path="./sap.ui.comp.d.ts"/>
22
- /// <reference path="./core-1.147.0-esm-d.ts"/>
23
- /// <reference path="./dt-1.147.0-esm-d.ts"/>
22
+ /// <reference path="./sap.ui.core.d.ts"/>
23
+ /// <reference path="./sap.ui.dt.d.ts"/>
24
24
  /// <reference path="./sap.ui.export.d.ts"/>
25
25
  /// <reference path="./sap.f.d.ts"/>
26
26
  /// <reference path="./sap.ui.fl.d.ts"/>
@@ -33,8 +33,8 @@
33
33
  /// <reference path="./sap.ui.integration.d.ts"/>
34
34
  /// <reference path="./sap.ui.layout.d.ts"/>
35
35
  /// <reference path="./sap.makit.d.ts"/>
36
- /// <reference path="./mdc-1.147.0-esm-d.ts"/>
37
- /// <reference path="./mobile-1.147.0-esm-d.ts"/>
36
+ /// <reference path="./sap.ui.mdc.d.ts"/>
37
+ /// <reference path="./sap.m.d.ts"/>
38
38
  /// <reference path="./sap.me.d.ts"/>
39
39
  /// <reference path="./sap.ndc.d.ts"/>
40
40
  /// <reference path="./sap.ovp.d.ts"/>
@@ -70,12 +70,12 @@
70
70
  /// <reference path="./sap.ui.support.d.ts"/>
71
71
  /// <reference path="./sap.ui.table.d.ts"/>
72
72
  /// <reference path="./sap.ui.testrecorder.d.ts"/>
73
- /// <reference path="./tnt-1.147.0-esm-d.ts"/>
73
+ /// <reference path="./sap.tnt.d.ts"/>
74
74
  /// <reference path="./sap.ca.ui.d.ts"/>
75
75
  /// <reference path="./sap.ui.unified.d.ts"/>
76
76
  /// <reference path="./sap.ushell.d.ts"/>
77
77
  /// <reference path="./sap.ushell_abap.d.ts"/>
78
- /// <reference path="./ux3-1.147.0-esm-d.ts"/>
78
+ /// <reference path="./sap.ui.ux3.d.ts"/>
79
79
  /// <reference path="./sap.uxap.d.ts"/>
80
80
  /// <reference path="./sap.ui.vbm.d.ts"/>
81
81
  /// <reference path="./sap.viz.d.ts"/>
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.0
2
2
 
3
3
  declare module "sap/apf/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.0
2
2
 
3
3
  declare module "sap/ca/ui/library" {
4
4
  export namespace charts {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.1
1
+ // For Library Version: 1.148.0
2
2
 
3
3
  declare module "sap/chart/library" {
4
4
  import Dimension from "sap/chart/data/Dimension";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.0
2
2
 
3
3
  declare module "sap/collaboration/library" {
4
4
  /**
@@ -2062,16 +2062,11 @@ declare module "sap/collaboration/components/socialprofile/Component" {
2062
2062
 
2063
2063
  /**
2064
2064
  * Social Profile Component
2065
- *
2066
- * @experimental The API is not stable and the UI is not finalized. The implementation for this feature
2067
- * is subject to change.
2068
2065
  */
2069
2066
  export default class Component extends UIComponent {
2070
2067
  /**
2071
2068
  * Constructor for the Social Profile Component.
2072
2069
  *
2073
- * !!! EXPERIMENTAL !!!
2074
- *
2075
2070
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2076
2071
  * objects as well as event handlers.
2077
2072
  *
@@ -2088,8 +2083,6 @@ declare module "sap/collaboration/components/socialprofile/Component" {
2088
2083
  /**
2089
2084
  * Constructor for the Social Profile Component.
2090
2085
  *
2091
- * !!! EXPERIMENTAL !!!
2092
- *
2093
2086
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2094
2087
  * objects as well as event handlers.
2095
2088
  *
@@ -2306,9 +2299,6 @@ declare module "sap/collaboration/components/socialprofile/Component" {
2306
2299
  }
2307
2300
  /**
2308
2301
  * Describes the settings that can be provided to the Component constructor.
2309
- *
2310
- * @experimental The API is not stable and the UI is not finalized. The implementation for this feature
2311
- * is subject to change.
2312
2302
  */
2313
2303
  export interface $ComponentSettings extends $UIComponentSettings {
2314
2304
  placement?:
@@ -2844,6 +2834,54 @@ declare module "sap/collaboration/components/socialtimeline/Component" {
2844
2834
  >;
2845
2835
  }
2846
2836
 
2837
+ declare module "sap/collaboration/components/utils/DateUtil" {
2838
+ import BaseObject from "sap/ui/base/Object";
2839
+
2840
+ import Metadata from "sap/ui/base/Metadata";
2841
+
2842
+ /**
2843
+ * Language bundle for Collaboration
2844
+ */
2845
+ export default class DateUtil extends BaseObject {
2846
+ /**
2847
+ * Date Utility Class for Collaboration
2848
+ */
2849
+ constructor();
2850
+
2851
+ /**
2852
+ * Creates a new subclass of class sap.collaboration.components.util.DateUtil with name `sClassName` and
2853
+ * enriches it with the information contained in `oClassInfo`.
2854
+ *
2855
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2856
+ *
2857
+ *
2858
+ * @returns Created class / constructor function
2859
+ */
2860
+ static extend<T extends Record<string, unknown>>(
2861
+ /**
2862
+ * Name of the class being created
2863
+ */
2864
+ sClassName: string,
2865
+ /**
2866
+ * Object literal with information about the class
2867
+ */
2868
+ oClassInfo?: sap.ClassInfo<T, DateUtil>,
2869
+ /**
2870
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2871
+ * used by this class
2872
+ */
2873
+ FNMetaImpl?: Function
2874
+ ): Function;
2875
+ /**
2876
+ * Returns a metadata object for class sap.collaboration.components.util.DateUtil.
2877
+ *
2878
+ *
2879
+ * @returns Metadata object describing this class
2880
+ */
2881
+ static getMetadata(): Metadata;
2882
+ }
2883
+ }
2884
+
2847
2885
  declare namespace sap {
2848
2886
  interface IUI5DefineDependencyNames {
2849
2887
  "sap/collaboration/components/feed/Component": undefined;
@@ -2864,6 +2902,8 @@ declare namespace sap {
2864
2902
 
2865
2903
  "sap/collaboration/components/socialtimeline/Component": undefined;
2866
2904
 
2905
+ "sap/collaboration/components/utils/DateUtil": undefined;
2906
+
2867
2907
  "sap/collaboration/library": undefined;
2868
2908
  }
2869
2909
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.1
1
+ // For Library Version: 1.148.1
2
2
 
3
3
  declare module "sap/esh/search/ui/library" {}
4
4
 
@@ -1163,7 +1163,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1163
1163
  * Gets current value of property {@link #getBasketAddButton basketAddButton}.
1164
1164
  *
1165
1165
  * Enables the basket add button in the search result list. The button is displayed on the top of search
1166
- * result view and allows to add result view items to the basket.
1166
+ * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
1167
+ * — in that case items are added automatically via result view item selection and a manual add button is
1168
+ * redundant (a console warning is logged).
1167
1169
  *
1168
1170
  * Default value is `false`.
1169
1171
  *
@@ -1185,7 +1187,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1185
1187
  /**
1186
1188
  * Gets current value of property {@link #getBasketAddButtonText basketAddButtonText}.
1187
1189
  *
1188
- * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
1190
+ * Custom text of button 'add items to basket'. By default the text is empty and the button will show the
1189
1191
  * icon, only.
1190
1192
  *
1191
1193
  * @since 1.143.0
@@ -1196,7 +1198,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1196
1198
  /**
1197
1199
  * Gets current value of property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
1198
1200
  *
1199
- * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
1201
+ * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
1200
1202
  *
1201
1203
  * @since 1.143.0
1202
1204
  *
@@ -1252,7 +1254,11 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1252
1254
  *
1253
1255
  * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
1254
1256
  * Moreover all items of the basket are automatically selected on result views, if they are visible on the
1255
- * current result view page.
1257
+ * current result view page. The basket show/hide button is rendered as a toggle button. The left button
1258
+ * shows available items (label: "Available"), the right button shows selected items (label: "Selected").
1259
+ * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
1260
+ * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
1261
+ * and 'basketShowHideButtonTooltip'.
1256
1262
  *
1257
1263
  * Default value is `false`.
1258
1264
  *
@@ -1303,7 +1309,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1303
1309
  * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
1304
1310
  * is true, the width of the basket panel can be changed by the user.
1305
1311
  *
1306
- * Default value is `25`.
1312
+ * Default value is `100`.
1307
1313
  *
1308
1314
  * @since 1.142.0
1309
1315
  *
@@ -1311,18 +1317,55 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1311
1317
  */
1312
1318
  getBasketPanelWidthInPercent(): float;
1313
1319
  /**
1314
- * Gets current value of property {@link #getBasketShowHideButton basketShowHideButton}.
1320
+ * Gets current value of property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}.
1315
1321
  *
1316
- * Enables the basket toggle button in the search result list. The button is displayed on the top of search
1317
- * result view and allows to toggle visibility of the basket ('selected' result list items).
1322
+ * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
1323
+ * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
1324
+ * button.
1318
1325
  *
1319
- * Default value is `false`.
1326
+ * @since 1.148.0
1327
+ *
1328
+ * @returns Value of property `basketShowHideButtonIcon`
1329
+ */
1330
+ getBasketShowHideButtonIcon(): string;
1331
+ /**
1332
+ * Gets current value of property {@link #getBasketShowHideButtonText basketShowHideButtonText}.
1333
+ *
1334
+ * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
1335
+ * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
1336
+ * button.
1337
+ *
1338
+ * @since 1.148.0
1339
+ *
1340
+ * @returns Value of property `basketShowHideButtonText`
1341
+ */
1342
+ getBasketShowHideButtonText(): string;
1343
+ /**
1344
+ * Gets current value of property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}.
1345
+ *
1346
+ * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
1347
+ * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
1348
+ * toggle button.
1349
+ *
1350
+ * @since 1.148.0
1351
+ *
1352
+ * @returns Value of property `basketShowHideButtonTooltip`
1353
+ */
1354
+ getBasketShowHideButtonTooltip(): string;
1355
+ /**
1356
+ * Gets current value of property {@link #getBasketVisibilityButton basketVisibilityButton}.
1357
+ *
1358
+ * Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
1359
+ * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
1360
+ * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
1361
+ *
1362
+ * Default value is `true`.
1320
1363
  *
1321
1364
  * @since 1.143.0
1322
1365
  *
1323
- * @returns Value of property `basketShowHideButton`
1366
+ * @returns Value of property `basketVisibilityButton`
1324
1367
  */
1325
- getBasketShowHideButton(): boolean;
1368
+ getBasketVisibilityButton(): boolean;
1326
1369
  /**
1327
1370
  * Gets current value of property {@link #getBoSuggestions boSuggestions}.
1328
1371
  *
@@ -1358,7 +1401,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
1358
1401
  *
1359
1402
  * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
1360
1403
  * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
1361
- * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
1404
+ * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
1362
1405
  * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
1363
1406
  * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
1364
1407
  *
@@ -2101,7 +2144,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2101
2144
  * Sets a new value for property {@link #getBasketAddButton basketAddButton}.
2102
2145
  *
2103
2146
  * Enables the basket add button in the search result list. The button is displayed on the top of search
2104
- * result view and allows to add result view items to the basket.
2147
+ * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
2148
+ * — in that case items are added automatically via result view item selection and a manual add button is
2149
+ * redundant (a console warning is logged).
2105
2150
  *
2106
2151
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2107
2152
  *
@@ -2137,7 +2182,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2137
2182
  /**
2138
2183
  * Sets a new value for property {@link #getBasketAddButtonText basketAddButtonText}.
2139
2184
  *
2140
- * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
2185
+ * Custom text of button 'add items to basket'. By default the text is empty and the button will show the
2141
2186
  * icon, only.
2142
2187
  *
2143
2188
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -2155,7 +2200,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2155
2200
  /**
2156
2201
  * Sets a new value for property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
2157
2202
  *
2158
- * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
2203
+ * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
2159
2204
  *
2160
2205
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2161
2206
  *
@@ -2231,7 +2276,11 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2231
2276
  *
2232
2277
  * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
2233
2278
  * Moreover all items of the basket are automatically selected on result views, if they are visible on the
2234
- * current result view page.
2279
+ * current result view page. The basket show/hide button is rendered as a toggle button. The left button
2280
+ * shows available items (label: "Available"), the right button shows selected items (label: "Selected").
2281
+ * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
2282
+ * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
2283
+ * and 'basketShowHideButtonTooltip'.
2235
2284
  *
2236
2285
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2237
2286
  *
@@ -2305,7 +2354,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2305
2354
  *
2306
2355
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2307
2356
  *
2308
- * Default value is `25`.
2357
+ * Default value is `100`.
2309
2358
  *
2310
2359
  * @since 1.142.0
2311
2360
  *
@@ -2318,24 +2367,82 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2318
2367
  fBasketPanelWidthInPercent?: float
2319
2368
  ): this;
2320
2369
  /**
2321
- * Sets a new value for property {@link #getBasketShowHideButton basketShowHideButton}.
2370
+ * Sets a new value for property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}.
2322
2371
  *
2323
- * Enables the basket toggle button in the search result list. The button is displayed on the top of search
2324
- * result view and allows to toggle visibility of the basket ('selected' result list items).
2372
+ * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
2373
+ * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
2374
+ * button.
2325
2375
  *
2326
2376
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2327
2377
  *
2328
- * Default value is `false`.
2378
+ * @since 1.148.0
2379
+ *
2380
+ * @returns Reference to `this` in order to allow method chaining
2381
+ */
2382
+ setBasketShowHideButtonIcon(
2383
+ /**
2384
+ * New value for property `basketShowHideButtonIcon`
2385
+ */
2386
+ sBasketShowHideButtonIcon: string
2387
+ ): this;
2388
+ /**
2389
+ * Sets a new value for property {@link #getBasketShowHideButtonText basketShowHideButtonText}.
2390
+ *
2391
+ * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
2392
+ * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
2393
+ * button.
2394
+ *
2395
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2396
+ *
2397
+ * @since 1.148.0
2398
+ *
2399
+ * @returns Reference to `this` in order to allow method chaining
2400
+ */
2401
+ setBasketShowHideButtonText(
2402
+ /**
2403
+ * New value for property `basketShowHideButtonText`
2404
+ */
2405
+ sBasketShowHideButtonText: string
2406
+ ): this;
2407
+ /**
2408
+ * Sets a new value for property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}.
2409
+ *
2410
+ * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
2411
+ * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
2412
+ * toggle button.
2413
+ *
2414
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2415
+ *
2416
+ * @since 1.148.0
2417
+ *
2418
+ * @returns Reference to `this` in order to allow method chaining
2419
+ */
2420
+ setBasketShowHideButtonTooltip(
2421
+ /**
2422
+ * New value for property `basketShowHideButtonTooltip`
2423
+ */
2424
+ sBasketShowHideButtonTooltip: string
2425
+ ): this;
2426
+ /**
2427
+ * Sets a new value for property {@link #getBasketVisibilityButton basketVisibilityButton}.
2428
+ *
2429
+ * Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
2430
+ * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
2431
+ * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
2432
+ *
2433
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2434
+ *
2435
+ * Default value is `true`.
2329
2436
  *
2330
2437
  * @since 1.143.0
2331
2438
  *
2332
2439
  * @returns Reference to `this` in order to allow method chaining
2333
2440
  */
2334
- setBasketShowHideButton(
2441
+ setBasketVisibilityButton(
2335
2442
  /**
2336
- * New value for property `basketShowHideButton`
2443
+ * New value for property `basketVisibilityButton`
2337
2444
  */
2338
- bBasketShowHideButton?: boolean
2445
+ bBasketVisibilityButton?: boolean
2339
2446
  ): this;
2340
2447
  /**
2341
2448
  * Sets a new value for property {@link #getBoSuggestions boSuggestions}.
@@ -2378,7 +2485,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
2378
2485
  *
2379
2486
  * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
2380
2487
  * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
2381
- * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
2488
+ * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
2382
2489
  * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
2383
2490
  * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
2384
2491
  *
@@ -3660,7 +3767,11 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3660
3767
  /**
3661
3768
  * Items of the basket are automatically added/removed when selecting/deselecting items on result views.
3662
3769
  * Moreover all items of the basket are automatically selected on result views, if they are visible on the
3663
- * current result view page.
3770
+ * current result view page. The basket show/hide button is rendered as a toggle button. The left button
3771
+ * shows available items (label: "Available"), the right button shows selected items (label: "Selected").
3772
+ * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
3773
+ * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
3774
+ * and 'basketShowHideButtonTooltip'.
3664
3775
  *
3665
3776
  * @since 1.143.0
3666
3777
  */
@@ -3677,7 +3788,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3677
3788
  basketAddButtonIcon?: string | PropertyBindingInfo;
3678
3789
 
3679
3790
  /**
3680
- * Custom icon of button 'add items to basket'. By default the text is empty and the button will show the
3791
+ * Custom text of button 'add items to basket'. By default the text is empty and the button will show the
3681
3792
  * icon, only.
3682
3793
  *
3683
3794
  * @since 1.143.0
@@ -3685,12 +3796,39 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3685
3796
  basketAddButtonText?: string | PropertyBindingInfo;
3686
3797
 
3687
3798
  /**
3688
- * Custom icon of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
3799
+ * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
3689
3800
  *
3690
3801
  * @since 1.143.0
3691
3802
  */
3692
3803
  basketAddButtonTooltip?: string | PropertyBindingInfo;
3693
3804
 
3805
+ /**
3806
+ * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
3807
+ * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
3808
+ * button.
3809
+ *
3810
+ * @since 1.148.0
3811
+ */
3812
+ basketShowHideButtonIcon?: string | PropertyBindingInfo;
3813
+
3814
+ /**
3815
+ * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
3816
+ * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
3817
+ * button.
3818
+ *
3819
+ * @since 1.148.0
3820
+ */
3821
+ basketShowHideButtonText?: string | PropertyBindingInfo;
3822
+
3823
+ /**
3824
+ * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
3825
+ * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
3826
+ * toggle button.
3827
+ *
3828
+ * @since 1.148.0
3829
+ */
3830
+ basketShowHideButtonTooltip?: string | PropertyBindingInfo;
3831
+
3694
3832
  /**
3695
3833
  * When basket gets initialized, this callback is called with the columns of the (future) basket table.
3696
3834
  * You can add more columns or adjust the sequence of columns.
@@ -3721,7 +3859,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3721
3859
  /**
3722
3860
  * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
3723
3861
  * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
3724
- * (see config properties 'basketShowHideButton' and 'basketAddButton'). For the basket items collection,
3862
+ * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
3725
3863
  * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
3726
3864
  * 'add to basket') of result views with table/list is managed by SearchCompositeControl.
3727
3865
  *
@@ -3836,16 +3974,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
3836
3974
  showSelectionToggleButton?: boolean | PropertyBindingInfo | `{${string}}`;
3837
3975
 
3838
3976
  /**
3839
- * Enables the basket toggle button in the search result list. The button is displayed on the top of search
3840
- * result view and allows to toggle visibility of the basket ('selected' result list items).
3977
+ * Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
3978
+ * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
3979
+ * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
3841
3980
  *
3842
3981
  * @since 1.143.0
3843
3982
  */
3844
- basketShowHideButton?: boolean | PropertyBindingInfo | `{${string}}`;
3983
+ basketVisibilityButton?: boolean | PropertyBindingInfo | `{${string}}`;
3845
3984
 
3846
3985
  /**
3847
3986
  * Enables the basket add button in the search result list. The button is displayed on the top of search
3848
- * result view and allows to add result view items to the basket.
3987
+ * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
3988
+ * — in that case items are added automatically via result view item selection and a manual add button is
3989
+ * redundant (a console warning is logged).
3849
3990
  *
3850
3991
  * @since 1.143.0
3851
3992
  */
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.147.1
1
+ // For Library Version: 1.148.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.1
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.1
2
2
 
3
3
  declare namespace sap {}
@@ -418,7 +418,7 @@ declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
418
418
  }
419
419
  }
420
420
 
421
- // For Library Version: 1.147.0
421
+ // For Library Version: 1.148.1
422
422
 
423
423
  declare module "sap/fe/core/AppComponent" {
424
424
  import {
@@ -2056,6 +2056,55 @@ declare module "sap/fe/core/controllerextensions/Share" {
2056
2056
  }
2057
2057
  }
2058
2058
 
2059
+ declare module "sap/fe/core/controllerextensions/SideEffects" {
2060
+ import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
2061
+
2062
+ /**
2063
+ * A controller extension which provides hooks into the flow of event-driven side effects in the application.
2064
+ *
2065
+ * @since 1.148.0
2066
+ */
2067
+ export default class SideEffects extends ControllerExtension {
2068
+ /**
2069
+ * Hook called when an event-driven side effects message is received using a WebSocket.
2070
+ * This hook is called once per visible PageController for each incoming event.
2071
+ * Application developers can use it to do the following:
2072
+ *
2073
+ * - Execute custom logic.
2074
+ *
2075
+ * - Inspect app state and conditionally suppress the default refresh workflow
2076
+ * by returning a rejected promise.
2077
+ *
2078
+ * - Override the interaction type, such as (None / Notification / Confirmation), for this event.
2079
+ *
2080
+ * When multiple pages are visible simultaneously, for example, in a flexible column layout,
2081
+ * this hook is called once per visible page. If multiple pages return an interactionType override,
2082
+ * the last resolved value wins.
2083
+ * Returns a rejected promise that stops all further processing for this WebSocket event.
2084
+ *
2085
+ *
2086
+ * @since 1.148.0
2087
+ *
2088
+ * @returns A promise that resolves with an optional interactionType override, or rejects to stop processing.
2089
+ */
2090
+ onEventDrivenSideEffectsReceived(
2091
+ /**
2092
+ * Parameters forwarded from the WebSocket message.
2093
+ */
2094
+ _mParameters: {
2095
+ /**
2096
+ * The name of the side-effects event.
2097
+ */
2098
+ sideEffectEventName: string;
2099
+ /**
2100
+ * The OData path that is the source of the event.
2101
+ */
2102
+ sideEffectSource: string;
2103
+ }
2104
+ ): any;
2105
+ }
2106
+ }
2107
+
2059
2108
  declare module "sap/fe/core/controllerextensions/ViewState" {
2060
2109
  import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
2061
2110
 
@@ -2432,6 +2481,8 @@ declare namespace sap {
2432
2481
 
2433
2482
  "sap/fe/core/controllerextensions/Share": undefined;
2434
2483
 
2484
+ "sap/fe/core/controllerextensions/SideEffects": undefined;
2485
+
2435
2486
  "sap/fe/core/controllerextensions/ViewState": undefined;
2436
2487
 
2437
2488
  "sap/fe/core/controls/DataWatcher": undefined;
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.147.0
1
+ // For Library Version: 1.148.1
2
2
 
3
3
  declare namespace sap {}