@sapui5/ts-types 1.146.0 → 1.147.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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.commons.d.ts → commons-1.147.0-d.ts} +1 -1
  3. package/types/{sap.ui.core.d.ts → core-1.147.0-d.ts} +175 -16
  4. package/types/{sap.ui.dt.d.ts → dt-1.147.0-d.ts} +1 -1
  5. package/types/index.d.ts +7 -10
  6. package/types/{sap.ui.mdc.d.ts → mdc-1.147.0-d.ts} +107 -20
  7. package/types/{sap.m.d.ts → mobile-1.147.0-d.ts} +376 -127
  8. package/types/sap.apf.d.ts +1 -1
  9. package/types/sap.ca.ui.d.ts +1 -1
  10. package/types/sap.chart.d.ts +4 -7
  11. package/types/sap.collaboration.d.ts +1 -1
  12. package/types/sap.esh.search.ui.d.ts +1 -52
  13. package/types/sap.f.d.ts +144 -1
  14. package/types/sap.fe.ariba.d.ts +1 -1
  15. package/types/sap.fe.base.d.ts +1 -1
  16. package/types/sap.fe.controls.d.ts +1 -1
  17. package/types/sap.fe.core.d.ts +1 -1
  18. package/types/sap.fe.ina.d.ts +1 -1
  19. package/types/sap.fe.macros.d.ts +1666 -1005
  20. package/types/sap.fe.navigation.d.ts +1 -1
  21. package/types/sap.fe.placeholder.d.ts +1 -1
  22. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  23. package/types/sap.fe.templates.d.ts +1 -1
  24. package/types/sap.fe.test.d.ts +49 -1
  25. package/types/sap.fe.tools.d.ts +1 -1
  26. package/types/sap.feedback.ui.d.ts +1 -1
  27. package/types/sap.gantt.d.ts +182 -1
  28. package/types/sap.insights.d.ts +14 -1
  29. package/types/sap.makit.d.ts +1 -1
  30. package/types/sap.me.d.ts +1 -1
  31. package/types/sap.ndc.d.ts +1 -1
  32. package/types/sap.ovp.d.ts +1 -1
  33. package/types/sap.rules.ui.d.ts +1 -1
  34. package/types/sap.sac.df.d.ts +1 -1
  35. package/types/sap.suite.ui.commons.d.ts +122 -1
  36. package/types/sap.suite.ui.generic.template.d.ts +79 -1
  37. package/types/sap.suite.ui.microchart.d.ts +1 -1
  38. package/types/sap.ui.codeeditor.d.ts +82 -46
  39. package/types/sap.ui.comp.d.ts +5 -15
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +5 -1
  42. package/types/sap.ui.generic.app.d.ts +5 -5
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.geomap.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +23 -25
  46. package/types/sap.ui.layout.d.ts +1 -1
  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 +2 -2
  51. package/types/sap.ui.table.d.ts +1 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +6 -9
  54. package/types/sap.ui.vbm.d.ts +8 -24
  55. package/types/sap.ui.vk.d.ts +1 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +407 -66
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +146 -1
  61. package/types/sap.viz.d.ts +4 -5
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +1 -1
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
  66. package/types/{sap.tnt.d.ts → tnt-1.147.0-d.ts} +1 -4
  67. package/types/{sap.ui.ux3.d.ts → ux3-1.147.0-d.ts} +1 -1
  68. package/types/sap.ui.webc.common.d.ts +0 -173
  69. package/types/sap.ui.webc.fiori.d.ts +0 -16012
  70. package/types/sap.ui.webc.main.d.ts +0 -51158
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.1
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1080,6 +1080,16 @@ declare namespace sap {
1080
1080
  subSectionVisibilityChange?: (
1081
1081
  oEvent: ObjectPageLayout$SubSectionVisibilityChangeEvent
1082
1082
  ) => void;
1083
+
1084
+ /**
1085
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
1086
+ * (e.g., change Avatar sizes responsively).
1087
+ *
1088
+ * @since 1.147
1089
+ */
1090
+ breakpointChange?: (
1091
+ oEvent: ObjectPageLayout$BreakpointChangeEvent
1092
+ ) => void;
1083
1093
  }
1084
1094
 
