@sapui5/ts-types-esm 1.146.0 → 1.147.0

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 (69) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -3
  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 +4 -7
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +1 -52
  8. package/types/sap.f.d.ts +148 -2
  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 +1 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +3892 -3211
  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 +1 -1
  18. package/types/sap.fe.test.d.ts +49 -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 +184 -1
  22. package/types/sap.insights.d.ts +14 -1
  23. package/types/sap.m.d.ts +371 -127
  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 +1 -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 +122 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +79 -1
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -4
  34. package/types/sap.ui.codeeditor.d.ts +82 -46
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +5 -15
  37. package/types/sap.ui.core.d.ts +172 -16
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +5 -1
  41. package/types/sap.ui.generic.app.d.ts +5 -5
  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 +23 -25
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +112 -21
  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.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +8 -24
  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 +416 -67
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +151 -2
  62. package/types/sap.viz.d.ts +4 -5
  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
  67. package/types/sap.ui.webc.common.d.ts +0 -164
  68. package/types/sap.ui.webc.fiori.d.ts +0 -16235
  69. package/types/sap.ui.webc.main.d.ts +0 -51365
@@ -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
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**
@@ -136,6 +136,31 @@ declare module "sap/uxap/library" {
136
136
  */
137
137
  Square = "Square",
138
138
  }
139
+ /**
140
+ * Defines the media breakpoints for ObjectPageLayout.
141
+ *
142
+ * This enum is part of the 'sap/uxap/library' module export and must be accessed by the property 'ObjectPageLayoutMediaRange'.
143
+ *
144
+ * @since 1.147
145
+ */
146
+ export enum ObjectPageLayoutMediaRange {
147
+ /**
148
+ * Desktop breakpoint (1025px to 1439px).
149
+ */
150
+ Desktop = "Desktop",
151
+ /**
152
+ * Extra large desktop breakpoint (1440px and above).
153
+ */
154
+ DesktopExtraLarge = "DesktopExtraLarge",
155
+ /**
156
+ * Phone breakpoint (up to 600px).
157
+ */
158
+ Phone = "Phone",
159
+ /**
160
+ * Tablet breakpoint (601px to 1024px).
161
+ */
162
+ Tablet = "Tablet",
163
+ }
139
164
  /**
140
165
  * Used by the `ObjectPagSubSection` control to define which layout to apply.
141
166
  *
@@ -4504,7 +4529,11 @@ declare module "sap/uxap/ObjectPageLayout" {
4504
4529
 
4505
4530
  import { BackgroundDesign, IBar } from "sap/m/library";
4506
4531
 
4507
- import { IHeaderTitle, ObjectPageSubSectionLayout } from "sap/uxap/library";
4532
+ import {
4533
+ IHeaderTitle,
4534
+ ObjectPageSubSectionLayout,
4535
+ ObjectPageLayoutMediaRange,
4536
+ } from "sap/uxap/library";
4508
4537
 
4509
4538
  import { CSSSize, TitleLevel, ID } from "sap/ui/core/library";
4510
4539
 
@@ -4720,6 +4749,59 @@ declare module "sap/uxap/ObjectPageLayout" {
4720
4749
  */
4721
4750
  oListener?: object
4722
4751
  ): this;
