@openui5/types 1.117.1 → 1.119.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.1
1
+ // For Library Version: 1.119.0
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.1
1
+ // For Library Version: 1.119.0
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -7166,25 +7166,6 @@ declare module "sap/ui/unified/calendar/YearPicker" {
7166
7166
  */
7167
7167
  sSecondaryCalendarType: CalendarType
7168
7168
  ): this;
7169
- /**
7170
- * @deprecated (since 1.34.0) - replaced by `date` property
7171
- *
7172
- * Sets a new value for property {@link #getYear year}.
7173
- *
7174
- * The year is initial focused and selected The value must be between 0 and 9999
7175
- *
7176
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
7177
- *
7178
- * Default value is `2000`.
7179
- *
7180
- * @returns Reference to `this` in order to allow method chaining
7181
- */
7182
- setYear(
7183
- /**
7184
- * New value for property `year`
7185
- */
7186
- iYear?: int
7187
- ): this;
7188
7169
  /**
7189
7170
  * @since 1.30.0
7190
7171
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.1
1
+ // For Library Version: 1.119.0
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,14 +1,19 @@
1
- // For Library Version: 1.117.1
1
+ // For Library Version: 1.119.0
2
2
 
3
3
  declare module "sap/ui/webc/common/library" {}
4
4
 
5
5
  declare module "sap/ui/webc/common/WebComponent" {
6
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
6
+ import {
7
+ default as WebComponent1,
8
+ MetadataOptions as MetadataOptions1,
9
+ $WebComponentSettings as $WebComponentSettings1,
10
+ } from "sap/ui/core/webc/WebComponent";
7
11
 
8
12
  import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
9
13
 
10
14
  /**
11
15
  * @since 1.92.0
16
+ * @deprecated (since 1.118.0) - Use sap.ui.core.webc.WebComponent instead!
12
17
  * @experimental (since 1.92.0) - The API might change. It is not intended for productive usage yet!
13
18
  *
14
19
  * Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
@@ -16,27 +21,76 @@ declare module "sap/ui/webc/common/WebComponent" {
16
21
  * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
17
22
  * controls in the dedicated slots of the Web Component.
18
23
  */
19
- export default class WebComponent extends Control {
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
+ );
20
34
  /**
21
35
  * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
22
- *
23
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
24
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
25
- * of the syntax of the settings object.
26
36
  */
27
- constructor();
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
+ );
28
48
 
29
49
  /**
30
- * Creates a new subclass of class sap.ui.webc.common.WebComponent with name `sClassName` and enriches it
31
- * with the information contained in `oClassInfo`.
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
+ * ```
32
87
  *
33
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
34
88
  *
35
89
  * @returns Created class / constructor function
36
90
  */
37
91
  static extend<T extends Record<string, unknown>>(
38
92
  /**
39
- * Name of the class being created
93
+ * Name of the class to be created
40
94
  */
41
95
  sClassName: string,
42
96
  /**
@@ -44,8 +98,7 @@ declare module "sap/ui/webc/common/WebComponent" {
44
98
  */
45
99
  oClassInfo?: sap.ClassInfo<T, WebComponent>,
46
100
  /**
47
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
48
- * used by this class
101
+ * Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
49
102
  */
50
103
  FNMetaImpl?: Function
51
104
  ): Function;
@@ -56,18 +109,24 @@ declare module "sap/ui/webc/common/WebComponent" {
56
109
  */
57
110
  static getMetadata(): WebComponentMetadata;
58
111
  }
112
+ /**
113
+ * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
114
+ * its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
115
+ */
116
+ export type MetadataOptions = MetadataOptions1;
59
117
 
60
- export interface $WebComponentSettings extends $ControlSettings {}
118
+ export interface $WebComponentSettings extends $WebComponentSettings1 {}
61
119
  }
62
120
 
63
121
  declare module "sap/ui/webc/common/WebComponentMetadata" {
64
- import ElementMetadata from "sap/ui/core/ElementMetadata";
122
+ import WebComponentMetadata1 from "sap/ui/core/webc/WebComponentMetadata";
65
123
 
66
124
  /**
67
125
  * @since 1.92.0
126
+ * @deprecated (since 1.118.0) - Use sap.ui.core.webc.WebComponentMetadata instead!
68
127
  * @experimental (since 1.92.0) - The API might change. It is not intended for productive usage yet!
69
128
  */
70
- export default class WebComponentMetadata extends ElementMetadata {
129
+ export default class WebComponentMetadata extends WebComponentMetadata1 {
71
130
  /**
72
131
  * Creates a new metadata object for a WebComponent Wrapper subclass.
73
132
  */
@@ -81,24 +140,6 @@ declare module "sap/ui/webc/common/WebComponentMetadata" {
81
140
  */
82
141
  oClassInfo: object
83
142
  );
84
-
85
- /**
86
- * Returns the list of public getters, proxied by the Component Wrapper to the component itself
87
- */
88
- getGetters(): any[];
89
- /**
90
- * Returns the list of public methods, proxied by the Component Wrapper to the component itself
91
- */
92
- getMethods(): any[];
93
- /**
94
- * Retrieves the renderer for the described web component class. Note: this is always the default renderer
95
- * and Web Component wrappers should not define their own renderers.
96
- */
97
- getRenderer(): void;
98
- /**
99
- * Returns the tag, used to render the Component Wrapper
100
- */
101
- getTag(): string;
102
143
  }
103
144
  }
104
145