1085
1095
  /**
@@ -1387,6 +1397,21 @@ declare namespace sap {
1387
1397
  subSection?: sap.uxap.ObjectPageSubSection;
1388
1398
  }
1389
1399
 
1400
+ /**
1401
+ * Parameters of the ObjectPageLayout#breakpointChange event.
1402
+ */
1403
+ interface ObjectPageLayout$BreakpointChangeEventParameters {
1404
+ /**
1405
+ * The name of the current media range ("Phone", "Tablet", "Desktop", or "DesktopExtraLarge").
1406
+ */
1407
+ currentRange?: sap.uxap.ObjectPageLayoutMediaRange;
1408
+
1409
+ /**
1410
+ * The current width of the control in pixels.
1411
+ */
1412
+ currentWidth?: int;
1413
+ }
1414
+
1390
1415
  /**
1391
1416
  * Parameters of the ObjectPageLayout#editHeaderButtonPress event.
1392
1417
  */
@@ -5174,6 +5199,59 @@ declare namespace sap {
5174
5199
  */
5175
5200
  oListener?: object
5176
5201
  ): this;
5202
+ /**
5203
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
5204
+ * this `sap.uxap.ObjectPageLayout`.
5205
+ *
5206
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5207
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
5208
+ *
5209
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
5210
+ * (e.g., change Avatar sizes responsively).
5211
+ *
5212
+ * @since 1.147
5213
+ *
5214
+ * @returns Reference to `this` in order to allow method chaining
5215
+ */
5216
+ attachBreakpointChange(
5217
+ /**
5218
+ * An application-specific payload object that will be passed to the event handler along with the event
5219
+ * object when firing the event
5220
+ */
5221
+ oData: object,
5222
+ /**
5223
+ * The function to be called when the event occurs
5224
+ */
5225
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
5226
+ /**
5227
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
5228
+ */
5229
+ oListener?: object
5230
+ ): this;
5231
+ /**
5232
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
5233
+ * this `sap.uxap.ObjectPageLayout`.
5234
+ *
5235
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
5236
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
5237
+ *
5238
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
5239
+ * (e.g., change Avatar sizes responsively).
5240
+ *
5241
+ * @since 1.147
5242
+ *
5243
+ * @returns Reference to `this` in order to allow method chaining
5244
+ */
5245
+ attachBreakpointChange(
5246
+ /**
5247
+ * The function to be called when the event occurs
5248
+ */
5249
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
5250
+ /**
5251
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
5252
+ */
5253
+ oListener?: object
5254
+ ): this;
5177
5255
  /**
5178
5256
  * Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
5179
5257
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5537,6 +5615,26 @@ declare namespace sap {
5537
5615
  */
5538
5616
  oListener?: object
5539
5617
  ): this;
5618
+ /**
5619
+ * Detaches event handler `fnFunction` from the {@link #event:breakpointChange breakpointChange} event of
5620
+ * this `sap.uxap.ObjectPageLayout`.
5621
+ *
5622
+ * The passed function and listener object must match the ones used for event registration.
5623
+ *
5624
+ * @since 1.147
5625
+ *
5626
+ * @returns Reference to `this` in order to allow method chaining
5627
+ */
5628
+ detachBreakpointChange(
5629
+ /**
5630
+ * The function to be called, when the event occurs
5631
+ */
5632
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
5633
+ /**
5634
+ * Context object on which the given function had to be called
5635
+ */
5636
+ oListener?: object
5637
+ ): this;
5540
5638
  /**
5541
5639
  * Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress }
5542
5640
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5675,6 +5773,20 @@ declare namespace sap {
5675
5773
  */
5676
5774
  mParameters?: sap.uxap.ObjectPageLayout$BeforeNavigateEventParameters
5677
5775
  ): boolean;
5776
+ /**
5777
+ * Fires event {@link #event:breakpointChange breakpointChange} to attached listeners.
5778
+ *
5779
+ * @since 1.147
5780
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5781
+ *
5782
+ * @returns Reference to `this` in order to allow method chaining
5783
+ */
5784
+ fireBreakpointChange(
5785
+ /**
5786
+ * Parameters to pass along with the event
5787
+ */
5788
+ mParameters?: sap.uxap.ObjectPageLayout$BreakpointChangeEventParameters
5789
+ ): this;
5678
5790
  /**
5679
5791
  * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
5680
5792
  *
@@ -8090,6 +8202,31 @@ declare namespace sap {
8090
8202
  */
8091
8203
  Square = "Square",
8092
8204
  }