4752
+ /**
4753
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4754
+ * this `sap.uxap.ObjectPageLayout`.
4755
+ *
4756
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4757
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4758
+ *
4759
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
4760
+ * (e.g., change Avatar sizes responsively).
4761
+ *
4762
+ * @since 1.147
4763
+ *
4764
+ * @returns Reference to `this` in order to allow method chaining
4765
+ */
4766
+ attachBreakpointChange(
4767
+ /**
4768
+ * An application-specific payload object that will be passed to the event handler along with the event
4769
+ * object when firing the event
4770
+ */
4771
+ oData: object,
4772
+ /**
4773
+ * The function to be called when the event occurs
4774
+ */
4775
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
4776
+ /**
4777
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4778
+ */
4779
+ oListener?: object
4780
+ ): this;
4781
+ /**
4782
+ * Attaches event handler `fnFunction` to the {@link #event:breakpointChange breakpointChange} event of
4783
+ * this `sap.uxap.ObjectPageLayout`.
4784
+ *
4785
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
4786
+ * otherwise it will be bound to this `sap.uxap.ObjectPageLayout` itself.
4787
+ *
4788
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
4789
+ * (e.g., change Avatar sizes responsively).
4790
+ *
4791
+ * @since 1.147
4792
+ *
4793
+ * @returns Reference to `this` in order to allow method chaining
4794
+ */
4795
+ attachBreakpointChange(
4796
+ /**
4797
+ * The function to be called when the event occurs
4798
+ */
4799
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
4800
+ /**
4801
+ * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
4802
+ */
4803
+ oListener?: object
4804
+ ): this;
4723
4805
  /**
4724
4806
  * Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
4725
4807
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5083,6 +5165,26 @@ declare module "sap/uxap/ObjectPageLayout" {
5083
5165
  */
5084
5166
  oListener?: object
5085
5167
  ): this;
5168
+ /**
5169
+ * Detaches event handler `fnFunction` from the {@link #event:breakpointChange breakpointChange} event of
5170
+ * this `sap.uxap.ObjectPageLayout`.
5171
+ *
5172
+ * The passed function and listener object must match the ones used for event registration.
5173
+ *
5174
+ * @since 1.147
5175
+ *
5176
+ * @returns Reference to `this` in order to allow method chaining
5177
+ */
5178
+ detachBreakpointChange(
5179
+ /**
5180
+ * The function to be called, when the event occurs
5181
+ */
5182
+ fnFunction: (p1: ObjectPageLayout$BreakpointChangeEvent) => void,
5183
+ /**
5184
+ * Context object on which the given function had to be called
5185
+ */
5186
+ oListener?: object
5187
+ ): this;
5086
5188
  /**
5087
5189
  * Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress }
5088
5190
  * event of this `sap.uxap.ObjectPageLayout`.
@@ -5221,6 +5323,20 @@ declare module "sap/uxap/ObjectPageLayout" {
5221
5323
  */
5222
5324
  mParameters?: ObjectPageLayout$BeforeNavigateEventParameters
5223
5325
  ): boolean;
5326
+ /**
5327
+ * Fires event {@link #event:breakpointChange breakpointChange} to attached listeners.
5328
+ *
5329
+ * @since 1.147
5330
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
5331
+ *
5332
+ * @returns Reference to `this` in order to allow method chaining
5333
+ */
5334
+ fireBreakpointChange(
5335
+ /**
5336
+ * Parameters to pass along with the event
5337
+ */
5338
+ mParameters?: ObjectPageLayout$BreakpointChangeEventParameters
5339
+ ): this;
5224
5340
  /**
5225
5341
  * Fires event {@link #event:editHeaderButtonPress editHeaderButtonPress} to attached listeners.
5226
5342
  *
@@ -6665,6 +6781,14 @@ declare module "sap/uxap/ObjectPageLayout" {
6665
6781
  subSectionVisibilityChange?: (
6666
6782
  oEvent: ObjectPageLayout$SubSectionVisibilityChangeEvent
6667
6783
  ) => void;
6784
+
6785
+ /**
6786
+ * Fired when the media range of the control changes, allowing the application to adjust the UI accordingly
6787
+ * (e.g., change Avatar sizes responsively).
6788
+ *
6789
+ * @since 1.147
6790
+ */
6791
+ breakpointChange?: (oEvent: ObjectPageLayout$BreakpointChangeEvent) => void;
6668
6792
  }
6669
6793
 