8205
+ /**
8206
+ * Defines the media breakpoints for ObjectPageLayout.
8207
+ *
8208
+ * This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageLayoutMediaRange'.
8209
+ *
8210
+ * @since 1.147
8211
+ */
8212
+ enum ObjectPageLayoutMediaRange {
8213
+ /**
8214
+ * Desktop breakpoint (1025px to 1439px).
8215
+ */
8216
+ Desktop = "Desktop",
8217
+ /**
8218
+ * Extra large desktop breakpoint (1440px and above).
8219
+ */
8220
+ DesktopExtraLarge = "DesktopExtraLarge",
8221
+ /**
8222
+ * Phone breakpoint (up to 600px).
8223
+ */
8224
+ Phone = "Phone",
8225
+ /**
8226
+ * Tablet breakpoint (601px to 1024px).
8227
+ */
8228
+ Tablet = "Tablet",
8229
+ }
8093
8230
  /**
8094
8231
  * Used by the `ObjectPagSubSection` control to define which layout to apply.
8095
8232
  *
@@ -8168,6 +8305,14 @@ declare namespace sap {
8168
8305
  ObjectPageLayout
8169
8306
  >;
8170
8307
 
8308
+ /**
8309
+ * Event object of the ObjectPageLayout#breakpointChange event.
8310
+ */
8311
+ type ObjectPageLayout$BreakpointChangeEvent = sap.ui.base.Event<
8312
+ ObjectPageLayout$BreakpointChangeEventParameters,
8313
+ ObjectPageLayout
8314
+ >;
8315
+
8171
8316
  /**
8172
8317
  * Event object of the ObjectPageLayout#editHeaderButtonPress event.
8173
8318
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -612,7 +612,7 @@ declare namespace sap {
612
612
  /**
613
613
  * Describes the settings that can be provided to the Popover constructor.
614
614
  *
615
- * @experimental As of version 1.22.0. API is not finished yet and might change completely
615
+ * @experimental As of version 1.22.
616
616
  */
617
617
  interface $PopoverSettings
618
618
  extends sap.viz.ui5.controls.common.$BaseControlSettings {
@@ -871,8 +871,7 @@ declare namespace sap {
871
871
  /**
872
872
  * Viz Chart Popover
873
873
  *
874
- * @since 1.22.0
875
- * @experimental As of version 1.22.0. API is not finished yet and might change completely
874
+ * @experimental As of version 1.22.
876
875
  */
877
876
  class Popover extends sap.viz.ui5.controls.common.BaseControl {
878
877
  /**
@@ -3795,7 +3794,7 @@ declare namespace sap {
3795
3794
  * ```
3796
3795
  *
3797
3796
  *
3798
- * @experimental As of version 1.16.6. Might later be integrated into the selectData event.
3797
+ * @experimental As of version 1.16.
3799
3798
  *
3800
3799
  * @returns the model context for the given criteria or undefined.
3801
3800
  */
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace zen {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -357,7 +357,6 @@ declare namespace sap {
357
357
  * to achieve a Side Navigation Overlay Mode.
358
358
  *
359
359
  * @since 1.134
360
- * @experimental As of version 1.134.
361
360
  */
362
361
  design?:
363
362
  | sap.tnt.SideNavigationDesign
@@ -2563,7 +2562,6 @@ declare namespace sap {
2563
2562
  * Default value is `Decorated`.
2564
2563
  *
2565
2564
  * @since 1.134
2566
- * @experimental As of version 1.134.
2567
2565
  *
2568
2566
  * @returns Value of property `design`
2569
2567
  */
@@ -2658,7 +2656,6 @@ declare namespace sap {
2658
2656
  * Default value is `Decorated`.
2659
2657
  *
2660
2658
  * @since 1.134
2661
- * @experimental As of version 1.134.
2662
2659
  *
2663
2660
  * @returns Reference to `this` in order to allow method chaining
2664
2661
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,173 +0,0 @@
1
- // For Library Version: 1.146.0
2
-
3
- declare namespace sap {
4
- namespace ui {
5
- /**
6
- * Namespace for UI5 Web Components Retrofit libraries
7
- *
8
- * @since 1.92.0
9
- * @deprecated As of version 1.120. this Web Components consumption model has been discarded. An alternative
10
- * consumption model is planned for the future.
11
- * @experimental As of version 1.92.0.
12
- */
13
- namespace webc {
14
- /**
15
- * UI5 library: sap.ui.webc.common
16
- *
17
- * @since 1.92.0
18
- * @deprecated As of version 1.120. this Web Components consumption model has been discarded. An alternative
19
- * consumption model is planned for the future.
20
- * @experimental As of version 1.92.0.
21
- */
22
- namespace common {
23
- namespace WebComponent {
24
- /**
25
- * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
26
- * its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
27
- *
28
- * @deprecated As of version 1.118.0. because it is part of the deprecated package sap.ui.webc.common.WebComponent
29
- */
30
- type MetadataOptions = sap.ui.core.webc.WebComponent.MetadataOptions;
31
- }
32
- /**
33
- * Describes the settings that can be provided to the WebComponent constructor.
34
- *
35
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponent instead!
36
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
37
- */
38
- interface $WebComponentSettings
39
- extends sap.ui.core.webc.$WebComponentSettings {}
40
-
41
- /**
42
- * Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
43
- * UI5 programming model by using this wrapper control. This wrapper control takes care to propagate the
44
- * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
45
- * controls in the dedicated slots of the Web Component.
46
- *
47
- * @since 1.92.0
48
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponent instead!
49
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
50
- */
51
- class WebComponent extends sap.ui.core.webc.WebComponent {
52
- /**
53
- * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
54
- */
55
- constructor(
56
- /**
57
- * Object with initial settings for the new control
58
- */
59
- mSettings?: sap.ui.webc.common.$WebComponentSettings
60
- );
61
- /**
62
- * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
63
- */
64
- constructor(
65
- /**
66
- * Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
67
- * omitted, no matter whether `mSettings` will be given or not!
68
- */
69
- sId?: string,
70
- /**
71
- * Object with initial settings for the new control
72
- */
73
- mSettings?: sap.ui.webc.common.$WebComponentSettings
74
- );
75
-
76
- /**
77
- * Defines a new subclass of WebComponent with the name `sClassName` and enriches it with the information
78
- * contained in `oClassInfo`.
79
- *
80
- * `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
81
- * plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
82
- * for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
83
- * `WebComponent` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
84
- *
85
- * Example:
86
- * ```javascript
87
- *
88
- * WebComponent.extend('sap.mylib.MyElement', {
89
- * metadata : {
90
- * library : 'sap.mylib',
91
- * tag : 'my-webcomponent',
92
- * properties : {
93
- * value : 'string',
94
- * width : {
95
- * type: 'sap.ui.core.CSSSize',
96
- * mapping: 'style'
97
- * }
98
- * },
99
- * defaultAggregation: "content",
100
- * aggregations : {
101
- * content : {
102
- * type: 'sap.ui.core.Control',
103
- * multiple : true
104
- * },
105
- * header : {
106
- * type : 'sap.ui.core.Control',
107
- * multiple : false,
108
- * slot: 'header'
109
- * }
110
- * }
111
- * }
112
- * });
113
- * ```
114
- *
115
- *
116
- *
117
- * @returns Created class / constructor function
118
- */
119
- static extend<T extends Record<string, unknown>>(
120
- /**
121
- * Name of the class to be created
122
- */
123
- sClassName: string,
124
- /**
125
- * Object literal with information about the class
126
- */
127
- oClassInfo?: sap.ClassInfo<T, sap.ui.webc.common.WebComponent>,
128
- /**
129
- * Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
130
- */
131
- FNMetaImpl?: Function
132
- ): Function;
133
- /**
134
- * Returns a metadata object for class sap.ui.webc.common.WebComponent.
135
- *
136
- *
137
- * @returns Metadata object describing this class
138
- */
139
- static getMetadata(): sap.ui.webc.common.WebComponentMetadata;
140
- }
141
- /**
142
- * @since 1.92.0
143
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponentMetadata instead!
144
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
145
- */
146
- class WebComponentMetadata extends sap.ui.core.webc
147
- .WebComponentMetadata {
148
- /**
149
- * Creates a new metadata object for a WebComponent Wrapper subclass.
150
- */
151
- constructor(
152
- /**
153
- * fully qualified name of the class that is described by this metadata object
154
- */
155
- sClassName: string,
156
- /**
157
- * static info to construct the metadata from
158
- */
159
- oClassInfo: object
160
- );
161
- }
162
- }
163
- }
164
- }
165
-
166
- interface IUI5DefineDependencyNames {
167
- "sap/ui/webc/common/library": undefined;
168
-
169
- "sap/ui/webc/common/WebComponent": undefined;
170
-
171
- "sap/ui/webc/common/WebComponentMetadata": undefined;
172
- }
173
- }