6670
6794
  /**
@@ -6690,6 +6814,31 @@ declare module "sap/uxap/ObjectPageLayout" {
6690
6814
  ObjectPageLayout
6691
6815
  >;
6692
6816
 
6817
+ /**
6818
+ * Parameters of the ObjectPageLayout#breakpointChange event.
6819
+ */
6820
+ export interface ObjectPageLayout$BreakpointChangeEventParameters {
6821
+ /**
6822
+ * The name of the current media range ("Phone", "Tablet", "Desktop", or "DesktopExtraLarge").
6823
+ */
6824
+ currentRange?:
6825
+ | ObjectPageLayoutMediaRange
6826
+ | keyof typeof ObjectPageLayoutMediaRange;
6827
+
6828
+ /**
6829
+ * The current width of the control in pixels.
6830
+ */
6831
+ currentWidth?: int;
6832
+ }
6833
+
6834
+ /**
6835
+ * Event object of the ObjectPageLayout#breakpointChange event.
6836
+ */
6837
+ export type ObjectPageLayout$BreakpointChangeEvent = Event<
6838
+ ObjectPageLayout$BreakpointChangeEventParameters,
6839
+ ObjectPageLayout
6840
+ >;
6841
+
6693
6842
  /**
6694
6843
  * Parameters of the ObjectPageLayout#editHeaderButtonPress event.
6695
6844
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/viz/library" {
4
4
  export namespace ui5 {
@@ -9282,8 +9282,7 @@ declare module "sap/viz/ui5/controls/Popover" {
9282
9282
  /**
9283
9283
  * Viz Chart Popover
9284
9284
  *
9285
- * @since 1.22.0
9286
- * @experimental As of version 1.22.0. API is not finished yet and might change completely
9285
+ * @experimental As of version 1.22.
9287
9286
  */
9288
9287
  export default class Popover extends BaseControl {
9289
9288
  /**
@@ -9475,7 +9474,7 @@ declare module "sap/viz/ui5/controls/Popover" {
9475
9474
  /**
9476
9475
  * Describes the settings that can be provided to the Popover constructor.
9477
9476
  *
9478
- * @experimental As of version 1.22.0. API is not finished yet and might change completely
9477
+ * @experimental As of version 1.22.
9479
9478
  */
9480
9479
  export interface $PopoverSettings extends $BaseControlSettings {
9481
9480
  /**
@@ -12361,7 +12360,7 @@ declare module "sap/viz/ui5/data/FlattenedDataset" {
12361
12360
  * ```
12362
12361
  *
12363
12362
  *
12364
- * @experimental As of version 1.16.6. Might later be integrated into the selectData event.
12363
+ * @experimental As of version 1.16.
12365
12364
  *
12366
12365
  * @returns the model context for the given criteria or undefined.
12367
12366
  */
@@ -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 module "sap/zen/commons/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/zen/crosstab/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.146.0
1
+ // For Library Version: 1.147.0
2
2
 
3
3
  declare module "sap/zen/dsh/library" {}
4
4
 
@@ -1,164 +0,0 @@
1
- // For Library Version: 1.146.0
2
-
3
- declare module "sap/ui/webc/common/library" {}
4
-
5
- declare module "sap/ui/webc/common/WebComponent" {
6
- import {
7
- default as WebComponent1,
8
- MetadataOptions as MetadataOptions1,
9
- $WebComponentSettings as $WebComponentSettings1,
10
- } from "sap/ui/core/webc/WebComponent";
11
-
12
- import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
13
-
14
- /**
15
- * Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
16
- * UI5 programming model by using this wrapper control. This wrapper control takes care to propagate the
17
- * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
18
- * controls in the dedicated slots of the Web Component.
19
- *
20
- * @since 1.92.0
21
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponent instead!
22
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
23
- */
24
- export default class WebComponent extends WebComponent1 {
25
- /**
26
- * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
27
- */
28
- constructor(
29
- /**
30
- * Object with initial settings for the new control
31
- */
32
- mSettings?: $WebComponentSettings
33
- );
34
- /**
35
- * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
36
- */
37
- constructor(
38
- /**
39
- * Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
40
- * omitted, no matter whether `mSettings` will be given or not!
41
- */
42
- sId?: string,
43
- /**
44
- * Object with initial settings for the new control
45
- */
46
- mSettings?: $WebComponentSettings
47
- );
48
-
49
- /**
50
- * Defines a new subclass of WebComponent with the name `sClassName` and enriches it with the information
51
- * contained in `oClassInfo`.
52
- *
53
- * `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
54
- * plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
55
- * for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
56
- * `WebComponent` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
57
- *
58
- * Example:
59
- * ```javascript
60
- *
61
- * WebComponent.extend('sap.mylib.MyElement', {
62
- * metadata : {
63
- * library : 'sap.mylib',
64
- * tag : 'my-webcomponent',
65
- * properties : {
66
- * value : 'string',
67
- * width : {
68
- * type: 'sap.ui.core.CSSSize',
69
- * mapping: 'style'
70
- * }
71
- * },
72
- * defaultAggregation: "content",
73
- * aggregations : {
74
- * content : {
75
- * type: 'sap.ui.core.Control',
76
- * multiple : true
77
- * },
78
- * header : {
79
- * type : 'sap.ui.core.Control',
80
- * multiple : false,
81
- * slot: 'header'
82
- * }
83
- * }
84
- * }
85
- * });
86
- * ```
87
- *
88
- *
89
- *
90
- * @returns Created class / constructor function
91
- */
92
- static extend<T extends Record<string, unknown>>(
93
- /**
94
- * Name of the class to be created
95
- */
96
- sClassName: string,
97
- /**
98
- * Object literal with information about the class
99
- */
100
- oClassInfo?: sap.ClassInfo<T, WebComponent>,
101
- /**
102
- * Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
103
- */
104
- FNMetaImpl?: Function
105
- ): Function;
106
- /**
107
- * Returns a metadata object for class sap.ui.webc.common.WebComponent.
108
- *
109
- *
110
- * @returns Metadata object describing this class
111
- */
112
- static getMetadata(): WebComponentMetadata;
113
- }
114
- /**
115
- * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
116
- * its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
117
- *
118
- * @deprecated As of version 1.118.0. because it is part of the deprecated package sap.ui.webc.common.WebComponent
119
- */
120
- export type MetadataOptions = MetadataOptions1;
121
-
122
- /**
123
- * Describes the settings that can be provided to the WebComponent constructor.
124
- *
125
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponent instead!
126
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
127
- */
128
- export interface $WebComponentSettings extends $WebComponentSettings1 {}
129
- }
130
-
131
- declare module "sap/ui/webc/common/WebComponentMetadata" {
132
- import WebComponentMetadata1 from "sap/ui/core/webc/WebComponentMetadata";
133
-
134
- /**
135
- * @since 1.92.0
136
- * @deprecated As of version 1.118.0. Use sap.ui.core.webc.WebComponentMetadata instead!
137
- * @experimental As of version 1.92.0. The API might change. It is not intended for productive usage yet!
138
- */
139
- export default class WebComponentMetadata extends WebComponentMetadata1 {
140
- /**
141
- * Creates a new metadata object for a WebComponent Wrapper subclass.
142
- */
143
- constructor(
144
- /**
145
- * fully qualified name of the class that is described by this metadata object
146
- */
147
- sClassName: string,
148
- /**
149
- * static info to construct the metadata from
150
- */
151
- oClassInfo: object
152
- );
153
- }
154
- }
155
-
156
- declare namespace sap {
157
- interface IUI5DefineDependencyNames {
158
- "sap/ui/webc/common/library": undefined;
159
-
160
- "sap/ui/webc/common/WebComponent": undefined;
161
-
162
- "sap/ui/webc/common/WebComponentMetadata": undefined;
163
- }
164
- }