@wix/react-component-schema 1.0.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.
- package/dist/index.d.ts +3496 -0
- package/dist/index.js +556 -0
- package/package.json +52 -0
- package/src/__snapshots__/index.test.ts.snap +4061 -0
- package/src/index.test.ts +15 -0
- package/src/index.ts +86 -0
- package/tsconfig.json +17 -0
- package/vite.config.ts +64 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3496 @@
|
|
|
1
|
+
export declare interface A11y {
|
|
2
|
+
/**
|
|
3
|
+
* A collection of attributes that will be stated in the manifest
|
|
4
|
+
* @maxSize 100
|
|
5
|
+
*/
|
|
6
|
+
attributes?: A11yAttributes[];
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
declare enum A11yAttributes {
|
|
10
|
+
Unknown_AriaAttributes = "Unknown_AriaAttributes",
|
|
11
|
+
/** The value used for tabIndex attribute */
|
|
12
|
+
tabIndex = "tabIndex",
|
|
13
|
+
/** The value used for aria-level */
|
|
14
|
+
ariaLevel = "ariaLevel",
|
|
15
|
+
/** The value used for aria-expanded */
|
|
16
|
+
ariaExpanded = "ariaExpanded",
|
|
17
|
+
/** The value used for aria-disabled */
|
|
18
|
+
ariaDisabled = "ariaDisabled",
|
|
19
|
+
/** The value used for aria-atomic */
|
|
20
|
+
ariaAtomic = "ariaAtomic",
|
|
21
|
+
/** The value used for aria-hidden */
|
|
22
|
+
ariaHidden = "ariaHidden",
|
|
23
|
+
/** The value used for aria-busy */
|
|
24
|
+
ariaBusy = "ariaBusy",
|
|
25
|
+
/** Indicates if should add Multiline instructions to aria-label */
|
|
26
|
+
multiline = "multiline",
|
|
27
|
+
/** Indicates if should add Autocomplete instructions to aria-label */
|
|
28
|
+
ariaAutocomplete = "ariaAutocomplete",
|
|
29
|
+
/** The value used for aria-pressed */
|
|
30
|
+
ariaPressed = "ariaPressed",
|
|
31
|
+
/** The value used for aria-haspopup */
|
|
32
|
+
ariaHaspopup = "ariaHaspopup",
|
|
33
|
+
/** The value used for aria-relevant */
|
|
34
|
+
ariaRelevant = "ariaRelevant",
|
|
35
|
+
/** The value used for role attribute */
|
|
36
|
+
role = "role",
|
|
37
|
+
/** The value used for aria-live */
|
|
38
|
+
ariaLive = "ariaLive",
|
|
39
|
+
/** The value used for aria-current */
|
|
40
|
+
ariaCurrent = "ariaCurrent",
|
|
41
|
+
/** The text used for aria-label */
|
|
42
|
+
ariaLabel = "ariaLabel",
|
|
43
|
+
/** The text used for aria-roledescription */
|
|
44
|
+
ariaRoledescription = "ariaRoledescription",
|
|
45
|
+
/** The value used for aria-describedby */
|
|
46
|
+
ariaDescribedby = "ariaDescribedby",
|
|
47
|
+
/** The value used for aria-labelledby */
|
|
48
|
+
ariaLabelledby = "ariaLabelledby",
|
|
49
|
+
/** The text used for aria-errormessage */
|
|
50
|
+
ariaErrormessage = "ariaErrormessage",
|
|
51
|
+
/** The text used for aria-owns */
|
|
52
|
+
ariaOwns = "ariaOwns",
|
|
53
|
+
/** The text used for aria-controls */
|
|
54
|
+
ariaControls = "ariaControls",
|
|
55
|
+
/** The HTML tag to use for the element */
|
|
56
|
+
tag = "tag",
|
|
57
|
+
/** The value used for aria-multiline */
|
|
58
|
+
ariaMultiline = "ariaMultiline",
|
|
59
|
+
/** The value used for aria-invalid */
|
|
60
|
+
ariaInvalid = "ariaInvalid"
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export declare type Action = ApiAction;
|
|
64
|
+
|
|
65
|
+
export declare enum ACTION_NAME {
|
|
66
|
+
UNKNOWN_ActionName = "UNKNOWN_ActionName",
|
|
67
|
+
/** Manage the component settings, this usually aligns with component data */
|
|
68
|
+
settings = "settings",
|
|
69
|
+
/** Manage the `style` information */
|
|
70
|
+
design = "design",
|
|
71
|
+
/** Manage any media type `data` defined in the component */
|
|
72
|
+
media = "media",
|
|
73
|
+
/** Manage items in the component data */
|
|
74
|
+
manageItems = "manageItems",
|
|
75
|
+
/** Open the apps default dashboard page, or select one if there is more than one */
|
|
76
|
+
dashboard = "dashboard",
|
|
77
|
+
/** actionName to be triggered from the defined custom actions */
|
|
78
|
+
custom = "custom",
|
|
79
|
+
/** Manage Menu Items */
|
|
80
|
+
manageMenu = "manageMenu",
|
|
81
|
+
/** Shows the container actions, or select one if there is more than one */
|
|
82
|
+
container = "container"
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export declare const ACTIONS: {
|
|
86
|
+
ACTION_TYPE: typeof ActionType;
|
|
87
|
+
ACTION_NAME: typeof ACTION_NAME;
|
|
88
|
+
PANEL_TYPE: typeof PanelType;
|
|
89
|
+
PANEL_CONTENT_TYPE: typeof PanelContentType;
|
|
90
|
+
};
|
|
91
|
+
|
|
92
|
+
/** List of the native actions */
|
|
93
|
+
export declare interface Actions {
|
|
94
|
+
/** Allows enabling / disabling and overriding the settings action */
|
|
95
|
+
settings?: ApiAction;
|
|
96
|
+
/** Allows enabling / disabling and overriding the design action */
|
|
97
|
+
design?: ApiAction;
|
|
98
|
+
/** Allows enabling / disabling and overriding the media action */
|
|
99
|
+
media?: ApiAction;
|
|
100
|
+
/** Allows enabling / disabling and overriding the manageItems action */
|
|
101
|
+
manageItems?: ApiAction;
|
|
102
|
+
/** Allows enabling / disabling and overriding the dashboard action */
|
|
103
|
+
dashboard?: DashboardAction;
|
|
104
|
+
/** Allows enabling / disabling and overriding the manageMenu action */
|
|
105
|
+
manageMenu?: ApiAction;
|
|
106
|
+
/** Allows enabling / disabling and overriding the container action */
|
|
107
|
+
container?: ApiAction;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
declare enum ActionType {
|
|
111
|
+
UNKNOWN_ActionType = "UNKNOWN_ActionType",
|
|
112
|
+
data = "data",
|
|
113
|
+
event = "event",
|
|
114
|
+
panel = "panel",
|
|
115
|
+
forward = "forward",
|
|
116
|
+
style = "style",
|
|
117
|
+
displayGroup = "displayGroup",
|
|
118
|
+
cssProperty = "cssProperty",
|
|
119
|
+
cssCustomProperty = "cssCustomProperty"
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
declare interface ApiAction {
|
|
123
|
+
/**
|
|
124
|
+
* The public human-readable name given to the action by the developer.
|
|
125
|
+
* @maxLength 50
|
|
126
|
+
*/
|
|
127
|
+
displayName?: string;
|
|
128
|
+
/** A model definition for declaring a concrete instructions action will perform */
|
|
129
|
+
execution?: Execution;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/** @oneof */
|
|
133
|
+
declare interface ApiArrayItemsArrayDataOneOf {
|
|
134
|
+
/** The definition of multiple data items in each item of the Array */
|
|
135
|
+
data?: DataItems;
|
|
136
|
+
/** For a single data type in the array */
|
|
137
|
+
dataItem?: DataItem;
|
|
138
|
+
/**
|
|
139
|
+
* Marks this array as one whose item types are dynamic and resolved at runtime.
|
|
140
|
+
* Only applicable when a template container (containerType = TEMPLATE) has a data_item_key
|
|
141
|
+
* that references this array. Mutually exclusive with 'data' and 'data_item'.
|
|
142
|
+
*/
|
|
143
|
+
dynamicItems?: boolean | null;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
declare interface ApiBackgroundImage {
|
|
147
|
+
/**
|
|
148
|
+
* The image types allowed for this background-image property
|
|
149
|
+
* @maxSize 6
|
|
150
|
+
*/
|
|
151
|
+
imageTypes?: ImageType[];
|
|
152
|
+
/** The image media manager category to open media manager filtered by the component needs */
|
|
153
|
+
imageCategory?: ImageCategoryTypes;
|
|
154
|
+
/** The vector art media manager category to open media manager filtered by the component needs */
|
|
155
|
+
vectorArtCategory?: VectorArtCategoryTypes;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export declare enum ARCHETYPE {
|
|
159
|
+
UNKNOWN_Archetype = "UNKNOWN_Archetype",
|
|
160
|
+
Button = "Button",
|
|
161
|
+
LoginButton = "LoginButton",
|
|
162
|
+
Image = "Image",
|
|
163
|
+
Gallery = "Gallery",
|
|
164
|
+
Video = "Video",
|
|
165
|
+
Audio = "Audio",
|
|
166
|
+
Text = "Text",
|
|
167
|
+
TextInput = "TextInput",
|
|
168
|
+
RichTextEditor = "RichTextEditor",
|
|
169
|
+
SignatureInput = "SignatureInput",
|
|
170
|
+
Checkbox = "Checkbox",
|
|
171
|
+
RadioGroup = "RadioGroup",
|
|
172
|
+
Switch = "Switch",
|
|
173
|
+
Dropdown = "Dropdown",
|
|
174
|
+
DatePicker = "DatePicker",
|
|
175
|
+
TimePicker = "TimePicker",
|
|
176
|
+
Ratings = "Ratings",
|
|
177
|
+
RatingInput = "RatingInput",
|
|
178
|
+
Menu = "Menu",
|
|
179
|
+
Pagination = "Pagination",
|
|
180
|
+
Slider = "Slider",
|
|
181
|
+
Container = "Container",
|
|
182
|
+
Carousel = "Carousel",
|
|
183
|
+
Accordion = "Accordion",
|
|
184
|
+
Tabs = "Tabs",
|
|
185
|
+
ProgressBar = "ProgressBar",
|
|
186
|
+
Upload = "Upload",
|
|
187
|
+
Social = "Social",
|
|
188
|
+
Breadcrumbs = "Breadcrumbs",
|
|
189
|
+
SearchBox = "SearchBox",
|
|
190
|
+
Map = "Map",
|
|
191
|
+
Line = "Line",
|
|
192
|
+
Logo = "Logo",
|
|
193
|
+
Avatar = "Avatar",
|
|
194
|
+
Captcha = "Captcha",
|
|
195
|
+
VectorArt = "VectorArt",
|
|
196
|
+
AnimatedGraphic = "AnimatedGraphic",
|
|
197
|
+
Cart = "Cart",
|
|
198
|
+
ContactForm = "ContactForm",
|
|
199
|
+
Frame = "Frame",
|
|
200
|
+
Divider = "Divider"
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/** An array of data items or complex data types */
|
|
204
|
+
export declare interface ArrayItems extends ApiArrayItemsArrayDataOneOf {
|
|
205
|
+
/** The definition of multiple data items in each item of the Array */
|
|
206
|
+
data?: DataItems;
|
|
207
|
+
/** For a single data type in the array */
|
|
208
|
+
dataItem?: DataItem;
|
|
209
|
+
/**
|
|
210
|
+
* Marks this array as one whose item types are dynamic and resolved at runtime.
|
|
211
|
+
* Only applicable when a template container (containerType = TEMPLATE) has a data_item_key
|
|
212
|
+
* that references this array. Mutually exclusive with 'data' and 'data_item'.
|
|
213
|
+
*/
|
|
214
|
+
dynamicItems?: boolean | null;
|
|
215
|
+
/** The maximum size of the Array (there will be a size limit in the Storage as well) */
|
|
216
|
+
maxSize?: number | null;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
export declare interface BackdropFilter {
|
|
220
|
+
/**
|
|
221
|
+
* List of filter functions in case of reducing the abilities exposed to the User
|
|
222
|
+
* @maxSize 100
|
|
223
|
+
*/
|
|
224
|
+
filterFunctions?: FilterFunction[];
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
export declare interface Background {
|
|
228
|
+
/* Excluded from this release type: backgroundMode */
|
|
229
|
+
/** The image media manager category to open media manager filtered by the component needs */
|
|
230
|
+
imageCategory?: ImageCategoryTypes;
|
|
231
|
+
/** The vector art media manager category to open media manager filtered by the component needs */
|
|
232
|
+
vectorArtCategory?: VectorArtCategoryTypes;
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
declare enum BackgroundModeEnum {
|
|
236
|
+
UNKNOWN_BackgroundModeEnum = "UNKNOWN_BackgroundModeEnum",
|
|
237
|
+
shapeDividerSvg = "shapeDividerSvg"
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
export declare interface Behaviors {
|
|
241
|
+
/** Determines if the inner-element can be selectable in the editor */
|
|
242
|
+
selectable?: boolean | null;
|
|
243
|
+
/** Determines if the inner-element can be removed from the component */
|
|
244
|
+
removable?: boolean | null;
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
declare enum BreakpointEnumBreakpoint {
|
|
248
|
+
UNKNOWN_Breakpoint = "UNKNOWN_Breakpoint",
|
|
249
|
+
/** Represents the small (mobile) breakpoint */
|
|
250
|
+
small = "small",
|
|
251
|
+
/** Represents the large (desktop) breakpoint */
|
|
252
|
+
large = "large"
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
declare interface BreakpointPresetStyleOverrides {
|
|
256
|
+
/** The style overrides values for the default breakpoint, which will cascade to all other breakpoints (if not overridden) */
|
|
257
|
+
default?: PresetStyleOverrides;
|
|
258
|
+
/** The style overrides values for the small (mobile) breakpoint */
|
|
259
|
+
small?: PresetStyleOverrides;
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
declare interface ClientResources {
|
|
263
|
+
/**
|
|
264
|
+
* A URL to an ESM javascript bundle. It's default export should be the component
|
|
265
|
+
* @format WEB_URL
|
|
266
|
+
*/
|
|
267
|
+
componentUrl?: string;
|
|
268
|
+
/**
|
|
269
|
+
* A URL to the CSS file that is the default layout and style for the component
|
|
270
|
+
* @format WEB_URL
|
|
271
|
+
*/
|
|
272
|
+
cssUrl?: string | null;
|
|
273
|
+
/**
|
|
274
|
+
* A list of service dependencies required by the component, example: ['@wix/environment']
|
|
275
|
+
* @maxLength 80
|
|
276
|
+
* @maxSize 20
|
|
277
|
+
* @deprecated A list of service dependencies required by the component, example: ['@wix/environment']
|
|
278
|
+
* @replacedBy dependencies
|
|
279
|
+
* @targetRemovalDate 2025-12-30
|
|
280
|
+
*/
|
|
281
|
+
serviceDependencies?: string[];
|
|
282
|
+
/**
|
|
283
|
+
* A module specifier for the component’s react code.
|
|
284
|
+
* @maxLength 100
|
|
285
|
+
*/
|
|
286
|
+
moduleSpecifier?: string | null;
|
|
287
|
+
/** Dependencies on services and contexts */
|
|
288
|
+
dependencies?: EditorDependencies;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
/** Represents the information needed for code panels */
|
|
292
|
+
declare interface CodePanel {
|
|
293
|
+
/**
|
|
294
|
+
* The url for the panel code
|
|
295
|
+
* @format WEB_URL
|
|
296
|
+
*/
|
|
297
|
+
bundleUrl?: string;
|
|
298
|
+
/**
|
|
299
|
+
* The url for the panel css
|
|
300
|
+
* @format WEB_URL
|
|
301
|
+
*/
|
|
302
|
+
cssUrl?: string | null;
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
export declare interface ComponentInitialSize {
|
|
306
|
+
/** The component initial width setting */
|
|
307
|
+
width?: InitialSizeSetting;
|
|
308
|
+
/** The component initial height setting */
|
|
309
|
+
height?: InitialSizeSetting;
|
|
310
|
+
/**
|
|
311
|
+
* The component will always keep the relationship between width and height when rendered
|
|
312
|
+
* Only usable if width and height were set as 'pixels'
|
|
313
|
+
*/
|
|
314
|
+
preserveAspectRatio?: boolean | null;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export declare enum CONTAINER_TYPE {
|
|
318
|
+
/** An undefined container type, is invalid */
|
|
319
|
+
UNKNOWN_CONTAINER_TYPE = "UNKNOWN_CONTAINER_TYPE",
|
|
320
|
+
/** A simple container that can support adding and layouting elements in the editor */
|
|
321
|
+
simple = "simple",
|
|
322
|
+
/** A slot declared by a component in DEV Center that allows integrations with a Props API from the host */
|
|
323
|
+
slot = "slot",
|
|
324
|
+
/** A container to add elements targeting a specific product use case, exposed in DEV Center */
|
|
325
|
+
placeholder = "placeholder",
|
|
326
|
+
/** A container that can be used to render a template multiple times */
|
|
327
|
+
template = "template"
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
declare interface ContainerBehaviors {
|
|
331
|
+
/** Whether the container should be selectable in the editor. */
|
|
332
|
+
selectable?: boolean | null;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
declare interface ContainerLayout {
|
|
336
|
+
/**
|
|
337
|
+
* Which direction the container can resize to. will be used to determine the resize handle in the editor, and the container layout.
|
|
338
|
+
* @deprecated Which direction the container can resize to. will be used to determine the resize handle in the editor, and the container layout.
|
|
339
|
+
* @replacedBy container_resize_direction
|
|
340
|
+
* @targetRemovalDate 2026-06-30
|
|
341
|
+
*/
|
|
342
|
+
resizeDirection?: ResizeDirection;
|
|
343
|
+
/** Which direction the container can resize to. will be used to determine the resize handle in the editor, and the container layout. */
|
|
344
|
+
containerResizeDirection?: ContentResizeDirection;
|
|
345
|
+
/**
|
|
346
|
+
* In case the containerResizeDirection is horizontal or horizontalAndVertical this can be defined to provide the initial size of the container in the component
|
|
347
|
+
* @min 1
|
|
348
|
+
* @max 1280
|
|
349
|
+
*/
|
|
350
|
+
width?: number | null;
|
|
351
|
+
/**
|
|
352
|
+
* In case the containerResizeDirection is vertical or horizontalAndVertical this can be defined to provide the initial size of the container in the component
|
|
353
|
+
* @min 1
|
|
354
|
+
* @max 1000
|
|
355
|
+
*/
|
|
356
|
+
height?: number | null;
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
declare interface ContainerStyleOverrides {
|
|
360
|
+
/** The border style of the container, can be used to disable editing of the border, or change the display name. */
|
|
361
|
+
border?: StyleItemOverrides;
|
|
362
|
+
/** The border radius style of the container, can be used to disable editing of the border radius, or change the display name. */
|
|
363
|
+
borderRadius?: StyleItemOverrides;
|
|
364
|
+
/** The shadow style of the container, can be used to disable editing of the shadow, or change the display name. */
|
|
365
|
+
shadow?: StyleItemOverrides;
|
|
366
|
+
/** The background style of the container, can be used to disable editing of the background, or change the display name. */
|
|
367
|
+
background?: StyleItemOverrides;
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
declare interface ContainerTypesSlot {
|
|
371
|
+
/**
|
|
372
|
+
* The slot definition that this container should accept as defined in DEV Center
|
|
373
|
+
* @format GUID
|
|
374
|
+
*/
|
|
375
|
+
slotId?: string;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
declare interface ContentFill {
|
|
379
|
+
/**
|
|
380
|
+
* The key of the data-item that holds the content that fills the whole component visible space, using this will provide a better layout experiences for such components
|
|
381
|
+
* Restricted to data-items that hold specific data-types: "image", "video", "vectorArt", "container"
|
|
382
|
+
* @maxLength 100
|
|
383
|
+
*/
|
|
384
|
+
dataItemKey?: string | null;
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
declare enum ContentResizeDirection {
|
|
388
|
+
/** Default value when content resize behavior is not specified */
|
|
389
|
+
UNKNOWN_ContentResizeDirection = "UNKNOWN_ContentResizeDirection",
|
|
390
|
+
/** Component's width will automatically adjust based on its content */
|
|
391
|
+
horizontal = "horizontal",
|
|
392
|
+
/** Component's height will automatically adjust based on its content */
|
|
393
|
+
vertical = "vertical",
|
|
394
|
+
/** Component's width and height will automatically adjust based on its content */
|
|
395
|
+
horizontalAndVertical = "horizontalAndVertical",
|
|
396
|
+
/** Component's size will not be affected by its content */
|
|
397
|
+
none = "none"
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
export declare interface Coordinates {
|
|
401
|
+
/**
|
|
402
|
+
* Stores the top coordinate of the property shorthand
|
|
403
|
+
* @maxLength 100
|
|
404
|
+
*/
|
|
405
|
+
top?: string | null;
|
|
406
|
+
/**
|
|
407
|
+
* Stores the right coordinate of the property shorthand
|
|
408
|
+
* @maxLength 100
|
|
409
|
+
*/
|
|
410
|
+
right?: string | null;
|
|
411
|
+
/**
|
|
412
|
+
* Stores the bottom coordinate of the property shorthand
|
|
413
|
+
* @maxLength 100
|
|
414
|
+
*/
|
|
415
|
+
bottom?: string | null;
|
|
416
|
+
/**
|
|
417
|
+
* Stores the left coordinate of the property shorthand
|
|
418
|
+
* @maxLength 100
|
|
419
|
+
*/
|
|
420
|
+
left?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Stores the coordinates item of this shorthand
|
|
423
|
+
* @maxLength 100
|
|
424
|
+
*/
|
|
425
|
+
sides?: string | null;
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
export declare interface Corners {
|
|
429
|
+
/**
|
|
430
|
+
* Stores the top-left property of the shorthand
|
|
431
|
+
* @maxLength 100
|
|
432
|
+
*/
|
|
433
|
+
topLeft?: string | null;
|
|
434
|
+
/**
|
|
435
|
+
* Stores the top-right property of the shorthand
|
|
436
|
+
* @maxLength 100
|
|
437
|
+
*/
|
|
438
|
+
topRight?: string | null;
|
|
439
|
+
/**
|
|
440
|
+
* Stores the bottom-right property of the shorthand
|
|
441
|
+
* @maxLength 100
|
|
442
|
+
*/
|
|
443
|
+
bottomRight?: string | null;
|
|
444
|
+
/**
|
|
445
|
+
* Stores the bottom-left property of the shorthand
|
|
446
|
+
* @maxLength 100
|
|
447
|
+
*/
|
|
448
|
+
bottomLeft?: string | null;
|
|
449
|
+
/**
|
|
450
|
+
* Stores the corners item of this shorthand
|
|
451
|
+
* @maxLength 100
|
|
452
|
+
*/
|
|
453
|
+
corners?: string | null;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
export declare const CSS_PROPERTIES: {
|
|
457
|
+
CSS_PROPERTY_TYPE: typeof CssPropertyEnumCssPropertyType;
|
|
458
|
+
CSS_DATA_TYPE: {
|
|
459
|
+
readonly number: CssPropertyEnumCssPropertyType.number;
|
|
460
|
+
readonly string: CssPropertyEnumCssPropertyType.string;
|
|
461
|
+
readonly angle: CssPropertyEnumCssPropertyType.angle;
|
|
462
|
+
readonly color: CssPropertyEnumCssPropertyType.color;
|
|
463
|
+
readonly length: CssPropertyEnumCssPropertyType.length;
|
|
464
|
+
readonly percentage: CssPropertyEnumCssPropertyType.percentage;
|
|
465
|
+
readonly lengthPercentage: CssPropertyEnumCssPropertyType.lengthPercentage;
|
|
466
|
+
readonly blendMode: CssPropertyEnumCssPropertyType.blendMode;
|
|
467
|
+
readonly customEnum: CssPropertyEnumCssPropertyType.customEnum;
|
|
468
|
+
readonly time: CssPropertyEnumCssPropertyType.time;
|
|
469
|
+
};
|
|
470
|
+
FILTER_FUNCTION: typeof FilterFunction;
|
|
471
|
+
DISPLAY_VALUE: typeof DisplayValueEnumDisplayValue;
|
|
472
|
+
WRITING_MODE_VALUE: typeof WritingModeValue;
|
|
473
|
+
BACKGROUND_MODE: typeof BackgroundModeEnum;
|
|
474
|
+
IMAGE_TYPE: typeof ImageType;
|
|
475
|
+
};
|
|
476
|
+
|
|
477
|
+
export declare type CssCustomProperties = NonNullable<EditorElement['cssCustomProperties']>;
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* Represents an action that points into a single css-custom-property,
|
|
481
|
+
* the outcome of clicking such action will be determined by the editor
|
|
482
|
+
*/
|
|
483
|
+
declare interface CssCustomPropertyAction {
|
|
484
|
+
/**
|
|
485
|
+
* Points to the style item within the component’s css-custom-properties map
|
|
486
|
+
* @minLength 1
|
|
487
|
+
* @maxLength 50
|
|
488
|
+
*/
|
|
489
|
+
cssCustomPropertyKey?: string;
|
|
490
|
+
}
|
|
491
|
+
|
|
492
|
+
export declare interface CssCustomPropertyItem extends CssCustomPropertyItemSelectedCssPropertyTypeOneOf {
|
|
493
|
+
/** Additional options to refine the filter variable */
|
|
494
|
+
filter?: Filter;
|
|
495
|
+
/** Additional options to refine the backdropFilter variable */
|
|
496
|
+
backdropFilter?: BackdropFilter;
|
|
497
|
+
/** Additional options to refine the display variable */
|
|
498
|
+
display?: Display;
|
|
499
|
+
/** Additional options to refine the writingMode variable */
|
|
500
|
+
writingMode?: WritingMode;
|
|
501
|
+
/** Additional options to refine the background variable */
|
|
502
|
+
background?: Background;
|
|
503
|
+
/** Additional options to refine the background-image variable */
|
|
504
|
+
backgroundImage?: ApiBackgroundImage;
|
|
505
|
+
/** Additional options to refine the mask-image variable */
|
|
506
|
+
maskImage?: MaskImage;
|
|
507
|
+
/** Additional options to refine the customEnum item */
|
|
508
|
+
customEnum?: CustomPropertyEnum;
|
|
509
|
+
/** Additional options to refine the number item */
|
|
510
|
+
number?: CssNumber;
|
|
511
|
+
/**
|
|
512
|
+
* The type of the value this css-custom-property will store, can be either
|
|
513
|
+
* [CSS properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Properties) or
|
|
514
|
+
* [CSS data types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Values_and_Units/CSS_data_types) in Javascript naming format
|
|
515
|
+
*/
|
|
516
|
+
cssPropertyType?: CssPropertyEnumCssPropertyType;
|
|
517
|
+
/* Excluded from this release type: deprecated */
|
|
518
|
+
/**
|
|
519
|
+
* Will be used as displayName of this css-property-item
|
|
520
|
+
* @maxLength 100
|
|
521
|
+
*/
|
|
522
|
+
displayName?: string | null;
|
|
523
|
+
/** The default value for the css-property-item when the component is in the "regular" state */
|
|
524
|
+
defaultValue?: any;
|
|
525
|
+
/** The default values for the css-property-item when the component is in one of the defined states */
|
|
526
|
+
statesDefaultValues?: Record<string, any>;
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/** @oneof */
|
|
530
|
+
declare interface CssCustomPropertyItemSelectedCssPropertyTypeOneOf {
|
|
531
|
+
/** Additional options to refine the filter variable */
|
|
532
|
+
filter?: Filter;
|
|
533
|
+
/** Additional options to refine the backdropFilter variable */
|
|
534
|
+
backdropFilter?: BackdropFilter;
|
|
535
|
+
/** Additional options to refine the display variable */
|
|
536
|
+
display?: Display;
|
|
537
|
+
/** Additional options to refine the writingMode variable */
|
|
538
|
+
writingMode?: WritingMode;
|
|
539
|
+
/** Additional options to refine the background variable */
|
|
540
|
+
background?: Background;
|
|
541
|
+
/** Additional options to refine the background-image variable */
|
|
542
|
+
backgroundImage?: ApiBackgroundImage;
|
|
543
|
+
/** Additional options to refine the mask-image variable */
|
|
544
|
+
maskImage?: MaskImage;
|
|
545
|
+
/** Additional options to refine the customEnum item */
|
|
546
|
+
customEnum?: CustomPropertyEnum;
|
|
547
|
+
/** Additional options to refine the number item */
|
|
548
|
+
number?: CssNumber;
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
/** The supported [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Types) in Javascript naming format */
|
|
552
|
+
declare enum CssDataType {
|
|
553
|
+
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
554
|
+
number = "number",
|
|
555
|
+
length = "length",
|
|
556
|
+
color = "color",
|
|
557
|
+
angle = "angle",
|
|
558
|
+
percentage = "percentage",
|
|
559
|
+
lengthPercentage = "lengthPercentage",
|
|
560
|
+
blendMode = "blendMode",
|
|
561
|
+
customEnum = "customEnum",
|
|
562
|
+
string = "string",
|
|
563
|
+
time = "time"
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
declare enum CssDataTypeEnumCssDataType {
|
|
567
|
+
UNKNOWN_CssDataType = "UNKNOWN_CssDataType",
|
|
568
|
+
number = "number",
|
|
569
|
+
string = "string",
|
|
570
|
+
angle = "angle",
|
|
571
|
+
color = "color",
|
|
572
|
+
length = "length",
|
|
573
|
+
percentage = "percentage",
|
|
574
|
+
lengthPercentage = "lengthPercentage",
|
|
575
|
+
blendMode = "blendMode",
|
|
576
|
+
customEnum = "customEnum",
|
|
577
|
+
time = "time"
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
export declare interface CssNumber {
|
|
581
|
+
/**
|
|
582
|
+
* @deprecated
|
|
583
|
+
* @replacedBy min
|
|
584
|
+
* @targetRemovalDate 2025-11-30
|
|
585
|
+
*/
|
|
586
|
+
minimum?: number | null;
|
|
587
|
+
/**
|
|
588
|
+
* Indicates minimum value required for the number
|
|
589
|
+
* @format DECIMAL_VALUE
|
|
590
|
+
*/
|
|
591
|
+
min?: string | null;
|
|
592
|
+
/**
|
|
593
|
+
* @deprecated
|
|
594
|
+
* @replacedBy max
|
|
595
|
+
* @targetRemovalDate 2025-11-30
|
|
596
|
+
*/
|
|
597
|
+
maximum?: number | null;
|
|
598
|
+
/**
|
|
599
|
+
* Indicates maximum value allowed for the number
|
|
600
|
+
* @format DECIMAL_VALUE
|
|
601
|
+
*/
|
|
602
|
+
max?: string | null;
|
|
603
|
+
/**
|
|
604
|
+
* @deprecated
|
|
605
|
+
* @replacedBy multiplier
|
|
606
|
+
* @targetRemovalDate 2025-11-30
|
|
607
|
+
*/
|
|
608
|
+
multipleOf?: number | null;
|
|
609
|
+
/**
|
|
610
|
+
* The multiplier for the number value
|
|
611
|
+
* @format DECIMAL_VALUE
|
|
612
|
+
*/
|
|
613
|
+
multiplier?: string | null;
|
|
614
|
+
}
|
|
615
|
+
|
|
616
|
+
export declare type CssProperties = NonNullable<EditorElement['cssProperties']>;
|
|
617
|
+
|
|
618
|
+
export declare type CssPropertiesOverrides = NonNullable<RefElement['cssCustomProperties']>;
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* Represents an action that points into a single css-property,
|
|
622
|
+
* the outcome of clicking such action will be determined by the editor
|
|
623
|
+
*/
|
|
624
|
+
declare interface CssPropertyAction {
|
|
625
|
+
/**
|
|
626
|
+
* Points to the style item within the component’s css-properties map
|
|
627
|
+
* @minLength 1
|
|
628
|
+
* @maxLength 50
|
|
629
|
+
*/
|
|
630
|
+
cssPropertyKey?: string;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
/**
|
|
634
|
+
* The supported [CSS Property Types & CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference#index) and
|
|
635
|
+
* [CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Values_and_Units/CSS_data_types) in Javascript naming format
|
|
636
|
+
*/
|
|
637
|
+
declare enum CssPropertyEnumCssPropertyType {
|
|
638
|
+
UNKNOWN_CssPropertyType = "UNKNOWN_CssPropertyType",
|
|
639
|
+
/** css-data-types */
|
|
640
|
+
number = "number",
|
|
641
|
+
string = "string",
|
|
642
|
+
angle = "angle",
|
|
643
|
+
length = "length",
|
|
644
|
+
percentage = "percentage",
|
|
645
|
+
lengthPercentage = "lengthPercentage",
|
|
646
|
+
blendMode = "blendMode",
|
|
647
|
+
customEnum = "customEnum",
|
|
648
|
+
time = "time",
|
|
649
|
+
/** background properties */
|
|
650
|
+
background = "background",
|
|
651
|
+
backgroundSize = "backgroundSize",
|
|
652
|
+
backgroundColor = "backgroundColor",
|
|
653
|
+
backgroundImage = "backgroundImage",
|
|
654
|
+
backgroundClip = "backgroundClip",
|
|
655
|
+
backgroundOrigin = "backgroundOrigin",
|
|
656
|
+
backgroundPosition = "backgroundPosition",
|
|
657
|
+
backgroundRepeat = "backgroundRepeat",
|
|
658
|
+
backgroundAttachment = "backgroundAttachment",
|
|
659
|
+
/** margin properties */
|
|
660
|
+
margin = "margin",
|
|
661
|
+
marginTop = "marginTop",
|
|
662
|
+
marginRight = "marginRight",
|
|
663
|
+
marginBottom = "marginBottom",
|
|
664
|
+
marginLeft = "marginLeft",
|
|
665
|
+
marginInlineStart = "marginInlineStart",
|
|
666
|
+
marginInlineEnd = "marginInlineEnd",
|
|
667
|
+
/** padding properties */
|
|
668
|
+
padding = "padding",
|
|
669
|
+
paddingTop = "paddingTop",
|
|
670
|
+
paddingRight = "paddingRight",
|
|
671
|
+
paddingBottom = "paddingBottom",
|
|
672
|
+
paddingLeft = "paddingLeft",
|
|
673
|
+
paddingInlineStart = "paddingInlineStart",
|
|
674
|
+
paddingInlineEnd = "paddingInlineEnd",
|
|
675
|
+
/** border properties */
|
|
676
|
+
border = "border",
|
|
677
|
+
borderWidth = "borderWidth",
|
|
678
|
+
borderStyle = "borderStyle",
|
|
679
|
+
borderColor = "borderColor",
|
|
680
|
+
borderTop = "borderTop",
|
|
681
|
+
borderTopColor = "borderTopColor",
|
|
682
|
+
borderTopWidth = "borderTopWidth",
|
|
683
|
+
borderTopStyle = "borderTopStyle",
|
|
684
|
+
borderRight = "borderRight",
|
|
685
|
+
borderRightColor = "borderRightColor",
|
|
686
|
+
borderRightWidth = "borderRightWidth",
|
|
687
|
+
borderRightStyle = "borderRightStyle",
|
|
688
|
+
borderBottom = "borderBottom",
|
|
689
|
+
borderBottomColor = "borderBottomColor",
|
|
690
|
+
borderBottomWidth = "borderBottomWidth",
|
|
691
|
+
borderBottomStyle = "borderBottomStyle",
|
|
692
|
+
borderLeft = "borderLeft",
|
|
693
|
+
borderLeftColor = "borderLeftColor",
|
|
694
|
+
borderLeftWidth = "borderLeftWidth",
|
|
695
|
+
borderLeftStyle = "borderLeftStyle",
|
|
696
|
+
borderInlineStart = "borderInlineStart",
|
|
697
|
+
borderInlineStartColor = "borderInlineStartColor",
|
|
698
|
+
borderInlineStartWidth = "borderInlineStartWidth",
|
|
699
|
+
borderInlineStartStyle = "borderInlineStartStyle",
|
|
700
|
+
borderInlineEnd = "borderInlineEnd",
|
|
701
|
+
borderInlineEndColor = "borderInlineEndColor",
|
|
702
|
+
borderInlineEndWidth = "borderInlineEndWidth",
|
|
703
|
+
borderInlineEndStyle = "borderInlineEndStyle",
|
|
704
|
+
/** border-radius properties */
|
|
705
|
+
borderRadius = "borderRadius",
|
|
706
|
+
borderTopLeftRadius = "borderTopLeftRadius",
|
|
707
|
+
borderTopRightRadius = "borderTopRightRadius",
|
|
708
|
+
borderBottomRightRadius = "borderBottomRightRadius",
|
|
709
|
+
borderBottomLeftRadius = "borderBottomLeftRadius",
|
|
710
|
+
borderStartStartRadius = "borderStartStartRadius",
|
|
711
|
+
borderStartEndRadius = "borderStartEndRadius",
|
|
712
|
+
borderEndStartRadius = "borderEndStartRadius",
|
|
713
|
+
borderEndEndRadius = "borderEndEndRadius",
|
|
714
|
+
/** font properties */
|
|
715
|
+
font = "font",
|
|
716
|
+
fontFamily = "fontFamily",
|
|
717
|
+
fontSize = "fontSize",
|
|
718
|
+
fontStretch = "fontStretch",
|
|
719
|
+
fontStyle = "fontStyle",
|
|
720
|
+
fontVariant = "fontVariant",
|
|
721
|
+
fontWeight = "fontWeight",
|
|
722
|
+
lineHeight = "lineHeight",
|
|
723
|
+
/** text properties */
|
|
724
|
+
color = "color",
|
|
725
|
+
letterSpacing = "letterSpacing",
|
|
726
|
+
writingMode = "writingMode",
|
|
727
|
+
textAlign = "textAlign",
|
|
728
|
+
textTransform = "textTransform",
|
|
729
|
+
textShadow = "textShadow",
|
|
730
|
+
textOverflow = "textOverflow",
|
|
731
|
+
textIndent = "textIndent",
|
|
732
|
+
/** text-decoration properties */
|
|
733
|
+
textDecoration = "textDecoration",
|
|
734
|
+
textDecorationColor = "textDecorationColor",
|
|
735
|
+
textDecorationLine = "textDecorationLine",
|
|
736
|
+
textDecorationStyle = "textDecorationStyle",
|
|
737
|
+
textDecorationThickness = "textDecorationThickness",
|
|
738
|
+
/** box related properties */
|
|
739
|
+
boxShadow = "boxShadow",
|
|
740
|
+
opacity = "opacity",
|
|
741
|
+
overflow = "overflow",
|
|
742
|
+
/** layout properties */
|
|
743
|
+
display = "display",
|
|
744
|
+
alignSelf = "alignSelf",
|
|
745
|
+
justifyContent = "justifyContent",
|
|
746
|
+
alignItems = "alignItems",
|
|
747
|
+
flexDirection = "flexDirection",
|
|
748
|
+
height = "height",
|
|
749
|
+
width = "width",
|
|
750
|
+
gap = "gap",
|
|
751
|
+
columnGap = "columnGap",
|
|
752
|
+
rowGap = "rowGap",
|
|
753
|
+
/** filters */
|
|
754
|
+
filter = "filter",
|
|
755
|
+
backdropFilter = "backdropFilter",
|
|
756
|
+
/** media sizing & alignment */
|
|
757
|
+
objectFit = "objectFit",
|
|
758
|
+
objectPosition = "objectPosition",
|
|
759
|
+
/** blending & compositing */
|
|
760
|
+
mixBlendMode = "mixBlendMode",
|
|
761
|
+
isolation = "isolation",
|
|
762
|
+
/** stroke properties */
|
|
763
|
+
stroke = "stroke",
|
|
764
|
+
strokeWidth = "strokeWidth",
|
|
765
|
+
strokeOpacity = "strokeOpacity",
|
|
766
|
+
/** fill properties */
|
|
767
|
+
fill = "fill",
|
|
768
|
+
fillOpacity = "fillOpacity",
|
|
769
|
+
fillRule = "fillRule",
|
|
770
|
+
/** mask properties */
|
|
771
|
+
mask = "mask",
|
|
772
|
+
maskImage = "maskImage",
|
|
773
|
+
maskMode = "maskMode",
|
|
774
|
+
maskRepeat = "maskRepeat",
|
|
775
|
+
maskPosition = "maskPosition",
|
|
776
|
+
maskClip = "maskClip",
|
|
777
|
+
maskOrigin = "maskOrigin",
|
|
778
|
+
maskSize = "maskSize",
|
|
779
|
+
maskComposite = "maskComposite"
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
export declare interface CssPropertyItem extends CssPropertyItemSelectedCssPropertyTypeOneOf {
|
|
783
|
+
/** Additional options to refine the filter variable */
|
|
784
|
+
filter?: Filter;
|
|
785
|
+
/** Additional options to refine the backdropFilter variable */
|
|
786
|
+
backdropFilter?: BackdropFilter;
|
|
787
|
+
/** Additional options to refine the display variable */
|
|
788
|
+
display?: Display;
|
|
789
|
+
/** Additional options to refine the writingMode variable */
|
|
790
|
+
writingMode?: WritingMode;
|
|
791
|
+
/** Additional options to refine the background variable */
|
|
792
|
+
background?: Background;
|
|
793
|
+
/** Additional options to refine the background-image variable */
|
|
794
|
+
backgroundImage?: ApiBackgroundImage;
|
|
795
|
+
/** Additional options to refine the mask-image variable */
|
|
796
|
+
maskImage?: MaskImage;
|
|
797
|
+
/**
|
|
798
|
+
* Will be used as displayName of this css-property-item
|
|
799
|
+
* @maxLength 100
|
|
800
|
+
*/
|
|
801
|
+
displayName?: string | null;
|
|
802
|
+
/** The default value for the css-property-item when the component is in the "regular" state */
|
|
803
|
+
defaultValue?: any;
|
|
804
|
+
/** The default values for the css-property-item when the component is in one of the defined states */
|
|
805
|
+
statesDefaultValues?: Record<string, any>;
|
|
806
|
+
/* Excluded from this release type: deprecated */
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
declare interface CssPropertyItemDefaults {
|
|
810
|
+
/** The default value of this css-property-item */
|
|
811
|
+
defaultValue?: any;
|
|
812
|
+
/** The default values for the css-property-item when the component is in one of the defined states */
|
|
813
|
+
statesDefaultValues?: Record<string, any>;
|
|
814
|
+
}
|
|
815
|
+
|
|
816
|
+
export declare interface CssPropertyItemDefinitionOverrides {
|
|
817
|
+
/**
|
|
818
|
+
* Will be used as displayName of this css-property-item
|
|
819
|
+
* @maxLength 100
|
|
820
|
+
*/
|
|
821
|
+
displayName?: string | null;
|
|
822
|
+
/** Disables the ability to edit this css-property-item */
|
|
823
|
+
disableEditing?: boolean | null;
|
|
824
|
+
/** The default value for the css-property-item when the component is in the "regular" state */
|
|
825
|
+
defaultValue?: any;
|
|
826
|
+
/** The default values for the css-property-item when the component is in one of the defined states */
|
|
827
|
+
statesDefaultValues?: Record<string, any>;
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
/** @oneof */
|
|
831
|
+
declare interface CssPropertyItemSelectedCssPropertyTypeOneOf {
|
|
832
|
+
/** Additional options to refine the filter variable */
|
|
833
|
+
filter?: Filter;
|
|
834
|
+
/** Additional options to refine the backdropFilter variable */
|
|
835
|
+
backdropFilter?: BackdropFilter;
|
|
836
|
+
/** Additional options to refine the display variable */
|
|
837
|
+
display?: Display;
|
|
838
|
+
/** Additional options to refine the writingMode variable */
|
|
839
|
+
writingMode?: WritingMode;
|
|
840
|
+
/** Additional options to refine the background variable */
|
|
841
|
+
background?: Background;
|
|
842
|
+
/** Additional options to refine the background-image variable */
|
|
843
|
+
backgroundImage?: ApiBackgroundImage;
|
|
844
|
+
/** Additional options to refine the mask-image variable */
|
|
845
|
+
maskImage?: MaskImage;
|
|
846
|
+
}
|
|
847
|
+
|
|
848
|
+
/** The supported [CSS Property Types](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference#index) in Javascript naming format */
|
|
849
|
+
declare enum CssPropertyType {
|
|
850
|
+
UNKNOWN_CssPropertyType = "UNKNOWN_CssPropertyType",
|
|
851
|
+
/** background properties */
|
|
852
|
+
background = "background",
|
|
853
|
+
backgroundSize = "backgroundSize",
|
|
854
|
+
backgroundColor = "backgroundColor",
|
|
855
|
+
backgroundImage = "backgroundImage",
|
|
856
|
+
backgroundClip = "backgroundClip",
|
|
857
|
+
backgroundOrigin = "backgroundOrigin",
|
|
858
|
+
backgroundPosition = "backgroundPosition",
|
|
859
|
+
backgroundRepeat = "backgroundRepeat",
|
|
860
|
+
backgroundAttachment = "backgroundAttachment",
|
|
861
|
+
fill = "fill",
|
|
862
|
+
fillOpacity = "fillOpacity",
|
|
863
|
+
/** margin properties */
|
|
864
|
+
margin = "margin",
|
|
865
|
+
marginTop = "marginTop",
|
|
866
|
+
marginRight = "marginRight",
|
|
867
|
+
marginBottom = "marginBottom",
|
|
868
|
+
marginLeft = "marginLeft",
|
|
869
|
+
marginInlineStart = "marginInlineStart",
|
|
870
|
+
marginInlineEnd = "marginInlineEnd",
|
|
871
|
+
/** padding properties */
|
|
872
|
+
padding = "padding",
|
|
873
|
+
paddingTop = "paddingTop",
|
|
874
|
+
paddingRight = "paddingRight",
|
|
875
|
+
paddingBottom = "paddingBottom",
|
|
876
|
+
paddingLeft = "paddingLeft",
|
|
877
|
+
paddingInlineStart = "paddingInlineStart",
|
|
878
|
+
paddingInlineEnd = "paddingInlineEnd",
|
|
879
|
+
/** border properties */
|
|
880
|
+
border = "border",
|
|
881
|
+
borderWidth = "borderWidth",
|
|
882
|
+
borderStyle = "borderStyle",
|
|
883
|
+
borderColor = "borderColor",
|
|
884
|
+
borderTop = "borderTop",
|
|
885
|
+
borderTopColor = "borderTopColor",
|
|
886
|
+
borderTopWidth = "borderTopWidth",
|
|
887
|
+
borderTopStyle = "borderTopStyle",
|
|
888
|
+
borderRight = "borderRight",
|
|
889
|
+
borderRightColor = "borderRightColor",
|
|
890
|
+
borderRightWidth = "borderRightWidth",
|
|
891
|
+
borderRightStyle = "borderRightStyle",
|
|
892
|
+
borderBottom = "borderBottom",
|
|
893
|
+
borderBottomColor = "borderBottomColor",
|
|
894
|
+
borderBottomWidth = "borderBottomWidth",
|
|
895
|
+
borderBottomStyle = "borderBottomStyle",
|
|
896
|
+
borderLeft = "borderLeft",
|
|
897
|
+
borderLeftColor = "borderLeftColor",
|
|
898
|
+
borderLeftWidth = "borderLeftWidth",
|
|
899
|
+
borderLeftStyle = "borderLeftStyle",
|
|
900
|
+
borderInlineStart = "borderInlineStart",
|
|
901
|
+
borderInlineStartColor = "borderInlineStartColor",
|
|
902
|
+
borderInlineStartWidth = "borderInlineStartWidth",
|
|
903
|
+
borderInlineStartStyle = "borderInlineStartStyle",
|
|
904
|
+
borderInlineEnd = "borderInlineEnd",
|
|
905
|
+
borderInlineEndColor = "borderInlineEndColor",
|
|
906
|
+
borderInlineEndWidth = "borderInlineEndWidth",
|
|
907
|
+
borderInlineEndStyle = "borderInlineEndStyle",
|
|
908
|
+
borderRadius = "borderRadius",
|
|
909
|
+
borderTopLeftRadius = "borderTopLeftRadius",
|
|
910
|
+
borderTopRightRadius = "borderTopRightRadius",
|
|
911
|
+
borderBottomRightRadius = "borderBottomRightRadius",
|
|
912
|
+
borderBottomLeftRadius = "borderBottomLeftRadius",
|
|
913
|
+
borderStartStartRadius = "borderStartStartRadius",
|
|
914
|
+
borderStartEndRadius = "borderStartEndRadius",
|
|
915
|
+
borderEndStartRadius = "borderEndStartRadius",
|
|
916
|
+
borderEndEndRadius = "borderEndEndRadius",
|
|
917
|
+
/** text properties */
|
|
918
|
+
font = "font",
|
|
919
|
+
fontFamily = "fontFamily",
|
|
920
|
+
fontSize = "fontSize",
|
|
921
|
+
fontStretch = "fontStretch",
|
|
922
|
+
fontStyle = "fontStyle",
|
|
923
|
+
fontVariant = "fontVariant",
|
|
924
|
+
fontWeight = "fontWeight",
|
|
925
|
+
lineHeight = "lineHeight",
|
|
926
|
+
color = "color",
|
|
927
|
+
letterSpacing = "letterSpacing",
|
|
928
|
+
writingMode = "writingMode",
|
|
929
|
+
textAlign = "textAlign",
|
|
930
|
+
textTransform = "textTransform",
|
|
931
|
+
textShadow = "textShadow",
|
|
932
|
+
textOverflow = "textOverflow",
|
|
933
|
+
textIndent = "textIndent",
|
|
934
|
+
textDecoration = "textDecoration",
|
|
935
|
+
textDecorationColor = "textDecorationColor",
|
|
936
|
+
textDecorationLine = "textDecorationLine",
|
|
937
|
+
textDecorationStyle = "textDecorationStyle",
|
|
938
|
+
textDecorationThickness = "textDecorationThickness",
|
|
939
|
+
/** general box properties */
|
|
940
|
+
boxShadow = "boxShadow",
|
|
941
|
+
opacity = "opacity",
|
|
942
|
+
overflow = "overflow",
|
|
943
|
+
/** layout properties */
|
|
944
|
+
display = "display",
|
|
945
|
+
alignSelf = "alignSelf",
|
|
946
|
+
justifyContent = "justifyContent",
|
|
947
|
+
alignItems = "alignItems",
|
|
948
|
+
flexDirection = "flexDirection",
|
|
949
|
+
gap = "gap",
|
|
950
|
+
height = "height",
|
|
951
|
+
width = "width",
|
|
952
|
+
columnGap = "columnGap",
|
|
953
|
+
rowGap = "rowGap",
|
|
954
|
+
/** filters */
|
|
955
|
+
filter = "filter",
|
|
956
|
+
backdropFilter = "backdropFilter",
|
|
957
|
+
/** media sizing & alignment */
|
|
958
|
+
objectFit = "objectFit",
|
|
959
|
+
objectPosition = "objectPosition",
|
|
960
|
+
/** blending & compositing */
|
|
961
|
+
mixBlendMode = "mixBlendMode",
|
|
962
|
+
isolation = "isolation",
|
|
963
|
+
/** stroke properties */
|
|
964
|
+
stroke = "stroke",
|
|
965
|
+
strokeWidth = "strokeWidth",
|
|
966
|
+
strokeOpacity = "strokeOpacity"
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
export declare type CustomActions = NonNullable<EditorElement['customActions']>;
|
|
970
|
+
|
|
971
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
972
|
+
declare interface CustomEnum {
|
|
973
|
+
/**
|
|
974
|
+
* DEPRECATED: use cssDataType instead
|
|
975
|
+
* @deprecated DEPRECATED: use cssDataType instead
|
|
976
|
+
* @replacedBy cssDataType
|
|
977
|
+
* @targetRemovalDate 2025-08-01
|
|
978
|
+
*/
|
|
979
|
+
cssVariableType?: CssDataType;
|
|
980
|
+
/** The type of the custom enum, used to define the type of the values allowed in the enum */
|
|
981
|
+
cssDataType?: CssDataTypeEnumCssDataType;
|
|
982
|
+
/**
|
|
983
|
+
* The allowed value options for this custom enum
|
|
984
|
+
* @maxSize 100
|
|
985
|
+
*/
|
|
986
|
+
options?: CustomEnumOption[];
|
|
987
|
+
}
|
|
988
|
+
|
|
989
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
990
|
+
declare interface CustomEnumOption {
|
|
991
|
+
/**
|
|
992
|
+
* the enum value
|
|
993
|
+
* @maxLength 100
|
|
994
|
+
*/
|
|
995
|
+
value?: string;
|
|
996
|
+
/**
|
|
997
|
+
* Will be used as displayName of this enum option
|
|
998
|
+
* @maxLength 100
|
|
999
|
+
*/
|
|
1000
|
+
displayName?: string;
|
|
1001
|
+
/* Excluded from this release type: appliedStyles */
|
|
1002
|
+
}
|
|
1003
|
+
|
|
1004
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
1005
|
+
declare interface CustomEnumOptionCssProperty {
|
|
1006
|
+
/**
|
|
1007
|
+
* the css property
|
|
1008
|
+
* @maxLength 100
|
|
1009
|
+
*/
|
|
1010
|
+
property?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* the css value
|
|
1013
|
+
* @maxLength 300
|
|
1014
|
+
*/
|
|
1015
|
+
value?: string;
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
export declare interface CustomPropertyEnum {
|
|
1019
|
+
/** The type of the css-custom-property, used to define the type of the values allowed in the enum */
|
|
1020
|
+
cssPropertyType?: CssPropertyEnumCssPropertyType;
|
|
1021
|
+
/**
|
|
1022
|
+
* The allowed value options for this custom enum
|
|
1023
|
+
* @maxSize 100
|
|
1024
|
+
*/
|
|
1025
|
+
options?: CustomPropertyEnumOption[];
|
|
1026
|
+
}
|
|
1027
|
+
|
|
1028
|
+
export declare interface CustomPropertyEnumOption {
|
|
1029
|
+
/**
|
|
1030
|
+
* the enum value
|
|
1031
|
+
* @maxLength 100
|
|
1032
|
+
*/
|
|
1033
|
+
value?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* Will be used as displayName of this enum option
|
|
1036
|
+
* @maxLength 100
|
|
1037
|
+
*/
|
|
1038
|
+
displayName?: string | null;
|
|
1039
|
+
/* Excluded from this release type: appliedStyles */
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
declare interface CustomPropertyEnumOptionStyle {
|
|
1043
|
+
/**
|
|
1044
|
+
* the css property
|
|
1045
|
+
* @minLength 1
|
|
1046
|
+
* @maxLength 100
|
|
1047
|
+
*/
|
|
1048
|
+
property?: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* the css value
|
|
1051
|
+
* @minLength 1
|
|
1052
|
+
* @maxLength 300
|
|
1053
|
+
*/
|
|
1054
|
+
value?: string;
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
export declare interface DashboardAction {
|
|
1058
|
+
/**
|
|
1059
|
+
* The public human-readable name given to the action by the developer.
|
|
1060
|
+
* @maxLength 50
|
|
1061
|
+
*/
|
|
1062
|
+
displayName?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* Optional pageId of the dashboard in case there is more than one
|
|
1065
|
+
* @minLength 4
|
|
1066
|
+
* @maxLength 50
|
|
1067
|
+
*/
|
|
1068
|
+
dashboardPageId?: string;
|
|
1069
|
+
/** A model definition for declaring a concrete instructions action will perform */
|
|
1070
|
+
execution?: Execution;
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
/**
|
|
1074
|
+
* Wix Component Manifest;
|
|
1075
|
+
* @description The Wix Component Manifest that describes the component's properties and behaviors.
|
|
1076
|
+
*/
|
|
1077
|
+
export declare const DATA: {
|
|
1078
|
+
DATA_TYPE: typeof DataType;
|
|
1079
|
+
A11Y_ATTRIBUTES: typeof A11yAttributes;
|
|
1080
|
+
LINK_TYPE: typeof LinkType;
|
|
1081
|
+
};
|
|
1082
|
+
|
|
1083
|
+
export declare type Data = NonNullable<EditorElement['data']>;
|
|
1084
|
+
|
|
1085
|
+
/**
|
|
1086
|
+
* Represents an action that points into a specific data-item-key,
|
|
1087
|
+
* the outcome of clicking such action will be determined by the editor
|
|
1088
|
+
*/
|
|
1089
|
+
export declare interface DataAction {
|
|
1090
|
+
/**
|
|
1091
|
+
* Points to the data item within the component’s data structure
|
|
1092
|
+
* @minLength 1
|
|
1093
|
+
* @maxLength 50
|
|
1094
|
+
*/
|
|
1095
|
+
dataItemKey?: string;
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
|
+
export declare interface DataGroupsArrayItems {
|
|
1099
|
+
/**
|
|
1100
|
+
* Stores the name of the 'arrayItems'
|
|
1101
|
+
* @maxLength 100
|
|
1102
|
+
*/
|
|
1103
|
+
arrayItems?: string | null;
|
|
1104
|
+
/**
|
|
1105
|
+
* Stores the data-item of the currently selected index within the array items
|
|
1106
|
+
* @maxLength 100
|
|
1107
|
+
*/
|
|
1108
|
+
selectedItemIndex?: string | null;
|
|
1109
|
+
/** Stores whether the editor should allow no selection of these array items, and the selected index passed to the component will be undefined in that case */
|
|
1110
|
+
allowNoSelection?: boolean | null;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
export declare interface DataItem extends DataItemSelectedDataTypeOneOf {
|
|
1114
|
+
/** An optional object to define limitations on the text input */
|
|
1115
|
+
text?: Text_2;
|
|
1116
|
+
/** A required list of options to supply to the users to choose from */
|
|
1117
|
+
textEnum?: TextEnum;
|
|
1118
|
+
/** An optional set of restrictions to apply to the number */
|
|
1119
|
+
number?: DataNumber;
|
|
1120
|
+
/** A required list of types we want to user to be able to specify, empty means all possible A11Y values */
|
|
1121
|
+
a11y?: A11y;
|
|
1122
|
+
/** A definition of what links should be supported */
|
|
1123
|
+
link?: Link;
|
|
1124
|
+
/** An array of a data type */
|
|
1125
|
+
arrayItems?: ArrayItems;
|
|
1126
|
+
/** A container in which to render another component */
|
|
1127
|
+
container?: ReactElementContainer;
|
|
1128
|
+
/** A definition of what rich text abilities should be supported */
|
|
1129
|
+
richText?: RichText;
|
|
1130
|
+
/** A definition of what images should be supported */
|
|
1131
|
+
image?: Image;
|
|
1132
|
+
/** A definition of what videos should be supported */
|
|
1133
|
+
video?: Video;
|
|
1134
|
+
/** A definition of what vector arts should be supported */
|
|
1135
|
+
vectorArt?: VectorArt;
|
|
1136
|
+
/** An definition of a nested data-object */
|
|
1137
|
+
data?: DataItems;
|
|
1138
|
+
/** A definition of a custom function */
|
|
1139
|
+
function?: EditorFunction;
|
|
1140
|
+
/** Defines the type of data we are configuring */
|
|
1141
|
+
dataType?: DataType;
|
|
1142
|
+
/**
|
|
1143
|
+
* Display name of this data item
|
|
1144
|
+
* @maxLength 100
|
|
1145
|
+
*/
|
|
1146
|
+
displayName?: string | null;
|
|
1147
|
+
/** The default value of this data item (only for display purposes). */
|
|
1148
|
+
defaultValue?: any;
|
|
1149
|
+
/* Excluded from this release type: deprecated */
|
|
1150
|
+
/** Disables the ability to delete this data-item value in the Editor UI */
|
|
1151
|
+
disableDeletion?: boolean | null;
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
declare interface DataItemOverrides extends DataItemOverridesSelectedDataTypeOneOf {
|
|
1155
|
+
/** Overrides the definition of what images should be supported */
|
|
1156
|
+
image?: ImageOverrides;
|
|
1157
|
+
/** Overrides the definition of what videos should be supported */
|
|
1158
|
+
video?: VideoOverrides;
|
|
1159
|
+
/** Overrides the definition of what vector arts should be supported */
|
|
1160
|
+
vectorArt?: VectorArtOverrides;
|
|
1161
|
+
/** Disables the ability to edit this data-item */
|
|
1162
|
+
disableEditing?: boolean | null;
|
|
1163
|
+
/** Overrides the default value of this data-item */
|
|
1164
|
+
defaultValue?: any;
|
|
1165
|
+
/**
|
|
1166
|
+
* Overrides the display name of this data-item
|
|
1167
|
+
* @maxLength 100
|
|
1168
|
+
*/
|
|
1169
|
+
displayName?: string | null;
|
|
1170
|
+
/** Overrides the ability to delete this data-item value in the Editor UI */
|
|
1171
|
+
disableDeletion?: boolean | null;
|
|
1172
|
+
}
|
|
1173
|
+
|
|
1174
|
+
/** @oneof */
|
|
1175
|
+
declare interface DataItemOverridesSelectedDataTypeOneOf {
|
|
1176
|
+
/** Overrides the definition of what images should be supported */
|
|
1177
|
+
image?: ImageOverrides;
|
|
1178
|
+
/** Overrides the definition of what videos should be supported */
|
|
1179
|
+
video?: VideoOverrides;
|
|
1180
|
+
/** Overrides the definition of what vector arts should be supported */
|
|
1181
|
+
vectorArt?: VectorArtOverrides;
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
export declare interface DataItems {
|
|
1185
|
+
/**
|
|
1186
|
+
* For an array of complex object types
|
|
1187
|
+
* Each item in the array, will contain all this data structure
|
|
1188
|
+
*/
|
|
1189
|
+
items?: Record<string, DataItem>;
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
/** @oneof */
|
|
1193
|
+
declare interface DataItemSelectedDataTypeOneOf {
|
|
1194
|
+
/** An optional object to define limitations on the text input */
|
|
1195
|
+
text?: Text_2;
|
|
1196
|
+
/** A required list of options to supply to the users to choose from */
|
|
1197
|
+
textEnum?: TextEnum;
|
|
1198
|
+
/** An optional set of restrictions to apply to the number */
|
|
1199
|
+
number?: DataNumber;
|
|
1200
|
+
/** A required list of types we want to user to be able to specify, empty means all possible A11Y values */
|
|
1201
|
+
a11y?: A11y;
|
|
1202
|
+
/** A definition of what links should be supported */
|
|
1203
|
+
link?: Link;
|
|
1204
|
+
/** An array of a data type */
|
|
1205
|
+
arrayItems?: ArrayItems;
|
|
1206
|
+
/** A container in which to render another component */
|
|
1207
|
+
container?: ReactElementContainer;
|
|
1208
|
+
/** A definition of what rich text abilities should be supported */
|
|
1209
|
+
richText?: RichText;
|
|
1210
|
+
/** A definition of what images should be supported */
|
|
1211
|
+
image?: Image;
|
|
1212
|
+
/** A definition of what videos should be supported */
|
|
1213
|
+
video?: Video;
|
|
1214
|
+
/** A definition of what vector arts should be supported */
|
|
1215
|
+
vectorArt?: VectorArt;
|
|
1216
|
+
/** An definition of a nested data-object */
|
|
1217
|
+
data?: DataItems;
|
|
1218
|
+
/** A definition of a custom function */
|
|
1219
|
+
function?: EditorFunction;
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
export declare type DataItemsMap = NonNullable<DataItems['items']>;
|
|
1223
|
+
|
|
1224
|
+
export declare interface DataNumber {
|
|
1225
|
+
/**
|
|
1226
|
+
* @deprecated
|
|
1227
|
+
* @replacedBy min
|
|
1228
|
+
* @targetRemovalDate 2025-11-30
|
|
1229
|
+
*/
|
|
1230
|
+
minimum?: number | null;
|
|
1231
|
+
/**
|
|
1232
|
+
* Indicates minimum value required for the number
|
|
1233
|
+
* @format DECIMAL_VALUE
|
|
1234
|
+
*/
|
|
1235
|
+
min?: string | null;
|
|
1236
|
+
/**
|
|
1237
|
+
* @deprecated
|
|
1238
|
+
* @replacedBy max
|
|
1239
|
+
* @targetRemovalDate 2025-11-30
|
|
1240
|
+
*/
|
|
1241
|
+
maximum?: number | null;
|
|
1242
|
+
/**
|
|
1243
|
+
* Indicates maximum value allowed for the number
|
|
1244
|
+
* @format DECIMAL_VALUE
|
|
1245
|
+
*/
|
|
1246
|
+
max?: string | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* @deprecated
|
|
1249
|
+
* @replacedBy multiplier
|
|
1250
|
+
* @targetRemovalDate 2025-11-30
|
|
1251
|
+
*/
|
|
1252
|
+
multipleOf?: number | null;
|
|
1253
|
+
/**
|
|
1254
|
+
* The multiplier for the number value
|
|
1255
|
+
* @format DECIMAL_VALUE
|
|
1256
|
+
*/
|
|
1257
|
+
multiplier?: string | null;
|
|
1258
|
+
}
|
|
1259
|
+
|
|
1260
|
+
export declare type DataOverrides = NonNullable<RefElement['data']>;
|
|
1261
|
+
|
|
1262
|
+
declare enum DataType {
|
|
1263
|
+
UNKNOWN_DataType = "UNKNOWN_DataType",
|
|
1264
|
+
/** A simple text value */
|
|
1265
|
+
text = "text",
|
|
1266
|
+
/** A list of predefined textual values to choose from */
|
|
1267
|
+
textEnum = "textEnum",
|
|
1268
|
+
/** Any number */
|
|
1269
|
+
number = "number",
|
|
1270
|
+
/** true / false value */
|
|
1271
|
+
booleanValue = "booleanValue",
|
|
1272
|
+
/** An object containing the selected A11Y fields chosen */
|
|
1273
|
+
a11y = "a11y",
|
|
1274
|
+
/** A Wix Link object type */
|
|
1275
|
+
link = "link",
|
|
1276
|
+
/** A Wix Image object type */
|
|
1277
|
+
image = "image",
|
|
1278
|
+
/** A Wix Video object type */
|
|
1279
|
+
video = "video",
|
|
1280
|
+
/** A Wix Sanitized Vector Art object */
|
|
1281
|
+
vectorArt = "vectorArt",
|
|
1282
|
+
/** A Wix Audio object */
|
|
1283
|
+
audio = "audio",
|
|
1284
|
+
/** DEPRECATED - use the `data` dataType instead. A [JSON Schema definition](https://json-schema.org/specification) the developer understands in his code (useful for complex props). Some limitation may apply. */
|
|
1285
|
+
schema = "schema",
|
|
1286
|
+
/** Local date output ISO-8601 extended local date format (YYYY-MM-DD) */
|
|
1287
|
+
localDate = "localDate",
|
|
1288
|
+
/** Local time output ISO-8601 extended local time format (hh:mm[:ss][.sss]) */
|
|
1289
|
+
localTime = "localTime",
|
|
1290
|
+
/** Local Date Time output ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss]) */
|
|
1291
|
+
localDateTime = "localDateTime",
|
|
1292
|
+
/** a URL with scheme http or https */
|
|
1293
|
+
webUrl = "webUrl",
|
|
1294
|
+
/** standard email address according to [RFC 5321, section 4.1.2](https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.2) */
|
|
1295
|
+
email = "email",
|
|
1296
|
+
/** a validation format designed to match phone numbers with a variety of common characters, including digits (0-9), spaces, parentheses, plus sign, hyphens, and periods */
|
|
1297
|
+
phone = "phone",
|
|
1298
|
+
/** hostname according to IANA */
|
|
1299
|
+
hostname = "hostname",
|
|
1300
|
+
/** A valid `regex` pattern supplied by the User */
|
|
1301
|
+
regex = "regex",
|
|
1302
|
+
/** A unique identifier */
|
|
1303
|
+
guid = "guid",
|
|
1304
|
+
/** a HTML text with css inline styling */
|
|
1305
|
+
richText = "richText",
|
|
1306
|
+
/** A container place in the component that will be passed in as {children} or a function prop, depending on the case */
|
|
1307
|
+
container = "container",
|
|
1308
|
+
/** An array type of data */
|
|
1309
|
+
arrayItems = "arrayItems",
|
|
1310
|
+
/** selected `direction` for the component according to (HTML `dir` attribute)[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir] */
|
|
1311
|
+
direction = "direction",
|
|
1312
|
+
/** A list of menu-items */
|
|
1313
|
+
menuItems = "menuItems",
|
|
1314
|
+
/** A complex data type that can be used to define a data structure, such as an object or a map */
|
|
1315
|
+
data = "data",
|
|
1316
|
+
/** A custom function that can be used to call a function from a custom library */
|
|
1317
|
+
'function' = "function",
|
|
1318
|
+
/** Standard [onClick handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event), can also handle: `()=>void` */
|
|
1319
|
+
onClick = "onClick",
|
|
1320
|
+
/** Standard input event [onChange](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event) for text inputs, can also handle: `(value: string) => void` */
|
|
1321
|
+
onChange = "onChange",
|
|
1322
|
+
/** Standard [onKeyPress handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keypress_event), can also handle: `(event: KeyboardEvent) => void` */
|
|
1323
|
+
onKeyPress = "onKeyPress",
|
|
1324
|
+
/** Standard [onKeyUp handler](https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event), can also handle: `(event: KeyboardEvent) => void` */
|
|
1325
|
+
onKeyUp = "onKeyUp",
|
|
1326
|
+
/** Standard [onSubmit handler](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event), can also handle: `() => void` */
|
|
1327
|
+
onSubmit = "onSubmit"
|
|
1328
|
+
}
|
|
1329
|
+
|
|
1330
|
+
declare interface DefaultPresets {
|
|
1331
|
+
/**
|
|
1332
|
+
* Default preset ID in small (mobile) breakpoint
|
|
1333
|
+
* @minLength 1
|
|
1334
|
+
* @maxLength 50
|
|
1335
|
+
*/
|
|
1336
|
+
small?: string | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* Deprecated, use default - Default preset ID in large (desktop) breakpoint
|
|
1339
|
+
* @minLength 1
|
|
1340
|
+
* @maxLength 50
|
|
1341
|
+
* @deprecated Deprecated, use default - Default preset ID in large (desktop) breakpoint
|
|
1342
|
+
* @replacedBy default
|
|
1343
|
+
* @targetRemovalDate 2025-12-02
|
|
1344
|
+
*/
|
|
1345
|
+
large?: string | null;
|
|
1346
|
+
/**
|
|
1347
|
+
* Default preset ID
|
|
1348
|
+
* @minLength 1
|
|
1349
|
+
* @maxLength 50
|
|
1350
|
+
*/
|
|
1351
|
+
default?: string | null;
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
export declare interface Display {
|
|
1355
|
+
/**
|
|
1356
|
+
* list of display values in case we want to reduce the abilities exposed to the User
|
|
1357
|
+
* @maxSize 20
|
|
1358
|
+
*/
|
|
1359
|
+
displayValues?: DisplayValueEnumDisplayValue[];
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
export declare const DISPLAY_GROUPS: {
|
|
1363
|
+
GROUP_TYPE: typeof GroupType;
|
|
1364
|
+
};
|
|
1365
|
+
|
|
1366
|
+
/**
|
|
1367
|
+
* The logic of the display filter is to define the minimal requirement
|
|
1368
|
+
* You can only provide one of the two fields, `hide` or `show`, but not both.
|
|
1369
|
+
* hide: *All items* not listed here will be shown by the editor. Useful for hiding a small list of items
|
|
1370
|
+
* show: *Only items* listed here will be show by the editor. Useful for hiding a large list of items
|
|
1371
|
+
*/
|
|
1372
|
+
export declare interface DisplayFilter {
|
|
1373
|
+
/**
|
|
1374
|
+
* Selected items to hide
|
|
1375
|
+
* @maxSize 100
|
|
1376
|
+
* @maxLength 80
|
|
1377
|
+
*/
|
|
1378
|
+
hide?: string[];
|
|
1379
|
+
/**
|
|
1380
|
+
* Selected items to show
|
|
1381
|
+
* @maxSize 100
|
|
1382
|
+
* @maxLength 80
|
|
1383
|
+
*/
|
|
1384
|
+
show?: string[];
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
export declare type DisplayFilters = NonNullable<EditorElement['displayFilters']>;
|
|
1388
|
+
|
|
1389
|
+
/**
|
|
1390
|
+
* DisplayFilters is a collection of display filters that can be used to hide or show elements in the editor.
|
|
1391
|
+
* It is used to control the visibility of elements in the editor.
|
|
1392
|
+
* It is used to control the visibility of style items of elements in the editor.
|
|
1393
|
+
* It is used to control the visibility of data items of elements in the editor.
|
|
1394
|
+
* It is used to control the visibility of custom actions of elements in the editor.
|
|
1395
|
+
* The logical order of filtering is done from where the filter is defined.
|
|
1396
|
+
* Element takes first priority in narrowing the list, then the Preset and last is the State
|
|
1397
|
+
*/
|
|
1398
|
+
declare interface DisplayFilters_2 {
|
|
1399
|
+
/** DisplayFilter for elements, defines which elements to hide or show, uses the element key in the elements map, optional */
|
|
1400
|
+
elements?: DisplayFilter;
|
|
1401
|
+
/** DisplayFilter for data, defines which data items to hide or show, uses the dataItem key in the data map, optional */
|
|
1402
|
+
data?: DisplayFilter;
|
|
1403
|
+
/** DisplayFilter for custom actions, defines which custom actions to hide or show, uses the customAction key in the customActions map, optional */
|
|
1404
|
+
customActions?: DisplayFilter;
|
|
1405
|
+
/** DisplayFilter for actions, defines which actions to hide or show, uses the key in the action map, optional */
|
|
1406
|
+
actions?: DisplayFilter;
|
|
1407
|
+
/** DisplayFilter for css-properties, defines which properties to hide or show in the editor, uses the css-property name, optional */
|
|
1408
|
+
cssProperties?: DisplayFilter;
|
|
1409
|
+
/** DisplayFilter for css-custom-properties, defines which css-custom-properties to hide or show in the editor, uses the key in the css-custom-properties map, optional */
|
|
1410
|
+
cssCustomProperties?: DisplayFilter;
|
|
1411
|
+
/** DisplayFilter for states, defines which states to hide or show, uses the state key in the states map, optional */
|
|
1412
|
+
states?: DisplayFilter;
|
|
1413
|
+
}
|
|
1414
|
+
|
|
1415
|
+
/**
|
|
1416
|
+
* Represents an action that points into a specific display-group-key,
|
|
1417
|
+
* the outcome will make the chosen display group visible to the user for changing the groups values in the component
|
|
1418
|
+
*/
|
|
1419
|
+
declare interface DisplayGroupAction {
|
|
1420
|
+
/**
|
|
1421
|
+
* The display group to be used
|
|
1422
|
+
* @minLength 1
|
|
1423
|
+
* @maxLength 50
|
|
1424
|
+
*/
|
|
1425
|
+
displayGroupKey?: string;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
export declare interface DisplayGroupItem extends DisplayGroupItemSelectedGroupTypeOneOf {
|
|
1429
|
+
/** A group that contains cssCustomProperties items that used one of the supported css-data-types (length, angle, number, ..._) */
|
|
1430
|
+
cssDataType?: ItemsGroup;
|
|
1431
|
+
/** A group that contains data items */
|
|
1432
|
+
data?: ItemsGroup;
|
|
1433
|
+
/** A group that contains preset items, which will be displayed in the editor as a category in the presets panel */
|
|
1434
|
+
presets?: ItemsGroup;
|
|
1435
|
+
/** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used mostly for ordering purposes */
|
|
1436
|
+
cssCustomProperties?: ItemsGroup;
|
|
1437
|
+
/** A group that contains other displayGroups items that use the same groupType, should be used mostly for ordering purposes */
|
|
1438
|
+
displayGroups?: ItemsGroup;
|
|
1439
|
+
/** A group that contains background items */
|
|
1440
|
+
background?: ShorthandGroupBackground;
|
|
1441
|
+
/** A group that contains margin items */
|
|
1442
|
+
margin?: Coordinates;
|
|
1443
|
+
/** A group that contains padding items */
|
|
1444
|
+
padding?: Coordinates;
|
|
1445
|
+
/** A group that contains border items */
|
|
1446
|
+
border?: ShorthandGroupBorder;
|
|
1447
|
+
/** A group that contains border-top items */
|
|
1448
|
+
borderTop?: ShorthandGroupBorder;
|
|
1449
|
+
/** A group that contains border-right items */
|
|
1450
|
+
borderRight?: ShorthandGroupBorder;
|
|
1451
|
+
/** A group that contains border-bottom items */
|
|
1452
|
+
borderBottom?: ShorthandGroupBorder;
|
|
1453
|
+
/** A group that contains border-left items */
|
|
1454
|
+
borderLeft?: ShorthandGroupBorder;
|
|
1455
|
+
/** A group that contains border-inline-start items */
|
|
1456
|
+
borderInlineStart?: ShorthandGroupBorder;
|
|
1457
|
+
/** A group that contains border-inline-end items */
|
|
1458
|
+
borderInlineEnd?: ShorthandGroupBorder;
|
|
1459
|
+
/** A group that contains border-radius items */
|
|
1460
|
+
borderRadius?: Corners;
|
|
1461
|
+
/** A group that contains font items */
|
|
1462
|
+
font?: Font;
|
|
1463
|
+
/** A group that contains text-decoration items */
|
|
1464
|
+
textDecoration?: TextDecoration;
|
|
1465
|
+
/** A group that contains gap items */
|
|
1466
|
+
gap?: Gap;
|
|
1467
|
+
/** A group that contains border-color items */
|
|
1468
|
+
borderColor?: Coordinates;
|
|
1469
|
+
/** A group that contains border-width items */
|
|
1470
|
+
borderWidth?: Coordinates;
|
|
1471
|
+
/** A group that contains border-style items */
|
|
1472
|
+
borderStyle?: Coordinates;
|
|
1473
|
+
/** a group that contains items related to text */
|
|
1474
|
+
text?: TextGroup;
|
|
1475
|
+
/** A group that contains data-items related to arrayItems, will be used for enhancing the editor experience when editing them */
|
|
1476
|
+
arrayItems?: DataGroupsArrayItems;
|
|
1477
|
+
/** A group that contains common data-items that are used within array-item objects, will be used for enhancing the editor experience when editing them */
|
|
1478
|
+
listItem?: ListItem;
|
|
1479
|
+
/**
|
|
1480
|
+
* Display name for this Group
|
|
1481
|
+
* @maxLength 20
|
|
1482
|
+
*/
|
|
1483
|
+
displayName?: string | null;
|
|
1484
|
+
/** The type of the group, used to determine the group that will be displayed in the editor */
|
|
1485
|
+
groupType?: GroupType;
|
|
1486
|
+
}
|
|
1487
|
+
|
|
1488
|
+
/** @oneof */
|
|
1489
|
+
declare interface DisplayGroupItemSelectedGroupTypeOneOf {
|
|
1490
|
+
/** A group that contains cssCustomProperties items that used one of the supported css-data-types (length, angle, number, ..._) */
|
|
1491
|
+
cssDataType?: ItemsGroup;
|
|
1492
|
+
/** A group that contains data items */
|
|
1493
|
+
data?: ItemsGroup;
|
|
1494
|
+
/** A group that contains preset items, which will be displayed in the editor as a category in the presets panel */
|
|
1495
|
+
presets?: ItemsGroup;
|
|
1496
|
+
/** A group that contains cssCustomProperties items that use the same cssPropertyType, should be used mostly for ordering purposes */
|
|
1497
|
+
cssCustomProperties?: ItemsGroup;
|
|
1498
|
+
/** A group that contains other displayGroups items that use the same groupType, should be used mostly for ordering purposes */
|
|
1499
|
+
displayGroups?: ItemsGroup;
|
|
1500
|
+
/** A group that contains background items */
|
|
1501
|
+
background?: ShorthandGroupBackground;
|
|
1502
|
+
/** A group that contains margin items */
|
|
1503
|
+
margin?: Coordinates;
|
|
1504
|
+
/** A group that contains padding items */
|
|
1505
|
+
padding?: Coordinates;
|
|
1506
|
+
/** A group that contains border items */
|
|
1507
|
+
border?: ShorthandGroupBorder;
|
|
1508
|
+
/** A group that contains border-top items */
|
|
1509
|
+
borderTop?: ShorthandGroupBorder;
|
|
1510
|
+
/** A group that contains border-right items */
|
|
1511
|
+
borderRight?: ShorthandGroupBorder;
|
|
1512
|
+
/** A group that contains border-bottom items */
|
|
1513
|
+
borderBottom?: ShorthandGroupBorder;
|
|
1514
|
+
/** A group that contains border-left items */
|
|
1515
|
+
borderLeft?: ShorthandGroupBorder;
|
|
1516
|
+
/** A group that contains border-inline-start items */
|
|
1517
|
+
borderInlineStart?: ShorthandGroupBorder;
|
|
1518
|
+
/** A group that contains border-inline-end items */
|
|
1519
|
+
borderInlineEnd?: ShorthandGroupBorder;
|
|
1520
|
+
/** A group that contains border-radius items */
|
|
1521
|
+
borderRadius?: Corners;
|
|
1522
|
+
/** A group that contains font items */
|
|
1523
|
+
font?: Font;
|
|
1524
|
+
/** A group that contains text-decoration items */
|
|
1525
|
+
textDecoration?: TextDecoration;
|
|
1526
|
+
/** A group that contains gap items */
|
|
1527
|
+
gap?: Gap;
|
|
1528
|
+
/** A group that contains border-color items */
|
|
1529
|
+
borderColor?: Coordinates;
|
|
1530
|
+
/** A group that contains border-width items */
|
|
1531
|
+
borderWidth?: Coordinates;
|
|
1532
|
+
/** A group that contains border-style items */
|
|
1533
|
+
borderStyle?: Coordinates;
|
|
1534
|
+
/** a group that contains items related to text */
|
|
1535
|
+
text?: TextGroup;
|
|
1536
|
+
/** A group that contains data-items related to arrayItems, will be used for enhancing the editor experience when editing them */
|
|
1537
|
+
arrayItems?: DataGroupsArrayItems;
|
|
1538
|
+
/** A group that contains common data-items that are used within array-item objects, will be used for enhancing the editor experience when editing them */
|
|
1539
|
+
listItem?: ListItem;
|
|
1540
|
+
}
|
|
1541
|
+
|
|
1542
|
+
export declare type DisplayGroups = NonNullable<EditorElement['displayGroups']>;
|
|
1543
|
+
|
|
1544
|
+
declare enum DisplayValueEnumDisplayValue {
|
|
1545
|
+
UNKNOWN_DisplayValue = "UNKNOWN_DisplayValue",
|
|
1546
|
+
none = "none",
|
|
1547
|
+
block = "block",
|
|
1548
|
+
inline = "inline",
|
|
1549
|
+
flow = "flow",
|
|
1550
|
+
flowRoot = "flowRoot",
|
|
1551
|
+
table = "table",
|
|
1552
|
+
flex = "flex",
|
|
1553
|
+
grid = "grid",
|
|
1554
|
+
/** DEPRECATED - use listItem instead */
|
|
1555
|
+
list_item = "list_item",
|
|
1556
|
+
contents = "contents",
|
|
1557
|
+
/** DEPRECATED - use inlineBlock instead */
|
|
1558
|
+
inline_block = "inline_block",
|
|
1559
|
+
/** DEPRECATED - use inlineTable instead */
|
|
1560
|
+
inline_table = "inline_table",
|
|
1561
|
+
/** DEPRECATED - use inlineFlex instead */
|
|
1562
|
+
inline_flex = "inline_flex",
|
|
1563
|
+
/** DEPRECATED - use inlineGrid instead */
|
|
1564
|
+
inline_grid = "inline_grid",
|
|
1565
|
+
inlineBlock = "inlineBlock",
|
|
1566
|
+
inlineTable = "inlineTable",
|
|
1567
|
+
inlineFlex = "inlineFlex",
|
|
1568
|
+
inlineGrid = "inlineGrid",
|
|
1569
|
+
listItem = "listItem"
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
declare interface EditorDependencies {
|
|
1573
|
+
/**
|
|
1574
|
+
* A list of service dependencies required by the component, example: ['@wix/environment']
|
|
1575
|
+
* @maxLength 80
|
|
1576
|
+
* @maxSize 20
|
|
1577
|
+
*/
|
|
1578
|
+
serviceDependencies?: string[];
|
|
1579
|
+
/**
|
|
1580
|
+
* Dependencies on context providers in order to work
|
|
1581
|
+
* @maxLength 80
|
|
1582
|
+
* @maxSize 20
|
|
1583
|
+
*/
|
|
1584
|
+
contextDependencies?: string[];
|
|
1585
|
+
/**
|
|
1586
|
+
* Dependencies on components that we want as externals in our bundle, example: wixEditorElements.AppWidget
|
|
1587
|
+
* @maxLength 80
|
|
1588
|
+
* @maxSize 20
|
|
1589
|
+
*/
|
|
1590
|
+
componentDependencies?: string[];
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
export declare interface EditorElement {
|
|
1594
|
+
/**
|
|
1595
|
+
* DOM Query selector for this element that we can use to find it when rendering it (preferably a className)
|
|
1596
|
+
* @minLength 4
|
|
1597
|
+
* @maxLength 300
|
|
1598
|
+
*/
|
|
1599
|
+
selector?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Human friendly name on the editor stage when the component is in interaction with the user
|
|
1602
|
+
* @maxLength 50
|
|
1603
|
+
*/
|
|
1604
|
+
displayName?: string;
|
|
1605
|
+
/** data-api of this element, a map of data-items where the key is the data-item name and the value is the data-item definition. These will be manifested as `props` for the component */
|
|
1606
|
+
data?: Record<string, DataItem>;
|
|
1607
|
+
/** elements-map of this element, a map of inner-elements where the key is the element name and the value is the element definition */
|
|
1608
|
+
elements?: Record<string, ElementItem>;
|
|
1609
|
+
/** Native actions specified for the component */
|
|
1610
|
+
actions?: Actions;
|
|
1611
|
+
/** Custom actions specified for the component, allowing for flexibility beyond native actions */
|
|
1612
|
+
customActions?: Record<string, ApiAction>;
|
|
1613
|
+
/** Component presets definition. Canonically useful for different layout or theming */
|
|
1614
|
+
presets?: Record<string, PresetItem>;
|
|
1615
|
+
/** Layout capabilities of the component */
|
|
1616
|
+
layout?: EditorElementLayout;
|
|
1617
|
+
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
1618
|
+
archetype?: ARCHETYPE;
|
|
1619
|
+
/** A map with definitions of states that this element can be edited in */
|
|
1620
|
+
states?: Record<string, ElementState>;
|
|
1621
|
+
/** Interactions of the component supports */
|
|
1622
|
+
interactions?: Interactions;
|
|
1623
|
+
/**
|
|
1624
|
+
* Display filters for the Element, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
1625
|
+
* The Element is the first in line to affect the display, Preset and State are after it
|
|
1626
|
+
*/
|
|
1627
|
+
displayFilters?: DisplayFilters_2;
|
|
1628
|
+
/** Display groups for the element, used to group elements in the editor for better UX */
|
|
1629
|
+
displayGroups?: Record<string, DisplayGroupItem>;
|
|
1630
|
+
/** A map of CSS properties that this element supports, where the key is the CSS property name and the value is the CSS property definition */
|
|
1631
|
+
cssProperties?: Record<string, CssPropertyItem>;
|
|
1632
|
+
/** A map of CSS properties that this element supports, where the key is the CSS property name and the value is the CSS property definition */
|
|
1633
|
+
cssCustomProperties?: Record<string, CssCustomPropertyItem>;
|
|
1634
|
+
/** A reference to a help article for this element */
|
|
1635
|
+
helpArticle?: HelpArticle;
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
/** Top-level message containing all layout capabilities */
|
|
1639
|
+
export declare interface EditorElementLayout {
|
|
1640
|
+
/** The resizing capabilities this component can supports */
|
|
1641
|
+
resizeDirection?: ResizeDirection;
|
|
1642
|
+
/** Describes the ability of content to impact on the size of this component */
|
|
1643
|
+
contentResizeDirection?: ContentResizeDirection;
|
|
1644
|
+
/** Will control the availability of the stretch capability for this component */
|
|
1645
|
+
disableStretching?: boolean | null;
|
|
1646
|
+
/** Will control the availability of freely positioning this component */
|
|
1647
|
+
disablePositioning?: boolean | null;
|
|
1648
|
+
/** Will control if the editor allows rotating the element */
|
|
1649
|
+
disableRotation?: boolean | null;
|
|
1650
|
+
/** Information related to content that fills the whole component visible space */
|
|
1651
|
+
contentFill?: ContentFill;
|
|
1652
|
+
/** Will control the availability of the duplicate capability for this component */
|
|
1653
|
+
disableDuplication?: boolean | null;
|
|
1654
|
+
}
|
|
1655
|
+
|
|
1656
|
+
declare interface EditorFunction {
|
|
1657
|
+
/**
|
|
1658
|
+
* The Parameters expected by the function, can be empty
|
|
1659
|
+
* @maxSize 10
|
|
1660
|
+
*/
|
|
1661
|
+
parameters?: FunctionParameter[];
|
|
1662
|
+
/** The result of the function, can be empty for void return */
|
|
1663
|
+
returns?: FunctionReturnType;
|
|
1664
|
+
/** Whether the function returns a promise with the type of the result */
|
|
1665
|
+
async?: boolean | null;
|
|
1666
|
+
/**
|
|
1667
|
+
* The display name of the function for paneles
|
|
1668
|
+
* @maxLength 100
|
|
1669
|
+
*/
|
|
1670
|
+
displayName?: string | null;
|
|
1671
|
+
/**
|
|
1672
|
+
* The description of the function for human readability
|
|
1673
|
+
* @maxLength 300
|
|
1674
|
+
*/
|
|
1675
|
+
description?: string | null;
|
|
1676
|
+
/* Excluded from this release type: deprecated */
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
/** The full model for an imported component set in DEV Center */
|
|
1680
|
+
export declare interface EditorReactComponent {
|
|
1681
|
+
/**
|
|
1682
|
+
* The type of component to present in the Page tree, will be prefixed with AppSlug
|
|
1683
|
+
* @maxLength 100
|
|
1684
|
+
* @minLength 1
|
|
1685
|
+
*/
|
|
1686
|
+
type?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* The public description of the component do display
|
|
1689
|
+
* @maxLength 300
|
|
1690
|
+
* @minLength 3
|
|
1691
|
+
*/
|
|
1692
|
+
description?: string;
|
|
1693
|
+
/** List of component resources. This comprises any runtime code we need to load and execute for the component. */
|
|
1694
|
+
resources?: Resources;
|
|
1695
|
+
/** The configuration describing the component abilities and behaviors on the Editor stage */
|
|
1696
|
+
editorElement?: EditorElement;
|
|
1697
|
+
/** The installation settings of the component */
|
|
1698
|
+
installation?: InstallationInfo;
|
|
1699
|
+
/** Module configuration for NPM-based component */
|
|
1700
|
+
moduleConfiguration?: EditorReactComponentModuleConfiguration;
|
|
1701
|
+
}
|
|
1702
|
+
|
|
1703
|
+
declare interface EditorReactComponentModuleConfiguration {
|
|
1704
|
+
/** Public NPM package details */
|
|
1705
|
+
package?: NPMPackage;
|
|
1706
|
+
/** The component export details */
|
|
1707
|
+
component?: NPMPackageEntry;
|
|
1708
|
+
/** The component CSS File location */
|
|
1709
|
+
cssFile?: NPMPackageEntry;
|
|
1710
|
+
/** The component SSR version export details */
|
|
1711
|
+
server?: NPMPackageEntry;
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
declare enum EffectGroup {
|
|
1715
|
+
UNKNOWN_EFFECT_GROUP = "UNKNOWN_EFFECT_GROUP",
|
|
1716
|
+
/** Effects that are applied to the background layer of the component */
|
|
1717
|
+
background = "background"
|
|
1718
|
+
}
|
|
1719
|
+
|
|
1720
|
+
export declare interface ElementItem extends ElementItemSelectedElementTypeOneOf {
|
|
1721
|
+
/** An new element definition */
|
|
1722
|
+
inlineElement?: InlineElement;
|
|
1723
|
+
/** A reference to the used element with overrides */
|
|
1724
|
+
refElement?: RefElement;
|
|
1725
|
+
/** Defines the type of element we are configuring */
|
|
1726
|
+
elementType?: ElementTypeEnumElementType;
|
|
1727
|
+
/* Excluded from this release type: deprecated */
|
|
1728
|
+
}
|
|
1729
|
+
|
|
1730
|
+
/** @oneof */
|
|
1731
|
+
declare interface ElementItemSelectedElementTypeOneOf {
|
|
1732
|
+
/** An new element definition */
|
|
1733
|
+
inlineElement?: InlineElement;
|
|
1734
|
+
/** A reference to the used element with overrides */
|
|
1735
|
+
refElement?: RefElement;
|
|
1736
|
+
}
|
|
1737
|
+
|
|
1738
|
+
export declare const ELEMENTS: {
|
|
1739
|
+
ELEMENT_TYPE: typeof ElementTypeEnumElementType;
|
|
1740
|
+
};
|
|
1741
|
+
|
|
1742
|
+
export declare type Elements = NonNullable<EditorElement['elements']>;
|
|
1743
|
+
|
|
1744
|
+
export declare type ElementsDefaults = NonNullable<RefElement['elements']>;
|
|
1745
|
+
|
|
1746
|
+
declare interface ElementState {
|
|
1747
|
+
/**
|
|
1748
|
+
* Display name of this state
|
|
1749
|
+
* @maxLength 100
|
|
1750
|
+
*/
|
|
1751
|
+
displayName?: string | null;
|
|
1752
|
+
/**
|
|
1753
|
+
* The class-name to apply when this state is applied
|
|
1754
|
+
* @maxLength 100
|
|
1755
|
+
*/
|
|
1756
|
+
className?: string | null;
|
|
1757
|
+
/** The pseudo-class to used to target this state in the browser */
|
|
1758
|
+
pseudoClass?: NATIVE_STATE_TYPE;
|
|
1759
|
+
/** The state props to apply when this state is applied */
|
|
1760
|
+
props?: Record<string, any>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Display filters for the state, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
1763
|
+
* The state is the last item to affect the display, Element and Preset are before it
|
|
1764
|
+
*/
|
|
1765
|
+
displayFilters?: DisplayFilters_2;
|
|
1766
|
+
/** The element that needs to be targeted when this state is applied */
|
|
1767
|
+
target?: TargetElement;
|
|
1768
|
+
}
|
|
1769
|
+
|
|
1770
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
1771
|
+
declare interface ElementStyleDefaults {
|
|
1772
|
+
/** The default styles for an element */
|
|
1773
|
+
style?: Record<string, StyleItemDefaults>;
|
|
1774
|
+
/** The default preset and styles for inner elements */
|
|
1775
|
+
elements?: Record<string, ElementStyleDefaults>;
|
|
1776
|
+
}
|
|
1777
|
+
|
|
1778
|
+
declare interface ElementStyleOverrides {
|
|
1779
|
+
/**
|
|
1780
|
+
* The override preset for an element
|
|
1781
|
+
* @maxLength 100
|
|
1782
|
+
*/
|
|
1783
|
+
presetKey?: string | null;
|
|
1784
|
+
/**
|
|
1785
|
+
* The override styles for an element
|
|
1786
|
+
* @deprecated The override styles for an element
|
|
1787
|
+
* @replacedBy cssProperties or cssCustomProperties
|
|
1788
|
+
* @targetRemovalDate 2025-08-01
|
|
1789
|
+
*/
|
|
1790
|
+
style?: Record<string, PresetStyleItemOverrides>;
|
|
1791
|
+
/** The override preset and styles for inner elements */
|
|
1792
|
+
elements?: Record<string, ElementStyleOverrides>;
|
|
1793
|
+
/** The default values for the element css-properties when the preset is selected */
|
|
1794
|
+
cssProperties?: Record<string, PresetStyleItemOverrides>;
|
|
1795
|
+
/** The default values for the element css-custom-properties when the preset is selected */
|
|
1796
|
+
cssCustomProperties?: Record<string, PresetStyleItemOverrides>;
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
declare enum ElementTypeEnumElementType {
|
|
1800
|
+
UNKNOWN_ElementType = "UNKNOWN_ElementType",
|
|
1801
|
+
/** An element that was written as part of the component */
|
|
1802
|
+
inlineElement = "inlineElement",
|
|
1803
|
+
/** An element provided by the Wix ecosystem that we are reusing. These elements must exist in the Wix DEV Center. */
|
|
1804
|
+
refElement = "refElement"
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1807
|
+
/** Executes an event-based action. Triggered event should be intercepted in the editor script */
|
|
1808
|
+
export declare interface EventAction {
|
|
1809
|
+
/**
|
|
1810
|
+
* Name of the event to be handled by the editor script
|
|
1811
|
+
* @minLength 1
|
|
1812
|
+
* @maxLength 50
|
|
1813
|
+
*/
|
|
1814
|
+
event?: string;
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
export declare interface Execution extends ExecutionActionExecuteOneOf {
|
|
1818
|
+
/** Executes an action that manipulates component's data */
|
|
1819
|
+
data?: DataAction;
|
|
1820
|
+
/**
|
|
1821
|
+
* Executes an action that manipulates component's style
|
|
1822
|
+
* @deprecated Executes an action that manipulates component's style
|
|
1823
|
+
* @replacedBy cssProperty or cssCustomProperty
|
|
1824
|
+
* @targetRemovalDate 2025-08-01
|
|
1825
|
+
*/
|
|
1826
|
+
style?: StyleAction;
|
|
1827
|
+
/** Executes an event-based action. Triggered event should be intercepted in the editor script */
|
|
1828
|
+
event?: EventAction;
|
|
1829
|
+
/** Opens a URL inside an iframe panel */
|
|
1830
|
+
panel?: PanelAction;
|
|
1831
|
+
/** Executes an action on a target element (based on path) */
|
|
1832
|
+
forward?: ForwardAction;
|
|
1833
|
+
/** Executes an action that is connected to a display-group */
|
|
1834
|
+
displayGroup?: DisplayGroupAction;
|
|
1835
|
+
/** Executes an action that points into a specific css-property-key, */
|
|
1836
|
+
cssProperty?: CssPropertyAction;
|
|
1837
|
+
/** Executes an action that points into a specific css-custom-property-key, */
|
|
1838
|
+
cssCustomProperty?: CssCustomPropertyAction;
|
|
1839
|
+
/** The action type allows to determine the return type of the execution function */
|
|
1840
|
+
actionType?: ActionType;
|
|
1841
|
+
}
|
|
1842
|
+
|
|
1843
|
+
/** @oneof */
|
|
1844
|
+
declare interface ExecutionActionExecuteOneOf {
|
|
1845
|
+
/** Executes an action that manipulates component's data */
|
|
1846
|
+
data?: DataAction;
|
|
1847
|
+
/**
|
|
1848
|
+
* Executes an action that manipulates component's style
|
|
1849
|
+
* @deprecated Executes an action that manipulates component's style
|
|
1850
|
+
* @replacedBy cssProperty or cssCustomProperty
|
|
1851
|
+
* @targetRemovalDate 2025-08-01
|
|
1852
|
+
*/
|
|
1853
|
+
style?: StyleAction;
|
|
1854
|
+
/** Executes an event-based action. Triggered event should be intercepted in the editor script */
|
|
1855
|
+
event?: EventAction;
|
|
1856
|
+
/** Opens a URL inside an iframe panel */
|
|
1857
|
+
panel?: PanelAction;
|
|
1858
|
+
/** Executes an action on a target element (based on path) */
|
|
1859
|
+
forward?: ForwardAction;
|
|
1860
|
+
/** Executes an action that is connected to a display-group */
|
|
1861
|
+
displayGroup?: DisplayGroupAction;
|
|
1862
|
+
/** Executes an action that points into a specific css-property-key, */
|
|
1863
|
+
cssProperty?: CssPropertyAction;
|
|
1864
|
+
/** Executes an action that points into a specific css-custom-property-key, */
|
|
1865
|
+
cssCustomProperty?: CssCustomPropertyAction;
|
|
1866
|
+
}
|
|
1867
|
+
|
|
1868
|
+
export declare interface Filter {
|
|
1869
|
+
/**
|
|
1870
|
+
* List of filter functions in case of reducing the abilities exposed to the User
|
|
1871
|
+
* @maxSize 100
|
|
1872
|
+
*/
|
|
1873
|
+
filterFunctions?: FilterFunction[];
|
|
1874
|
+
}
|
|
1875
|
+
|
|
1876
|
+
declare enum FilterFunction {
|
|
1877
|
+
UNKNOWN_FilterFunctions = "UNKNOWN_FilterFunctions",
|
|
1878
|
+
/** The value used for blur filter */
|
|
1879
|
+
blur = "blur",
|
|
1880
|
+
/** The value used for brightness filter */
|
|
1881
|
+
brightness = "brightness",
|
|
1882
|
+
/** The value used for contrast filter */
|
|
1883
|
+
contrast = "contrast",
|
|
1884
|
+
/** DEPRECATED - use dropShadow instead */
|
|
1885
|
+
drop_shadow = "drop_shadow",
|
|
1886
|
+
/** The value used for grayscale filter */
|
|
1887
|
+
grayscale = "grayscale",
|
|
1888
|
+
/** DEPRECATED - use hueRotate instead */
|
|
1889
|
+
hue_rotate = "hue_rotate",
|
|
1890
|
+
/** The value used for invert filter */
|
|
1891
|
+
invert = "invert",
|
|
1892
|
+
/** The value used for opacity filter */
|
|
1893
|
+
opacity = "opacity",
|
|
1894
|
+
/** The value used for sepia filter */
|
|
1895
|
+
sepia = "sepia",
|
|
1896
|
+
/** The value used for saturate filter */
|
|
1897
|
+
saturate = "saturate",
|
|
1898
|
+
/** The value used for drop-shadow filter */
|
|
1899
|
+
dropShadow = "dropShadow",
|
|
1900
|
+
/** The value used for hue-rotate filter */
|
|
1901
|
+
hueRotate = "hueRotate"
|
|
1902
|
+
}
|
|
1903
|
+
|
|
1904
|
+
/** Fixed position builder for component installation */
|
|
1905
|
+
declare interface FixedPositionBuilder {
|
|
1906
|
+
/** Vertical position in the browser window */
|
|
1907
|
+
vertical?: Vertical;
|
|
1908
|
+
/** Horizontal position in the browser window */
|
|
1909
|
+
horizontal?: Horizontal;
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
export declare interface Font {
|
|
1913
|
+
/**
|
|
1914
|
+
* Stores the font-style property of the font shorthand
|
|
1915
|
+
* @maxLength 100
|
|
1916
|
+
*/
|
|
1917
|
+
fontStyle?: string | null;
|
|
1918
|
+
/**
|
|
1919
|
+
* Stores the font-variant property of the font shorthand
|
|
1920
|
+
* @maxLength 100
|
|
1921
|
+
*/
|
|
1922
|
+
fontVariant?: string | null;
|
|
1923
|
+
/**
|
|
1924
|
+
* Stores the font-weight property of the font shorthand
|
|
1925
|
+
* @maxLength 100
|
|
1926
|
+
*/
|
|
1927
|
+
fontWeight?: string | null;
|
|
1928
|
+
/**
|
|
1929
|
+
* Stores the font-size property of the font shorthand
|
|
1930
|
+
* @maxLength 100
|
|
1931
|
+
*/
|
|
1932
|
+
fontSize?: string | null;
|
|
1933
|
+
/**
|
|
1934
|
+
* Stores the line-height property of the font shorthand
|
|
1935
|
+
* @maxLength 100
|
|
1936
|
+
*/
|
|
1937
|
+
lineHeight?: string | null;
|
|
1938
|
+
/**
|
|
1939
|
+
* Stores the font-family property of the font shorthand
|
|
1940
|
+
* @maxLength 100
|
|
1941
|
+
*/
|
|
1942
|
+
fontFamily?: string | null;
|
|
1943
|
+
/**
|
|
1944
|
+
* Stores the font shorthand item itself, should be used when you want to achieve with this group partial editing of the font shorthand
|
|
1945
|
+
* @maxLength 100
|
|
1946
|
+
*/
|
|
1947
|
+
font?: string | null;
|
|
1948
|
+
}
|
|
1949
|
+
|
|
1950
|
+
/** Represents an action that targets another element within the component */
|
|
1951
|
+
export declare interface ForwardAction extends ForwardActionActionOneOf {
|
|
1952
|
+
/**
|
|
1953
|
+
* Used when actionType is custom
|
|
1954
|
+
* @minLength 1
|
|
1955
|
+
* @maxLength 50
|
|
1956
|
+
*/
|
|
1957
|
+
custom?: string;
|
|
1958
|
+
/** Specifies the action names (one of the natives or custom) */
|
|
1959
|
+
actionName?: ACTION_NAME;
|
|
1960
|
+
/**
|
|
1961
|
+
* Path to the target element
|
|
1962
|
+
* @minLength 1
|
|
1963
|
+
* @maxLength 500
|
|
1964
|
+
*/
|
|
1965
|
+
elementPath?: string;
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1968
|
+
/** @oneof */
|
|
1969
|
+
declare interface ForwardActionActionOneOf {
|
|
1970
|
+
/**
|
|
1971
|
+
* Used when actionType is custom
|
|
1972
|
+
* @minLength 1
|
|
1973
|
+
* @maxLength 50
|
|
1974
|
+
*/
|
|
1975
|
+
custom?: string;
|
|
1976
|
+
}
|
|
1977
|
+
|
|
1978
|
+
declare interface FunctionParameter extends FunctionParameterSelectedDataTypeOneOf {
|
|
1979
|
+
/** In case of an array */
|
|
1980
|
+
arrayItems?: FunctionParameterArrayItems;
|
|
1981
|
+
/** In case of a complex object */
|
|
1982
|
+
data?: FunctionParameterItems;
|
|
1983
|
+
/** In case of a function */
|
|
1984
|
+
function?: EditorFunction;
|
|
1985
|
+
/** In case of a text enum */
|
|
1986
|
+
textEnum?: TextEnum;
|
|
1987
|
+
/** The type of the Parameter, does not include containers */
|
|
1988
|
+
dataType?: DataType;
|
|
1989
|
+
/** Whether the Parameter is optional, limitations of Javascript apply, only the last parameters can be optional */
|
|
1990
|
+
optional?: boolean | null;
|
|
1991
|
+
/**
|
|
1992
|
+
* The default value for this parameter, applicable when the parameter is optional,
|
|
1993
|
+
* this is for description purposes only and will NOT be injected at runtime
|
|
1994
|
+
*/
|
|
1995
|
+
defaultValue?: any;
|
|
1996
|
+
/**
|
|
1997
|
+
* The display name of the Parameter for human readability
|
|
1998
|
+
* @maxLength 100
|
|
1999
|
+
*/
|
|
2000
|
+
displayName?: string | null;
|
|
2001
|
+
/** @maxLength 100 */
|
|
2002
|
+
description?: string | null;
|
|
2003
|
+
/* Excluded from this release type: deprecated */
|
|
2004
|
+
}
|
|
2005
|
+
|
|
2006
|
+
/** An array of data items or complex data types */
|
|
2007
|
+
declare interface FunctionParameterArrayItems extends FunctionParameterArrayItemsArrayDataOneOf {
|
|
2008
|
+
/** For a single data type in the array, including another array */
|
|
2009
|
+
item?: FunctionParameter;
|
|
2010
|
+
}
|
|
2011
|
+
|
|
2012
|
+
/** @oneof */
|
|
2013
|
+
declare interface FunctionParameterArrayItemsArrayDataOneOf {
|
|
2014
|
+
/** For a single data type in the array, including another array */
|
|
2015
|
+
item?: FunctionParameter;
|
|
2016
|
+
}
|
|
2017
|
+
|
|
2018
|
+
declare interface FunctionParameterItems {
|
|
2019
|
+
/**
|
|
2020
|
+
* For an array of complex object types
|
|
2021
|
+
* Each item in the array, will contain all this data structure
|
|
2022
|
+
*/
|
|
2023
|
+
items?: Record<string, FunctionParameter>;
|
|
2024
|
+
}
|
|
2025
|
+
|
|
2026
|
+
/** @oneof */
|
|
2027
|
+
declare interface FunctionParameterSelectedDataTypeOneOf {
|
|
2028
|
+
/** In case of an array */
|
|
2029
|
+
arrayItems?: FunctionParameterArrayItems;
|
|
2030
|
+
/** In case of a complex object */
|
|
2031
|
+
data?: FunctionParameterItems;
|
|
2032
|
+
/** In case of a function */
|
|
2033
|
+
function?: EditorFunction;
|
|
2034
|
+
/** In case of a text enum */
|
|
2035
|
+
textEnum?: TextEnum;
|
|
2036
|
+
}
|
|
2037
|
+
|
|
2038
|
+
declare interface FunctionReturnType extends FunctionReturnTypeSelectedDataTypeOneOf {
|
|
2039
|
+
/** In case of an array */
|
|
2040
|
+
arrayItems?: FunctionParameterArrayItems;
|
|
2041
|
+
/** In case of a complex object */
|
|
2042
|
+
data?: FunctionParameterItems;
|
|
2043
|
+
/** In case of a text enum */
|
|
2044
|
+
textEnum?: TextEnum;
|
|
2045
|
+
/** The type of the return value, does not include containers */
|
|
2046
|
+
dataType?: DataType;
|
|
2047
|
+
/**
|
|
2048
|
+
* The display name of the return type for human readability
|
|
2049
|
+
* @maxLength 100
|
|
2050
|
+
*/
|
|
2051
|
+
displayName?: string | null;
|
|
2052
|
+
/**
|
|
2053
|
+
* The description of the function return type for human readability
|
|
2054
|
+
* @maxLength 100
|
|
2055
|
+
*/
|
|
2056
|
+
description?: string | null;
|
|
2057
|
+
}
|
|
2058
|
+
|
|
2059
|
+
/** @oneof */
|
|
2060
|
+
declare interface FunctionReturnTypeSelectedDataTypeOneOf {
|
|
2061
|
+
/** In case of an array */
|
|
2062
|
+
arrayItems?: FunctionParameterArrayItems;
|
|
2063
|
+
/** In case of a complex object */
|
|
2064
|
+
data?: FunctionParameterItems;
|
|
2065
|
+
/** In case of a text enum */
|
|
2066
|
+
textEnum?: TextEnum;
|
|
2067
|
+
}
|
|
2068
|
+
|
|
2069
|
+
export declare interface Gap {
|
|
2070
|
+
/**
|
|
2071
|
+
* Stores the row-gap property of the gap shorthand
|
|
2072
|
+
* @maxLength 100
|
|
2073
|
+
*/
|
|
2074
|
+
rowGap?: string | null;
|
|
2075
|
+
/**
|
|
2076
|
+
* Stores the column-gap property of the gap shorthand
|
|
2077
|
+
* @maxLength 100
|
|
2078
|
+
*/
|
|
2079
|
+
columnGap?: string | null;
|
|
2080
|
+
/**
|
|
2081
|
+
* Stores the gap shorthand item itself, should be used when you want to achieve with this group partial editing of the gap shorthand
|
|
2082
|
+
* @maxLength 100
|
|
2083
|
+
*/
|
|
2084
|
+
gap?: string | null;
|
|
2085
|
+
}
|
|
2086
|
+
|
|
2087
|
+
declare enum GroupType {
|
|
2088
|
+
UNKNOWN_GroupType = "UNKNOWN_GroupType",
|
|
2089
|
+
cssDataType = "cssDataType",
|
|
2090
|
+
/** Deprecated, use `data` instead; */
|
|
2091
|
+
dataType = "dataType",
|
|
2092
|
+
/** Deprecated, use `presets` instead */
|
|
2093
|
+
preset = "preset",
|
|
2094
|
+
data = "data",
|
|
2095
|
+
presets = "presets",
|
|
2096
|
+
cssCustomProperties = "cssCustomProperties",
|
|
2097
|
+
displayGroups = "displayGroups",
|
|
2098
|
+
/** Style Shorthand Groups */
|
|
2099
|
+
background = "background",
|
|
2100
|
+
margin = "margin",
|
|
2101
|
+
padding = "padding",
|
|
2102
|
+
border = "border",
|
|
2103
|
+
borderTop = "borderTop",
|
|
2104
|
+
borderRight = "borderRight",
|
|
2105
|
+
borderBottom = "borderBottom",
|
|
2106
|
+
borderLeft = "borderLeft",
|
|
2107
|
+
borderRadius = "borderRadius",
|
|
2108
|
+
borderInlineStart = "borderInlineStart",
|
|
2109
|
+
borderInlineEnd = "borderInlineEnd",
|
|
2110
|
+
borderColor = "borderColor",
|
|
2111
|
+
borderWidth = "borderWidth",
|
|
2112
|
+
borderStyle = "borderStyle",
|
|
2113
|
+
font = "font",
|
|
2114
|
+
textDecoration = "textDecoration",
|
|
2115
|
+
gap = "gap",
|
|
2116
|
+
/** Mixed Variables Groups */
|
|
2117
|
+
text = "text",
|
|
2118
|
+
/** Data Groups */
|
|
2119
|
+
arrayItems = "arrayItems",
|
|
2120
|
+
/** Deprecated, use `listItem` instead */
|
|
2121
|
+
arrayItem = "arrayItem",
|
|
2122
|
+
listItem = "listItem"
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2125
|
+
export declare interface HelpArticle extends HelpArticleArticleTypeOneOf {
|
|
2126
|
+
/* Excluded from this release type: kbId */
|
|
2127
|
+
/**
|
|
2128
|
+
* A URL to an external help article
|
|
2129
|
+
* @format WEB_URL
|
|
2130
|
+
*/
|
|
2131
|
+
url?: string | null;
|
|
2132
|
+
}
|
|
2133
|
+
|
|
2134
|
+
/** @oneof */
|
|
2135
|
+
declare interface HelpArticleArticleTypeOneOf {
|
|
2136
|
+
/* Excluded from this release type: kbId */
|
|
2137
|
+
/**
|
|
2138
|
+
* A URL to an external help article
|
|
2139
|
+
* @format WEB_URL
|
|
2140
|
+
*/
|
|
2141
|
+
url?: string | null;
|
|
2142
|
+
}
|
|
2143
|
+
|
|
2144
|
+
declare enum Horizontal {
|
|
2145
|
+
NONE = "NONE",
|
|
2146
|
+
LEFT = "LEFT",
|
|
2147
|
+
CENTER = "CENTER",
|
|
2148
|
+
RIGHT = "RIGHT"
|
|
2149
|
+
}
|
|
2150
|
+
|
|
2151
|
+
export declare interface Image {
|
|
2152
|
+
/** media manager categories to open media manager filtered by the component needs */
|
|
2153
|
+
category?: ImageCategoryTypes;
|
|
2154
|
+
}
|
|
2155
|
+
|
|
2156
|
+
/** Categories to open media manager filtered by the component needs */
|
|
2157
|
+
declare enum ImageCategoryTypes {
|
|
2158
|
+
/** Default value when image category is not specified */
|
|
2159
|
+
UNKNOWN_CategoryName = "UNKNOWN_CategoryName",
|
|
2160
|
+
/** Images - mapped to IMAGE */
|
|
2161
|
+
IMAGE = "IMAGE",
|
|
2162
|
+
/** Background Images - mapped to BG_IMAGE */
|
|
2163
|
+
IMAGE_BACKGROUND = "IMAGE_BACKGROUND"
|
|
2164
|
+
}
|
|
2165
|
+
|
|
2166
|
+
declare interface ImageOverrides {
|
|
2167
|
+
/** media manager categories to open media manager filtered by the overriding component needs */
|
|
2168
|
+
category?: ImageCategoryTypes;
|
|
2169
|
+
}
|
|
2170
|
+
|
|
2171
|
+
declare enum ImageType {
|
|
2172
|
+
UNKNOWN_ImageType = "UNKNOWN_ImageType",
|
|
2173
|
+
url = "url",
|
|
2174
|
+
image = "image",
|
|
2175
|
+
imageSet = "imageSet",
|
|
2176
|
+
crossFade = "crossFade",
|
|
2177
|
+
element = "element",
|
|
2178
|
+
gradient = "gradient"
|
|
2179
|
+
}
|
|
2180
|
+
|
|
2181
|
+
declare interface InitialSizeSetting extends InitialSizeSettingSelectedSizingTypeOneOf {
|
|
2182
|
+
/**
|
|
2183
|
+
* The value we should set as initial size in pixels
|
|
2184
|
+
* @min 1
|
|
2185
|
+
*/
|
|
2186
|
+
pixels?: number;
|
|
2187
|
+
/** The initial size type */
|
|
2188
|
+
sizingType?: SizingType;
|
|
2189
|
+
}
|
|
2190
|
+
|
|
2191
|
+
/** @oneof */
|
|
2192
|
+
declare interface InitialSizeSettingSelectedSizingTypeOneOf {
|
|
2193
|
+
/**
|
|
2194
|
+
* The value we should set as initial size in pixels
|
|
2195
|
+
* @min 1
|
|
2196
|
+
*/
|
|
2197
|
+
pixels?: number;
|
|
2198
|
+
}
|
|
2199
|
+
|
|
2200
|
+
export declare interface InlineElement {
|
|
2201
|
+
/**
|
|
2202
|
+
* Relative DOM Query selector for this element to the component root. We assume nesting by it's parent elements for CSS Vars scoping.
|
|
2203
|
+
* @minLength 4
|
|
2204
|
+
* @maxLength 300
|
|
2205
|
+
*/
|
|
2206
|
+
selector?: string;
|
|
2207
|
+
/**
|
|
2208
|
+
* Human friendly name on the editor stage when the component is in interaction with the user
|
|
2209
|
+
* @maxLength 50
|
|
2210
|
+
*/
|
|
2211
|
+
displayName?: string;
|
|
2212
|
+
/** style-api of this element, a map of style-items where the key is the style-item name and the value is the style-item definition. These will be manifested as CSS vars in the scope of the component and prefixed with `--` */
|
|
2213
|
+
style?: Record<string, StyleItem>;
|
|
2214
|
+
/** data-api of this element, a map of data-items where the key is the data-item name and the value is the data-item definition */
|
|
2215
|
+
data?: Record<string, DataItem>;
|
|
2216
|
+
/** elements-map of this element, a map of inner-elements where the key is the element name and the value is the element definition */
|
|
2217
|
+
elements?: Record<string, ElementItem>;
|
|
2218
|
+
/** editor-behaviors-api of this inner-element, will determine which type of editor experiences this inner-element should support */
|
|
2219
|
+
behaviors?: Behaviors;
|
|
2220
|
+
/** Collection of the native actions specified for the concrete component */
|
|
2221
|
+
actions?: Actions;
|
|
2222
|
+
/** Custom actions specified for the component, allowing for flexibility beyond native actions */
|
|
2223
|
+
customActions?: Record<string, ApiAction>;
|
|
2224
|
+
/** Component presets definition. Canonically useful for different layout or theming */
|
|
2225
|
+
presets?: Record<string, PresetItem>;
|
|
2226
|
+
/** The Archetype this component adheres to, to be used for classification by AI models */
|
|
2227
|
+
archetype?: ARCHETYPE;
|
|
2228
|
+
/** A map with definitions of states that this element can be edited in */
|
|
2229
|
+
states?: Record<string, ElementState>;
|
|
2230
|
+
/** A reference to a state that needs to be triggered in order for this element to be visible */
|
|
2231
|
+
visibleState?: VisibleState;
|
|
2232
|
+
/**
|
|
2233
|
+
* Display filters for the Element, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
2234
|
+
* The Element is the first in line to affect the display, Preset and State are after it
|
|
2235
|
+
*/
|
|
2236
|
+
displayFilters?: DisplayFilters_2;
|
|
2237
|
+
/** Display groups for the element, used to group elements in the editor for better UX */
|
|
2238
|
+
displayGroups?: Record<string, DisplayGroupItem>;
|
|
2239
|
+
/** A map of css-properties that this element supports, where the key is the CSS property name and the value is the CSS property definition */
|
|
2240
|
+
cssProperties?: Record<string, CssPropertyItem>;
|
|
2241
|
+
/** A map of css-custom-properties that this element supports, where the key is the CSS property name and the value is the CSS property definition */
|
|
2242
|
+
cssCustomProperties?: Record<string, CssCustomPropertyItem>;
|
|
2243
|
+
/** A reference to a help article for this element */
|
|
2244
|
+
helpArticle?: HelpArticle;
|
|
2245
|
+
}
|
|
2246
|
+
|
|
2247
|
+
declare interface InstallationInfo extends InstallationInfoTargetContainerOneOf {
|
|
2248
|
+
/** Which static container should the component be installed at */
|
|
2249
|
+
staticContainer?: StaticContainer;
|
|
2250
|
+
/** Default presets per breakpoint with which the component should be installed */
|
|
2251
|
+
presets?: DefaultPresets;
|
|
2252
|
+
/** Initial size with which the component should be added to the stage */
|
|
2253
|
+
initialSize?: ComponentInitialSize;
|
|
2254
|
+
/** Fixed position options for the component. If set, the component will be pinned to the specified position, and can't be unpinned */
|
|
2255
|
+
fixedPosition?: FixedPositionBuilder;
|
|
2256
|
+
}
|
|
2257
|
+
|
|
2258
|
+
/** @oneof */
|
|
2259
|
+
declare interface InstallationInfoTargetContainerOneOf {
|
|
2260
|
+
/** Which static container should the component be installed at */
|
|
2261
|
+
staticContainer?: StaticContainer;
|
|
2262
|
+
}
|
|
2263
|
+
|
|
2264
|
+
export declare const INTERACTIONS: {
|
|
2265
|
+
TRIGGER_TYPE: typeof InteractionsTrigger;
|
|
2266
|
+
EFFECT_GROUP: typeof EffectGroup;
|
|
2267
|
+
};
|
|
2268
|
+
|
|
2269
|
+
declare interface Interactions {
|
|
2270
|
+
/** @maxSize 7 */
|
|
2271
|
+
triggers?: InteractionsTrigger[];
|
|
2272
|
+
/** @maxSize 1 */
|
|
2273
|
+
effectGroups?: EffectGroup[];
|
|
2274
|
+
}
|
|
2275
|
+
|
|
2276
|
+
declare enum InteractionsTrigger {
|
|
2277
|
+
UNKNOWN_TRIGGER = "UNKNOWN_TRIGGER",
|
|
2278
|
+
/** When a compoent is hovered */
|
|
2279
|
+
hover = "hover",
|
|
2280
|
+
/** When a component is clicked */
|
|
2281
|
+
click = "click",
|
|
2282
|
+
/** When the component enters the viewport */
|
|
2283
|
+
viewEnter = "viewEnter",
|
|
2284
|
+
/** Used for infinite-loop animations - mapped to `state` type of https://drafts.csswg.org/css-animations-2/#animation-trigger-type */
|
|
2285
|
+
pageVisible = "pageVisible",
|
|
2286
|
+
/** Mapped to native ViewTimeline */
|
|
2287
|
+
viewProgress = "viewProgress",
|
|
2288
|
+
/** Mapped to pointermove events on the element */
|
|
2289
|
+
pointerMove = "pointerMove",
|
|
2290
|
+
/** Mapped to animationend events */
|
|
2291
|
+
animationEnd = "animationEnd"
|
|
2292
|
+
}
|
|
2293
|
+
|
|
2294
|
+
/** A path to a data item within the same element scope. */
|
|
2295
|
+
declare interface ItemPath {
|
|
2296
|
+
/**
|
|
2297
|
+
* The key of the data item within the element's data scope.
|
|
2298
|
+
* Example: "items" – top-level data item 'items'
|
|
2299
|
+
* Example: "slides.title" – inner key 'title' of data item 'slides'
|
|
2300
|
+
* @minLength 1
|
|
2301
|
+
*/
|
|
2302
|
+
dataItemKey?: string;
|
|
2303
|
+
}
|
|
2304
|
+
|
|
2305
|
+
export declare interface ItemsGroup {
|
|
2306
|
+
/**
|
|
2307
|
+
* A list of items that should be in this group
|
|
2308
|
+
* @maxSize 300
|
|
2309
|
+
* @maxLength 100
|
|
2310
|
+
*/
|
|
2311
|
+
items?: string[];
|
|
2312
|
+
}
|
|
2313
|
+
|
|
2314
|
+
export declare const LAYOUT: {
|
|
2315
|
+
RESIZE_DIRECTION: typeof ResizeDirection;
|
|
2316
|
+
CONTENT_RESIZE_DIRECTION: typeof ContentResizeDirection;
|
|
2317
|
+
SIZING_TYPE: typeof SizingType;
|
|
2318
|
+
BREAKPOINT: typeof BreakpointEnumBreakpoint;
|
|
2319
|
+
};
|
|
2320
|
+
|
|
2321
|
+
export declare interface Link {
|
|
2322
|
+
/**
|
|
2323
|
+
* A collection of possible link types that the component supports. Only one of the types will make it to the component after input.
|
|
2324
|
+
* @maxSize 12
|
|
2325
|
+
*/
|
|
2326
|
+
linkTypes?: LinkType[];
|
|
2327
|
+
}
|
|
2328
|
+
|
|
2329
|
+
declare enum LinkType {
|
|
2330
|
+
UNKNOWN_LinkType = "UNKNOWN_LinkType",
|
|
2331
|
+
/** A link to another website */
|
|
2332
|
+
externalLink = "externalLink",
|
|
2333
|
+
/** A link to an item on the current page */
|
|
2334
|
+
anchorLink = "anchorLink",
|
|
2335
|
+
/** A valid email link (`mailto:example@example.com`) */
|
|
2336
|
+
emailLink = "emailLink",
|
|
2337
|
+
/** A valid phone link (`phone:11111111111`) */
|
|
2338
|
+
phoneLink = "phoneLink",
|
|
2339
|
+
/** A link to a page in Wix that needs to be selected dynamically */
|
|
2340
|
+
dynamicPageLink = "dynamicPageLink",
|
|
2341
|
+
/** A link to another page on the site */
|
|
2342
|
+
pageLink = "pageLink",
|
|
2343
|
+
/** A link to open a whatsapp conversation */
|
|
2344
|
+
whatsAppLink = "whatsAppLink",
|
|
2345
|
+
/** A link to a PDF file hosted by Wix */
|
|
2346
|
+
documentLink = "documentLink",
|
|
2347
|
+
/** A link that opens a lightbox */
|
|
2348
|
+
popupLink = "popupLink",
|
|
2349
|
+
/** A link that directs the user to an address on google maps */
|
|
2350
|
+
addressLink = "addressLink",
|
|
2351
|
+
/** A link that scrolls to the top/bottom of the page */
|
|
2352
|
+
edgeAnchorLinks = "edgeAnchorLinks",
|
|
2353
|
+
/** A link that directs the user to wix login dialog */
|
|
2354
|
+
loginToWixLink = "loginToWixLink"
|
|
2355
|
+
}
|
|
2356
|
+
|
|
2357
|
+
export declare interface ListItem {
|
|
2358
|
+
/**
|
|
2359
|
+
* Stores the name of the 'arrayItems' that stores the list of items
|
|
2360
|
+
* @maxLength 100
|
|
2361
|
+
*/
|
|
2362
|
+
arrayItems?: string | null;
|
|
2363
|
+
/**
|
|
2364
|
+
* Stores the key of the 'text' data-item that will be used for label of this list-item
|
|
2365
|
+
* @maxLength 100
|
|
2366
|
+
*/
|
|
2367
|
+
label?: string | null;
|
|
2368
|
+
/**
|
|
2369
|
+
* Stores the key of the 'text', 'link' or 'webUrl' data-item that will be used for subtitle of this list-item
|
|
2370
|
+
* @maxLength 100
|
|
2371
|
+
*/
|
|
2372
|
+
subtitle?: string | null;
|
|
2373
|
+
/**
|
|
2374
|
+
* Stores the key of the 'vectorArt' or 'image' data-item that will be used for thumbnail of this list-item
|
|
2375
|
+
* @maxLength 100
|
|
2376
|
+
*/
|
|
2377
|
+
thumbnail?: string | null;
|
|
2378
|
+
}
|
|
2379
|
+
|
|
2380
|
+
declare interface MaskImage {
|
|
2381
|
+
/**
|
|
2382
|
+
* The image types allowed for this mask-image property
|
|
2383
|
+
* @maxSize 6
|
|
2384
|
+
*/
|
|
2385
|
+
imageTypes?: ImageType[];
|
|
2386
|
+
/** The image media manager category to open media manager filtered by the component needs */
|
|
2387
|
+
imageCategory?: ImageCategoryTypes;
|
|
2388
|
+
/** The vector art media manager category to open media manager filtered by the component needs */
|
|
2389
|
+
vectorArtCategory?: VectorArtCategoryTypes;
|
|
2390
|
+
}
|
|
2391
|
+
|
|
2392
|
+
export declare const MEDIA: {
|
|
2393
|
+
VIDEO_CATEGORY: typeof VideoCategoryTypes;
|
|
2394
|
+
VECTOR_ART_CATEGORY: typeof VectorArtCategoryTypes;
|
|
2395
|
+
IMAGE_CATEGORY: typeof ImageCategoryTypes;
|
|
2396
|
+
};
|
|
2397
|
+
|
|
2398
|
+
export declare enum NATIVE_STATE_TYPE {
|
|
2399
|
+
UNKNOWN_NativeStateType = "UNKNOWN_NativeStateType",
|
|
2400
|
+
/** native browser "hover" state */
|
|
2401
|
+
hover = "hover",
|
|
2402
|
+
/** native browser "focus" state */
|
|
2403
|
+
focus = "focus",
|
|
2404
|
+
/** native browser "disabled" state */
|
|
2405
|
+
disabled = "disabled",
|
|
2406
|
+
/** native browser "invalid" state */
|
|
2407
|
+
invalid = "invalid"
|
|
2408
|
+
}
|
|
2409
|
+
|
|
2410
|
+
declare interface NPMPackage {
|
|
2411
|
+
/**
|
|
2412
|
+
* The npm package name
|
|
2413
|
+
* @minLength 1
|
|
2414
|
+
* @maxLength 214
|
|
2415
|
+
*/
|
|
2416
|
+
name?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* the SEMVER package version
|
|
2419
|
+
* @minLength 1
|
|
2420
|
+
* @maxLength 214
|
|
2421
|
+
*/
|
|
2422
|
+
version?: string;
|
|
2423
|
+
}
|
|
2424
|
+
|
|
2425
|
+
declare interface NPMPackageEntry {
|
|
2426
|
+
/**
|
|
2427
|
+
* optional path to file in package
|
|
2428
|
+
* @maxLength 200
|
|
2429
|
+
*/
|
|
2430
|
+
path?: string | null;
|
|
2431
|
+
/**
|
|
2432
|
+
* The named export key to import. If empty, the default export is used.
|
|
2433
|
+
* @maxLength 200
|
|
2434
|
+
*/
|
|
2435
|
+
exportKey?: string | null;
|
|
2436
|
+
}
|
|
2437
|
+
|
|
2438
|
+
export declare enum OverrideType {
|
|
2439
|
+
UNKNOWN = "UNKNOWN",
|
|
2440
|
+
DEV = "DEV",
|
|
2441
|
+
DEV_PREVIEW = "DEV_PREVIEW",
|
|
2442
|
+
USER = "USER",
|
|
2443
|
+
INTERNAL_BUILD = "INTERNAL_BUILD",
|
|
2444
|
+
INTERNAL_RC = "INTERNAL_RC"
|
|
2445
|
+
}
|
|
2446
|
+
|
|
2447
|
+
declare interface Panel extends PanelSelectedContentTypeOneOf {
|
|
2448
|
+
/**
|
|
2449
|
+
* The URL to the html page of the panel in case of iFrame
|
|
2450
|
+
* @format WEB_URL
|
|
2451
|
+
*/
|
|
2452
|
+
url?: string;
|
|
2453
|
+
/* Excluded from this release type: code */
|
|
2454
|
+
/* Excluded from this release type: referenceId */
|
|
2455
|
+
/**
|
|
2456
|
+
* The title of the panel
|
|
2457
|
+
* @minLength 1
|
|
2458
|
+
* @maxLength 200
|
|
2459
|
+
*/
|
|
2460
|
+
displayName?: string;
|
|
2461
|
+
/** Optional: The size of the panel (not affecting overlay panel mode) */
|
|
2462
|
+
size?: PanelSize;
|
|
2463
|
+
/** The selected panel content type */
|
|
2464
|
+
contentType?: PanelContentType;
|
|
2465
|
+
/** The selected panel mode - draggable is default */
|
|
2466
|
+
panelMode?: PanelMode;
|
|
2467
|
+
}
|
|
2468
|
+
|
|
2469
|
+
/** Represents a URL-based action that opens a panel */
|
|
2470
|
+
export declare interface PanelAction extends PanelActionSelectedPanelTypeOneOf {
|
|
2471
|
+
/**
|
|
2472
|
+
* For using a panel defined in dev-center
|
|
2473
|
+
* @format GUID
|
|
2474
|
+
*/
|
|
2475
|
+
panelId?: string;
|
|
2476
|
+
/* Excluded from this release type: inline */
|
|
2477
|
+
/** The selected panel reference type */
|
|
2478
|
+
panelType?: PanelType;
|
|
2479
|
+
}
|
|
2480
|
+
|
|
2481
|
+
/** @oneof */
|
|
2482
|
+
declare interface PanelActionSelectedPanelTypeOneOf {
|
|
2483
|
+
/**
|
|
2484
|
+
* For using a panel defined in dev-center
|
|
2485
|
+
* @format GUID
|
|
2486
|
+
*/
|
|
2487
|
+
panelId?: string;
|
|
2488
|
+
/* Excluded from this release type: inline */
|
|
2489
|
+
}
|
|
2490
|
+
|
|
2491
|
+
/** Represents the options for panel content types */
|
|
2492
|
+
declare enum PanelContentType {
|
|
2493
|
+
UNKNOWN_PanelContentType = "UNKNOWN_PanelContentType",
|
|
2494
|
+
url = "url",
|
|
2495
|
+
code = "code"
|
|
2496
|
+
}
|
|
2497
|
+
|
|
2498
|
+
/** Represents the options for panel display modes */
|
|
2499
|
+
declare enum PanelMode {
|
|
2500
|
+
/** default - A non-blocking panel that allows interaction with the underlying interface */
|
|
2501
|
+
UNKNOWN_PanelMode = "UNKNOWN_PanelMode",
|
|
2502
|
+
/** A blocking panel that overlays, typically used for modal-like experiences */
|
|
2503
|
+
overlay = "overlay"
|
|
2504
|
+
}
|
|
2505
|
+
|
|
2506
|
+
/** @oneof */
|
|
2507
|
+
declare interface PanelSelectedContentTypeOneOf {
|
|
2508
|
+
/**
|
|
2509
|
+
* The URL to the html page of the panel in case of iFrame
|
|
2510
|
+
* @format WEB_URL
|
|
2511
|
+
*/
|
|
2512
|
+
url?: string;
|
|
2513
|
+
/* Excluded from this release type: code */
|
|
2514
|
+
}
|
|
2515
|
+
|
|
2516
|
+
declare interface PanelSize {
|
|
2517
|
+
/**
|
|
2518
|
+
* height of the panel in px
|
|
2519
|
+
* @min 150
|
|
2520
|
+
*/
|
|
2521
|
+
height?: number | null;
|
|
2522
|
+
/** width of the panel */
|
|
2523
|
+
width?: PanelSizeWidth;
|
|
2524
|
+
}
|
|
2525
|
+
|
|
2526
|
+
declare enum PanelSizeWidth {
|
|
2527
|
+
UNKNOWN_WIDTH = "UNKNOWN_WIDTH",
|
|
2528
|
+
SMALL = "SMALL",
|
|
2529
|
+
MEDIUM = "MEDIUM",
|
|
2530
|
+
LARGE = "LARGE"
|
|
2531
|
+
}
|
|
2532
|
+
|
|
2533
|
+
/** list of possible panel types */
|
|
2534
|
+
declare enum PanelType {
|
|
2535
|
+
UNKNOWN_PanelType = "UNKNOWN_PanelType",
|
|
2536
|
+
panelId = "panelId",
|
|
2537
|
+
inline = "inline"
|
|
2538
|
+
}
|
|
2539
|
+
|
|
2540
|
+
declare interface PlaceHolder {
|
|
2541
|
+
/**
|
|
2542
|
+
* The placeholder definition that this container should accept as defined in DEV Center
|
|
2543
|
+
* @format GUID
|
|
2544
|
+
*/
|
|
2545
|
+
placeholderId?: string;
|
|
2546
|
+
}
|
|
2547
|
+
|
|
2548
|
+
declare interface PresetElementDefaults {
|
|
2549
|
+
/**
|
|
2550
|
+
* The element display name when the preset is selected
|
|
2551
|
+
* @maxLength 100
|
|
2552
|
+
*/
|
|
2553
|
+
displayName?: string | null;
|
|
2554
|
+
/** The default values for the element css-properties when the preset is selected */
|
|
2555
|
+
cssProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2556
|
+
/** The default values for the element css-custom-properties when the preset is selected */
|
|
2557
|
+
cssCustomProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2558
|
+
/** The default styles for the inner elements when the preset is selected */
|
|
2559
|
+
elements?: Record<string, PresetInnerElementDefaults>;
|
|
2560
|
+
/** Optional editor layout behaviors we want to apply when this preset is selected */
|
|
2561
|
+
layout?: EditorElementLayout;
|
|
2562
|
+
/**
|
|
2563
|
+
* Display filters for the Preset, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
2564
|
+
* The Preset is the second in line to affect the display, Element is before and State is after it
|
|
2565
|
+
*/
|
|
2566
|
+
displayFilters?: DisplayFilters_2;
|
|
2567
|
+
}
|
|
2568
|
+
|
|
2569
|
+
declare interface PresetInnerElementDefaults {
|
|
2570
|
+
/** The default values for the element css-properties */
|
|
2571
|
+
cssProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2572
|
+
/** The default values for the element css-custom-properties */
|
|
2573
|
+
cssCustomProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2574
|
+
/** The default preset and styles for inner elements */
|
|
2575
|
+
elements?: Record<string, PresetInnerElementDefaults>;
|
|
2576
|
+
}
|
|
2577
|
+
|
|
2578
|
+
export declare interface PresetItem {
|
|
2579
|
+
/**
|
|
2580
|
+
* DEPRECATED - use preset_css_url instead
|
|
2581
|
+
* @format WEB_URL
|
|
2582
|
+
* @minLength 13
|
|
2583
|
+
* @maxLength 500
|
|
2584
|
+
* @deprecated DEPRECATED - use preset_css_url instead
|
|
2585
|
+
* @replacedBy preset_css_url
|
|
2586
|
+
* @targetRemovalDate 2025-08-01
|
|
2587
|
+
*/
|
|
2588
|
+
cssUrl?: string;
|
|
2589
|
+
/**
|
|
2590
|
+
* Preset name for displaying purposes in the editor
|
|
2591
|
+
* @maxLength 100
|
|
2592
|
+
*/
|
|
2593
|
+
displayName?: string;
|
|
2594
|
+
/**
|
|
2595
|
+
* A URL to the preset thumbnail file
|
|
2596
|
+
* @format WEB_URL
|
|
2597
|
+
* @maxLength 500
|
|
2598
|
+
*/
|
|
2599
|
+
thumbnailUrl?: string | null;
|
|
2600
|
+
/** Optional initial size of the component when switching into this preset (will not be applied when element is used as an inner element) */
|
|
2601
|
+
initialSize?: ComponentInitialSize;
|
|
2602
|
+
/**
|
|
2603
|
+
* Display filters for the Preset, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
2604
|
+
* The Preset is the second in line to affect the display, Element is before and State is after it
|
|
2605
|
+
* @deprecated Display filters for the Preset, used to define the visibility of inner / ref elements, style items, data items and custom actions in the editor
|
|
2606
|
+
* The Preset is the second in line to affect the display, Element is before and State is after it
|
|
2607
|
+
* @replacedBy preset_defaults
|
|
2608
|
+
* @targetRemovalDate 2025-08-01
|
|
2609
|
+
*/
|
|
2610
|
+
displayFilters?: DisplayFilters_2;
|
|
2611
|
+
/**
|
|
2612
|
+
* The default styles for this preset and the inner elements
|
|
2613
|
+
* @deprecated The default styles for this preset and the inner elements
|
|
2614
|
+
* @replacedBy preset_defaults
|
|
2615
|
+
* @targetRemovalDate 2025-08-01
|
|
2616
|
+
*/
|
|
2617
|
+
styleDefaults?: PresetStyleDefaults;
|
|
2618
|
+
/** The style overrides for this preset and the inner elements */
|
|
2619
|
+
styleOverrides?: BreakpointPresetStyleOverrides;
|
|
2620
|
+
/**
|
|
2621
|
+
* Show this preset in panel only on specified breakpoints
|
|
2622
|
+
* (undefined/empty list = all breakpoints, list with values = only those breakpoints)
|
|
2623
|
+
* TODO: MaxSize is 2, because we only support small and large breakpoints for now
|
|
2624
|
+
* @maxSize 2
|
|
2625
|
+
*/
|
|
2626
|
+
optimizedFor?: BreakpointEnumBreakpoint[];
|
|
2627
|
+
/**
|
|
2628
|
+
* Optional editor layout behaviors we want to apply when this preset is selected
|
|
2629
|
+
* @deprecated Optional editor layout behaviors we want to apply when this preset is selected
|
|
2630
|
+
* @replacedBy preset_defaults
|
|
2631
|
+
* @targetRemovalDate 2025-08-01
|
|
2632
|
+
*/
|
|
2633
|
+
layout?: EditorElementLayout;
|
|
2634
|
+
/**
|
|
2635
|
+
* A URL to the CSS file of this preset, to be used when you need to apply many css-changes or default-values to the DOM when this preset is selected, optional
|
|
2636
|
+
* @format WEB_URL
|
|
2637
|
+
* @maxLength 500
|
|
2638
|
+
*/
|
|
2639
|
+
presetCssUrl?: string | null;
|
|
2640
|
+
/** All the default values that needs to be set when the preset is selected */
|
|
2641
|
+
presetDefaults?: PresetElementDefaults;
|
|
2642
|
+
}
|
|
2643
|
+
|
|
2644
|
+
export declare type Presets = NonNullable<EditorElement['presets']>;
|
|
2645
|
+
|
|
2646
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
2647
|
+
declare interface PresetStyleDefaults {
|
|
2648
|
+
/** The default styles for this preset */
|
|
2649
|
+
style?: Record<string, StyleItemDefaults>;
|
|
2650
|
+
/** The default styles of inner elements for this preset */
|
|
2651
|
+
elements?: Record<string, ElementStyleDefaults>;
|
|
2652
|
+
}
|
|
2653
|
+
|
|
2654
|
+
declare interface PresetStyleItemOverrides {
|
|
2655
|
+
/** The override value of this style item */
|
|
2656
|
+
value?: any;
|
|
2657
|
+
/** The override values for the style item when the component is in one of the defined states */
|
|
2658
|
+
statesValues?: Record<string, any>;
|
|
2659
|
+
}
|
|
2660
|
+
|
|
2661
|
+
declare interface PresetStyleOverrides {
|
|
2662
|
+
/**
|
|
2663
|
+
* The style overrides for this preset
|
|
2664
|
+
* @deprecated The style overrides for this preset
|
|
2665
|
+
* @replacedBy cssProperties or cssCustomProperties
|
|
2666
|
+
* @targetRemovalDate 2025-08-01
|
|
2667
|
+
*/
|
|
2668
|
+
style?: Record<string, PresetStyleItemOverrides>;
|
|
2669
|
+
/** The style overrides of inner elements for this preset */
|
|
2670
|
+
elements?: Record<string, ElementStyleOverrides>;
|
|
2671
|
+
/** The default values for the element css-properties when the preset is selected */
|
|
2672
|
+
cssProperties?: Record<string, PresetStyleItemOverrides>;
|
|
2673
|
+
/** The default values for the element css-custom-properties when the preset is selected */
|
|
2674
|
+
cssCustomProperties?: Record<string, PresetStyleItemOverrides>;
|
|
2675
|
+
}
|
|
2676
|
+
|
|
2677
|
+
/**
|
|
2678
|
+
* A container is a place to add components to in the editor
|
|
2679
|
+
* There are a few different types of containers supported
|
|
2680
|
+
*/
|
|
2681
|
+
declare interface ReactElementContainer extends ReactElementContainerSelectedContainerTypeOneOf {
|
|
2682
|
+
/** A container element that will be passed in as children, it is composed in the editor */
|
|
2683
|
+
simple?: SimpleContainer;
|
|
2684
|
+
/** A Slot for targeting slot implementors, gets the API implementation by the host (definition in DEV Center for both) */
|
|
2685
|
+
slot?: ContainerTypesSlot;
|
|
2686
|
+
/** Placeholder for components targeting a specific area (definition in DEV Center) */
|
|
2687
|
+
placeholder?: PlaceHolder;
|
|
2688
|
+
/** A template container that can be used to render a template multiple times */
|
|
2689
|
+
template?: TemplateContainer;
|
|
2690
|
+
/**
|
|
2691
|
+
* A DOM Selector that will allow us to target it in the editor
|
|
2692
|
+
* @minLength 2
|
|
2693
|
+
* @maxLength 100
|
|
2694
|
+
*/
|
|
2695
|
+
selector?: string;
|
|
2696
|
+
/** The type of Container to be rendered */
|
|
2697
|
+
containerType?: CONTAINER_TYPE;
|
|
2698
|
+
}
|
|
2699
|
+
|
|
2700
|
+
/** @oneof */
|
|
2701
|
+
declare interface ReactElementContainerSelectedContainerTypeOneOf {
|
|
2702
|
+
/** A container element that will be passed in as children, it is composed in the editor */
|
|
2703
|
+
simple?: SimpleContainer;
|
|
2704
|
+
/** A Slot for targeting slot implementors, gets the API implementation by the host (definition in DEV Center for both) */
|
|
2705
|
+
slot?: ContainerTypesSlot;
|
|
2706
|
+
/** Placeholder for components targeting a specific area (definition in DEV Center) */
|
|
2707
|
+
placeholder?: PlaceHolder;
|
|
2708
|
+
/** A template container that can be used to render a template multiple times */
|
|
2709
|
+
template?: TemplateContainer;
|
|
2710
|
+
}
|
|
2711
|
+
|
|
2712
|
+
export declare interface RefElement {
|
|
2713
|
+
/**
|
|
2714
|
+
* The type of the referenced element. Must exist in the Wix Dev Center and be fully typed (`appSlug.componentType`).
|
|
2715
|
+
* @minLength 4
|
|
2716
|
+
* @maxLength 100
|
|
2717
|
+
*/
|
|
2718
|
+
type?: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* The override of the used element selector, full path from root
|
|
2721
|
+
* @minLength 4
|
|
2722
|
+
* @maxLength 300
|
|
2723
|
+
*/
|
|
2724
|
+
selector?: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* The override of the used element displayName
|
|
2727
|
+
* @maxLength 50
|
|
2728
|
+
*/
|
|
2729
|
+
displayName?: string;
|
|
2730
|
+
/** The override of the used element style */
|
|
2731
|
+
style?: Record<string, StyleItemOverrides>;
|
|
2732
|
+
/** The override of the used element data */
|
|
2733
|
+
data?: Record<string, DataItemOverrides>;
|
|
2734
|
+
/** The override of the used element behaviors */
|
|
2735
|
+
behaviors?: Behaviors;
|
|
2736
|
+
/** The override of the used element native actions */
|
|
2737
|
+
actions?: Actions;
|
|
2738
|
+
/** The override of the used element custom actions */
|
|
2739
|
+
customActions?: Record<string, ApiAction>;
|
|
2740
|
+
/* Excluded from this release type: resolvedElement */
|
|
2741
|
+
/** A reference to a state that needs to be triggered in order for this element to be visible */
|
|
2742
|
+
visibleState?: VisibleState;
|
|
2743
|
+
/**
|
|
2744
|
+
* This is where you can override the display filter defined by the original element
|
|
2745
|
+
* The override is per field. So you can override: style items, data items, custom actions and elements or just some of them.
|
|
2746
|
+
* Any item not overridden will be inherited from the original element
|
|
2747
|
+
*/
|
|
2748
|
+
displayFilters?: DisplayFilters_2;
|
|
2749
|
+
/** The default style & data for inner elements */
|
|
2750
|
+
elements?: Record<string, RefInnerElementDefaults>;
|
|
2751
|
+
/** A map of definition overrides for the css-properties that this element supports */
|
|
2752
|
+
cssProperties?: Record<string, CssPropertyItemDefinitionOverrides>;
|
|
2753
|
+
/** A map of definition overrides for the css-custom-properties that this element supports */
|
|
2754
|
+
cssCustomProperties?: Record<string, CssPropertyItemDefinitionOverrides>;
|
|
2755
|
+
/** A reference to a help article for this element */
|
|
2756
|
+
helpArticle?: HelpArticle;
|
|
2757
|
+
}
|
|
2758
|
+
|
|
2759
|
+
declare interface RefInnerElementDefaults {
|
|
2760
|
+
/** The default data for an element */
|
|
2761
|
+
data?: Record<string, any>;
|
|
2762
|
+
/** The default preset and styles for inner elements */
|
|
2763
|
+
elements?: Record<string, RefInnerElementDefaults>;
|
|
2764
|
+
/** A map of default values for the css-properties that this element supports */
|
|
2765
|
+
cssProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2766
|
+
/** A map of default values for the css-properties that this element supports */
|
|
2767
|
+
cssCustomProperties?: Record<string, CssPropertyItemDefaults>;
|
|
2768
|
+
}
|
|
2769
|
+
|
|
2770
|
+
declare enum ResizeDirection {
|
|
2771
|
+
/** Default value when direction is not specified */
|
|
2772
|
+
UNKNOWN_ResizeDirection = "UNKNOWN_ResizeDirection",
|
|
2773
|
+
/** Component can only be resized horizontally */
|
|
2774
|
+
horizontal = "horizontal",
|
|
2775
|
+
/** Component can only be resized vertically */
|
|
2776
|
+
vertical = "vertical",
|
|
2777
|
+
/** Component can be resized both horizontally and vertically */
|
|
2778
|
+
horizontalAndVertical = "horizontalAndVertical",
|
|
2779
|
+
/** Component maintains its aspect ratio while resizing */
|
|
2780
|
+
aspectRatio = "aspectRatio",
|
|
2781
|
+
/** Component cannot be resized in any direction */
|
|
2782
|
+
none = "none"
|
|
2783
|
+
}
|
|
2784
|
+
|
|
2785
|
+
declare interface Resource {
|
|
2786
|
+
/**
|
|
2787
|
+
* A URL to an ESM javascript bundle
|
|
2788
|
+
* @format WEB_URL
|
|
2789
|
+
*/
|
|
2790
|
+
url?: string;
|
|
2791
|
+
}
|
|
2792
|
+
|
|
2793
|
+
declare interface Resources {
|
|
2794
|
+
/** The bundle we will load and render in the browser in the site */
|
|
2795
|
+
client?: ClientResources;
|
|
2796
|
+
/**
|
|
2797
|
+
* An optional client definition of the component we will load and render in the editor, *it replaces the client bundle.*
|
|
2798
|
+
* The main use case is to control the live site component and enable different experiences in the editor.
|
|
2799
|
+
* For example, supporting `states` manipulation:
|
|
2800
|
+
* Show calendar in the editor
|
|
2801
|
+
* Open drop down in the editor
|
|
2802
|
+
*/
|
|
2803
|
+
editor?: ClientResources;
|
|
2804
|
+
/** The bundle for SSR, should not include any DOM API references */
|
|
2805
|
+
server?: Resource;
|
|
2806
|
+
/** The optional component SDK to expose to Velo Users to interact with the component */
|
|
2807
|
+
sdk?: Resource;
|
|
2808
|
+
/** Details for how to load translations for the component */
|
|
2809
|
+
translations?: TranslationResources;
|
|
2810
|
+
/** The optional interactions configuration JSON file */
|
|
2811
|
+
interactions?: Resource;
|
|
2812
|
+
/* Excluded from this release type: viewerReducedModel */
|
|
2813
|
+
/* Excluded from this release type: schemaRefsUrl */
|
|
2814
|
+
/* Excluded from this release type: viewerRuntimeCss */
|
|
2815
|
+
}
|
|
2816
|
+
|
|
2817
|
+
/** rich text data type allow manipulation of text with html & inline styles */
|
|
2818
|
+
declare interface RichText {
|
|
2819
|
+
/**
|
|
2820
|
+
* A collection of possible rich text abilities that the component supports. Only one of the types will make it to the component after input.
|
|
2821
|
+
* @maxSize 22
|
|
2822
|
+
*/
|
|
2823
|
+
abilities?: RichTextAbilities[];
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2826
|
+
declare enum RichTextAbilities {
|
|
2827
|
+
UNKNOWN_RichTextAbilities = "UNKNOWN_RichTextAbilities",
|
|
2828
|
+
/** selected theme font, also changing the html tag */
|
|
2829
|
+
font = "font",
|
|
2830
|
+
/** font family of the text */
|
|
2831
|
+
fontFamily = "fontFamily",
|
|
2832
|
+
/** font size of the text */
|
|
2833
|
+
fontSize = "fontSize",
|
|
2834
|
+
/** italic / normal */
|
|
2835
|
+
fontStyle = "fontStyle",
|
|
2836
|
+
/** bold / normal / 100-900 */
|
|
2837
|
+
fontWeight = "fontWeight",
|
|
2838
|
+
/** underline / line-through */
|
|
2839
|
+
textDecoration = "textDecoration",
|
|
2840
|
+
/** color of the text */
|
|
2841
|
+
color = "color",
|
|
2842
|
+
/** background color of the text */
|
|
2843
|
+
backgroundColor = "backgroundColor",
|
|
2844
|
+
/** letter spacing of the text */
|
|
2845
|
+
letterSpacing = "letterSpacing",
|
|
2846
|
+
/** left / center / right / justify */
|
|
2847
|
+
textAlign = "textAlign",
|
|
2848
|
+
/** rtl/ltr */
|
|
2849
|
+
direction = "direction",
|
|
2850
|
+
/** indent of the text */
|
|
2851
|
+
marginStart = "marginStart",
|
|
2852
|
+
/** outdent of the text */
|
|
2853
|
+
marginEnd = "marginEnd",
|
|
2854
|
+
/** special data: */
|
|
2855
|
+
bulletedList = "bulletedList",
|
|
2856
|
+
/** implemented with <ol> */
|
|
2857
|
+
numberedList = "numberedList",
|
|
2858
|
+
/** h1,h2,h3,h4,h5,h6,p,blockquote */
|
|
2859
|
+
seoTag = "seoTag"
|
|
2860
|
+
}
|
|
2861
|
+
|
|
2862
|
+
export declare interface ShorthandGroupBackground {
|
|
2863
|
+
/**
|
|
2864
|
+
* Stores the background-color property of the background shorthand
|
|
2865
|
+
* @maxLength 100
|
|
2866
|
+
*/
|
|
2867
|
+
backgroundColor?: string | null;
|
|
2868
|
+
/**
|
|
2869
|
+
* Stores the background-image property of the background shorthand
|
|
2870
|
+
* @maxLength 100
|
|
2871
|
+
*/
|
|
2872
|
+
backgroundImage?: string | null;
|
|
2873
|
+
/**
|
|
2874
|
+
* Stores the background-position property of the background shorthand
|
|
2875
|
+
* @maxLength 100
|
|
2876
|
+
*/
|
|
2877
|
+
backgroundPosition?: string | null;
|
|
2878
|
+
/**
|
|
2879
|
+
* Stores the background-size property of the background shorthand
|
|
2880
|
+
* @maxLength 100
|
|
2881
|
+
*/
|
|
2882
|
+
backgroundSize?: string | null;
|
|
2883
|
+
/**
|
|
2884
|
+
* Stores the background-repeat property of the background shorthand
|
|
2885
|
+
* @maxLength 100
|
|
2886
|
+
*/
|
|
2887
|
+
backgroundRepeat?: string | null;
|
|
2888
|
+
/**
|
|
2889
|
+
* Stores the background-origin property of the background shorthand
|
|
2890
|
+
* @maxLength 100
|
|
2891
|
+
*/
|
|
2892
|
+
backgroundOrigin?: string | null;
|
|
2893
|
+
/**
|
|
2894
|
+
* Stores the background-clip property of the background shorthand
|
|
2895
|
+
* @maxLength 100
|
|
2896
|
+
*/
|
|
2897
|
+
backgroundClip?: string | null;
|
|
2898
|
+
/**
|
|
2899
|
+
* Stores the background shorthand item itself, should be used when you want to achieve with this group partial editing of the background shorthand
|
|
2900
|
+
* @maxLength 100
|
|
2901
|
+
*/
|
|
2902
|
+
background?: string | null;
|
|
2903
|
+
}
|
|
2904
|
+
|
|
2905
|
+
export declare interface ShorthandGroupBorder {
|
|
2906
|
+
/**
|
|
2907
|
+
* Stores the width property of a border shorthand
|
|
2908
|
+
* @maxLength 100
|
|
2909
|
+
*/
|
|
2910
|
+
width?: string | null;
|
|
2911
|
+
/**
|
|
2912
|
+
* Stores the style property of a border shorthand
|
|
2913
|
+
* @maxLength 100
|
|
2914
|
+
*/
|
|
2915
|
+
style?: string | null;
|
|
2916
|
+
/**
|
|
2917
|
+
* Stores the color property of a border shorthand
|
|
2918
|
+
* @maxLength 100
|
|
2919
|
+
*/
|
|
2920
|
+
color?: string | null;
|
|
2921
|
+
/**
|
|
2922
|
+
* Stores the border shorthand item itself, should be used when you want to achieve with this group partial editing of the border shorthand
|
|
2923
|
+
* @maxLength 100
|
|
2924
|
+
*/
|
|
2925
|
+
border?: string | null;
|
|
2926
|
+
}
|
|
2927
|
+
|
|
2928
|
+
declare interface SimpleContainer {
|
|
2929
|
+
/** Layout configuration for the container, can be used to configure the editing of the container and the layout. */
|
|
2930
|
+
layout?: ContainerLayout;
|
|
2931
|
+
/** Style configuration for the container, can be used to disable style properties, or change their display name. */
|
|
2932
|
+
style?: ContainerStyleOverrides;
|
|
2933
|
+
/** Behavior configuration for the container, can be used to disable selection of the container. */
|
|
2934
|
+
behaviors?: ContainerBehaviors;
|
|
2935
|
+
/**
|
|
2936
|
+
* An optional override of the display name of the container.
|
|
2937
|
+
* @maxLength 50
|
|
2938
|
+
*/
|
|
2939
|
+
displayName?: string | null;
|
|
2940
|
+
}
|
|
2941
|
+
|
|
2942
|
+
declare enum SizingType {
|
|
2943
|
+
UNKNOWN_SizingType = "UNKNOWN_SizingType",
|
|
2944
|
+
/** Initial size should fit to the [content size](https://developer.mozilla.org/en-US/docs/Web/CSS/fit-content) */
|
|
2945
|
+
content = "content",
|
|
2946
|
+
/** Initial size should stretch to the parent size and will keep tracking it unless a user changes it */
|
|
2947
|
+
stretched = "stretched",
|
|
2948
|
+
/** Initial size should be set in pixels */
|
|
2949
|
+
pixels = "pixels"
|
|
2950
|
+
}
|
|
2951
|
+
|
|
2952
|
+
export declare type States = NonNullable<EditorElement['states']>;
|
|
2953
|
+
|
|
2954
|
+
declare enum StaticContainer {
|
|
2955
|
+
UNKNOWN_CONTAINER = "UNKNOWN_CONTAINER",
|
|
2956
|
+
/** Widget should be installed in the homepage */
|
|
2957
|
+
HOMEPAGE = "HOMEPAGE",
|
|
2958
|
+
/** Show widget on all pages */
|
|
2959
|
+
GLOBAL_PAGE = "GLOBAL_PAGE"
|
|
2960
|
+
}
|
|
2961
|
+
|
|
2962
|
+
/** DEPRECATED - use CssPropertyAction or CssCustomPropertyAction */
|
|
2963
|
+
declare interface StyleAction {
|
|
2964
|
+
/**
|
|
2965
|
+
* Points to the style item within the component’s style structure
|
|
2966
|
+
* @minLength 1
|
|
2967
|
+
* @maxLength 50
|
|
2968
|
+
*/
|
|
2969
|
+
styleItemKey?: string;
|
|
2970
|
+
}
|
|
2971
|
+
|
|
2972
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future, add new types and definitions in css_properties.proto */
|
|
2973
|
+
export declare interface StyleItem extends StyleItemSelectedItemTypeOneOf, StyleItemSelectedCssPropertyTypeOneOf, StyleItemSelectedCssVariableTypeOneOf {
|
|
2974
|
+
/**
|
|
2975
|
+
* DEPRECATED: use cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
2976
|
+
* @deprecated DEPRECATED: use cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
2977
|
+
* @replacedBy cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
2978
|
+
* @targetRemovalDate 2025-08-01
|
|
2979
|
+
*/
|
|
2980
|
+
cssPropertyType?: CssPropertyType;
|
|
2981
|
+
/**
|
|
2982
|
+
* DEPRECATED: use cssCustomProperties instead
|
|
2983
|
+
* @deprecated DEPRECATED: use cssCustomProperties instead
|
|
2984
|
+
* @replacedBy cssCustomProperties
|
|
2985
|
+
* @targetRemovalDate 2025-08-01
|
|
2986
|
+
*/
|
|
2987
|
+
cssVariableType?: CssDataType;
|
|
2988
|
+
/** Additional options to refine the filter variable */
|
|
2989
|
+
filter?: Filter;
|
|
2990
|
+
/** Additional options to refine the backdropFilter variable */
|
|
2991
|
+
backdropFilter?: BackdropFilter;
|
|
2992
|
+
/** Additional options to refine the display variable */
|
|
2993
|
+
display?: Display;
|
|
2994
|
+
/** Additional options to refine the writingMode variable */
|
|
2995
|
+
writingMode?: WritingMode;
|
|
2996
|
+
/** Additional options to refine the background variable */
|
|
2997
|
+
background?: Background;
|
|
2998
|
+
/** Additional options to refine the customEnum style item */
|
|
2999
|
+
customEnum?: CustomEnum;
|
|
3000
|
+
/** Additional options to refine the number style item */
|
|
3001
|
+
number?: CssNumber;
|
|
3002
|
+
/**
|
|
3003
|
+
* The type of the style-item, used to define the type of the css property or css variable
|
|
3004
|
+
* @deprecated The type of the style-item, used to define the type of the css property or css variable
|
|
3005
|
+
* @replacedBy cssPropertyType or cssVariableType
|
|
3006
|
+
* @targetRemovalDate 2025-08-01
|
|
3007
|
+
*/
|
|
3008
|
+
styleType?: StyleType;
|
|
3009
|
+
/** The default value for the style-item when the component is in the "regular" state */
|
|
3010
|
+
defaultValue?: any;
|
|
3011
|
+
/** The default values for the style-item when the component is in one of the defined states */
|
|
3012
|
+
statesDefaultValues?: Record<string, any>;
|
|
3013
|
+
/**
|
|
3014
|
+
* Will be used as displayName of this style-item
|
|
3015
|
+
* @maxLength 100
|
|
3016
|
+
*/
|
|
3017
|
+
displayName?: string | null;
|
|
3018
|
+
/**
|
|
3019
|
+
* DEPRECATED - use cssCustomProperties instead
|
|
3020
|
+
* @deprecated DEPRECATED - use cssCustomProperties instead
|
|
3021
|
+
* @replacedBy cssCustomProperties
|
|
3022
|
+
* @targetRemovalDate 2025-08-01
|
|
3023
|
+
*/
|
|
3024
|
+
cssCustomProperty?: boolean | null;
|
|
3025
|
+
/* Excluded from this release type: deprecated */
|
|
3026
|
+
}
|
|
3027
|
+
|
|
3028
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
3029
|
+
declare interface StyleItemDefaults {
|
|
3030
|
+
/** The default value of this style item */
|
|
3031
|
+
defaultValue?: any;
|
|
3032
|
+
/** The default values for the style-item when the component is in one of the defined states */
|
|
3033
|
+
statesDefaultValues?: Record<string, any>;
|
|
3034
|
+
}
|
|
3035
|
+
|
|
3036
|
+
/** DEPRECATED: This message is deprecated and will be removed in the future */
|
|
3037
|
+
declare interface StyleItemOverrides {
|
|
3038
|
+
/** Disables the ability to edit this style-item */
|
|
3039
|
+
disableEditing?: boolean | null;
|
|
3040
|
+
/** Overrides the default value of this style-item */
|
|
3041
|
+
defaultValue?: any;
|
|
3042
|
+
/** Overrides the default values for the style-item when the component is in one of the defined states */
|
|
3043
|
+
statesDefaultValues?: Record<string, any>;
|
|
3044
|
+
/**
|
|
3045
|
+
* Overrides Display displayName of this style-item
|
|
3046
|
+
* @maxLength 100
|
|
3047
|
+
*/
|
|
3048
|
+
displayName?: string | null;
|
|
3049
|
+
}
|
|
3050
|
+
|
|
3051
|
+
/** @oneof */
|
|
3052
|
+
declare interface StyleItemSelectedCssPropertyTypeOneOf {
|
|
3053
|
+
/** Additional options to refine the filter variable */
|
|
3054
|
+
filter?: Filter;
|
|
3055
|
+
/** Additional options to refine the backdropFilter variable */
|
|
3056
|
+
backdropFilter?: BackdropFilter;
|
|
3057
|
+
/** Additional options to refine the display variable */
|
|
3058
|
+
display?: Display;
|
|
3059
|
+
/** Additional options to refine the writingMode variable */
|
|
3060
|
+
writingMode?: WritingMode;
|
|
3061
|
+
/** Additional options to refine the background variable */
|
|
3062
|
+
background?: Background;
|
|
3063
|
+
}
|
|
3064
|
+
|
|
3065
|
+
/** @oneof */
|
|
3066
|
+
declare interface StyleItemSelectedCssVariableTypeOneOf {
|
|
3067
|
+
/** Additional options to refine the customEnum style item */
|
|
3068
|
+
customEnum?: CustomEnum;
|
|
3069
|
+
/** Additional options to refine the number style item */
|
|
3070
|
+
number?: CssNumber;
|
|
3071
|
+
}
|
|
3072
|
+
|
|
3073
|
+
/** @oneof */
|
|
3074
|
+
declare interface StyleItemSelectedItemTypeOneOf {
|
|
3075
|
+
/**
|
|
3076
|
+
* DEPRECATED: use cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
3077
|
+
* @deprecated DEPRECATED: use cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
3078
|
+
* @replacedBy cssProperties or cssCustomProperties depends if you need this as inline css-property or as a css variable
|
|
3079
|
+
* @targetRemovalDate 2025-08-01
|
|
3080
|
+
*/
|
|
3081
|
+
cssPropertyType?: CssPropertyType;
|
|
3082
|
+
/**
|
|
3083
|
+
* DEPRECATED: use cssCustomProperties instead
|
|
3084
|
+
* @deprecated DEPRECATED: use cssCustomProperties instead
|
|
3085
|
+
* @replacedBy cssCustomProperties
|
|
3086
|
+
* @targetRemovalDate 2025-08-01
|
|
3087
|
+
*/
|
|
3088
|
+
cssVariableType?: CssDataType;
|
|
3089
|
+
}
|
|
3090
|
+
|
|
3091
|
+
/** The supported [CSS Property Types & CSS Data Types](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference#index) in Javascript naming format */
|
|
3092
|
+
declare enum StyleType {
|
|
3093
|
+
UNKNOWN_StyleType = "UNKNOWN_StyleType",
|
|
3094
|
+
/** css-data-types */
|
|
3095
|
+
number = "number",
|
|
3096
|
+
string = "string",
|
|
3097
|
+
angle = "angle",
|
|
3098
|
+
length = "length",
|
|
3099
|
+
percentage = "percentage",
|
|
3100
|
+
lengthPercentage = "lengthPercentage",
|
|
3101
|
+
blendMode = "blendMode",
|
|
3102
|
+
customEnum = "customEnum",
|
|
3103
|
+
time = "time",
|
|
3104
|
+
/** background properties */
|
|
3105
|
+
background = "background",
|
|
3106
|
+
backgroundSize = "backgroundSize",
|
|
3107
|
+
backgroundColor = "backgroundColor",
|
|
3108
|
+
backgroundImage = "backgroundImage",
|
|
3109
|
+
backgroundClip = "backgroundClip",
|
|
3110
|
+
backgroundOrigin = "backgroundOrigin",
|
|
3111
|
+
backgroundPosition = "backgroundPosition",
|
|
3112
|
+
backgroundRepeat = "backgroundRepeat",
|
|
3113
|
+
backgroundAttachment = "backgroundAttachment",
|
|
3114
|
+
/** margin properties */
|
|
3115
|
+
margin = "margin",
|
|
3116
|
+
marginTop = "marginTop",
|
|
3117
|
+
marginRight = "marginRight",
|
|
3118
|
+
marginBottom = "marginBottom",
|
|
3119
|
+
marginLeft = "marginLeft",
|
|
3120
|
+
marginInlineStart = "marginInlineStart",
|
|
3121
|
+
marginInlineEnd = "marginInlineEnd",
|
|
3122
|
+
/** padding properties */
|
|
3123
|
+
padding = "padding",
|
|
3124
|
+
paddingTop = "paddingTop",
|
|
3125
|
+
paddingRight = "paddingRight",
|
|
3126
|
+
paddingBottom = "paddingBottom",
|
|
3127
|
+
paddingLeft = "paddingLeft",
|
|
3128
|
+
paddingInlineStart = "paddingInlineStart",
|
|
3129
|
+
paddingInlineEnd = "paddingInlineEnd",
|
|
3130
|
+
/** border properties */
|
|
3131
|
+
border = "border",
|
|
3132
|
+
borderWidth = "borderWidth",
|
|
3133
|
+
borderStyle = "borderStyle",
|
|
3134
|
+
borderColor = "borderColor",
|
|
3135
|
+
borderTop = "borderTop",
|
|
3136
|
+
borderTopColor = "borderTopColor",
|
|
3137
|
+
borderTopWidth = "borderTopWidth",
|
|
3138
|
+
borderTopStyle = "borderTopStyle",
|
|
3139
|
+
borderRight = "borderRight",
|
|
3140
|
+
borderRightColor = "borderRightColor",
|
|
3141
|
+
borderRightWidth = "borderRightWidth",
|
|
3142
|
+
borderRightStyle = "borderRightStyle",
|
|
3143
|
+
borderBottom = "borderBottom",
|
|
3144
|
+
borderBottomColor = "borderBottomColor",
|
|
3145
|
+
borderBottomWidth = "borderBottomWidth",
|
|
3146
|
+
borderBottomStyle = "borderBottomStyle",
|
|
3147
|
+
borderLeft = "borderLeft",
|
|
3148
|
+
borderLeftColor = "borderLeftColor",
|
|
3149
|
+
borderLeftWidth = "borderLeftWidth",
|
|
3150
|
+
borderLeftStyle = "borderLeftStyle",
|
|
3151
|
+
borderInlineStart = "borderInlineStart",
|
|
3152
|
+
borderInlineStartColor = "borderInlineStartColor",
|
|
3153
|
+
borderInlineStartWidth = "borderInlineStartWidth",
|
|
3154
|
+
borderInlineStartStyle = "borderInlineStartStyle",
|
|
3155
|
+
borderInlineEnd = "borderInlineEnd",
|
|
3156
|
+
borderInlineEndColor = "borderInlineEndColor",
|
|
3157
|
+
borderInlineEndWidth = "borderInlineEndWidth",
|
|
3158
|
+
borderInlineEndStyle = "borderInlineEndStyle",
|
|
3159
|
+
/** border-radius properties */
|
|
3160
|
+
borderRadius = "borderRadius",
|
|
3161
|
+
borderTopLeftRadius = "borderTopLeftRadius",
|
|
3162
|
+
borderTopRightRadius = "borderTopRightRadius",
|
|
3163
|
+
borderBottomRightRadius = "borderBottomRightRadius",
|
|
3164
|
+
borderBottomLeftRadius = "borderBottomLeftRadius",
|
|
3165
|
+
borderStartStartRadius = "borderStartStartRadius",
|
|
3166
|
+
borderStartEndRadius = "borderStartEndRadius",
|
|
3167
|
+
borderEndStartRadius = "borderEndStartRadius",
|
|
3168
|
+
borderEndEndRadius = "borderEndEndRadius",
|
|
3169
|
+
/** font properties */
|
|
3170
|
+
font = "font",
|
|
3171
|
+
fontFamily = "fontFamily",
|
|
3172
|
+
fontSize = "fontSize",
|
|
3173
|
+
fontStretch = "fontStretch",
|
|
3174
|
+
fontStyle = "fontStyle",
|
|
3175
|
+
fontVariant = "fontVariant",
|
|
3176
|
+
fontWeight = "fontWeight",
|
|
3177
|
+
lineHeight = "lineHeight",
|
|
3178
|
+
/** text properties */
|
|
3179
|
+
color = "color",
|
|
3180
|
+
letterSpacing = "letterSpacing",
|
|
3181
|
+
writingMode = "writingMode",
|
|
3182
|
+
textAlign = "textAlign",
|
|
3183
|
+
textTransform = "textTransform",
|
|
3184
|
+
textShadow = "textShadow",
|
|
3185
|
+
textOverflow = "textOverflow",
|
|
3186
|
+
textIndent = "textIndent",
|
|
3187
|
+
/** text-decoration properties */
|
|
3188
|
+
textDecoration = "textDecoration",
|
|
3189
|
+
textDecorationColor = "textDecorationColor",
|
|
3190
|
+
textDecorationLine = "textDecorationLine",
|
|
3191
|
+
textDecorationStyle = "textDecorationStyle",
|
|
3192
|
+
textDecorationThickness = "textDecorationThickness",
|
|
3193
|
+
/** box related properties */
|
|
3194
|
+
boxShadow = "boxShadow",
|
|
3195
|
+
opacity = "opacity",
|
|
3196
|
+
overflow = "overflow",
|
|
3197
|
+
overflowX = "overflowX",
|
|
3198
|
+
overflowY = "overflowY",
|
|
3199
|
+
/** layout properties */
|
|
3200
|
+
display = "display",
|
|
3201
|
+
alignSelf = "alignSelf",
|
|
3202
|
+
justifyContent = "justifyContent",
|
|
3203
|
+
alignItems = "alignItems",
|
|
3204
|
+
flexDirection = "flexDirection",
|
|
3205
|
+
height = "height",
|
|
3206
|
+
width = "width",
|
|
3207
|
+
gap = "gap",
|
|
3208
|
+
columnGap = "columnGap",
|
|
3209
|
+
rowGap = "rowGap",
|
|
3210
|
+
/** filters */
|
|
3211
|
+
filter = "filter",
|
|
3212
|
+
backdropFilter = "backdropFilter",
|
|
3213
|
+
/** media sizing & alignment */
|
|
3214
|
+
objectFit = "objectFit",
|
|
3215
|
+
objectPosition = "objectPosition",
|
|
3216
|
+
/** blending & compositing */
|
|
3217
|
+
mixBlendMode = "mixBlendMode",
|
|
3218
|
+
isolation = "isolation",
|
|
3219
|
+
/** stroke properties */
|
|
3220
|
+
stroke = "stroke",
|
|
3221
|
+
strokeWidth = "strokeWidth",
|
|
3222
|
+
strokeOpacity = "strokeOpacity",
|
|
3223
|
+
/** fill properties */
|
|
3224
|
+
fill = "fill",
|
|
3225
|
+
fillOpacity = "fillOpacity"
|
|
3226
|
+
}
|
|
3227
|
+
|
|
3228
|
+
declare interface TargetElement {
|
|
3229
|
+
/**
|
|
3230
|
+
* The path to the element that needs to be targeted when this state is applied.
|
|
3231
|
+
* @minLength 1
|
|
3232
|
+
* @maxLength 500
|
|
3233
|
+
*/
|
|
3234
|
+
elementPath?: string;
|
|
3235
|
+
}
|
|
3236
|
+
|
|
3237
|
+
declare interface TemplateContainer {
|
|
3238
|
+
/** Layout configuration for the container, can be used to configure the editing of the container and the layout. */
|
|
3239
|
+
layout?: ContainerLayout;
|
|
3240
|
+
/** Path to the target arrayItems data item within the same element scope. */
|
|
3241
|
+
dataItemPath?: ItemPath;
|
|
3242
|
+
}
|
|
3243
|
+
|
|
3244
|
+
declare interface Text_2 {
|
|
3245
|
+
/** Indicates maximum length allowed for the text */
|
|
3246
|
+
maxLength?: number | null;
|
|
3247
|
+
/** Indicates minimum length required for the text */
|
|
3248
|
+
minLength?: number | null;
|
|
3249
|
+
/**
|
|
3250
|
+
* A regex pattern that the text must comply with
|
|
3251
|
+
* @maxLength 100
|
|
3252
|
+
*/
|
|
3253
|
+
pattern?: string | null;
|
|
3254
|
+
}
|
|
3255
|
+
export { Text_2 as Text }
|
|
3256
|
+
|
|
3257
|
+
export declare interface TextDecoration {
|
|
3258
|
+
/**
|
|
3259
|
+
* Stores the text-decoration-line property of the text-decoration shorthand
|
|
3260
|
+
* @maxLength 100
|
|
3261
|
+
*/
|
|
3262
|
+
textDecorationLine?: string | null;
|
|
3263
|
+
/**
|
|
3264
|
+
* Stores the text-decoration-color property of the text-decoration shorthand
|
|
3265
|
+
* @maxLength 100
|
|
3266
|
+
*/
|
|
3267
|
+
textDecorationColor?: string | null;
|
|
3268
|
+
/**
|
|
3269
|
+
* Stores the text-decoration-style property of the text-decoration shorthand
|
|
3270
|
+
* @maxLength 100
|
|
3271
|
+
*/
|
|
3272
|
+
textDecorationStyle?: string | null;
|
|
3273
|
+
/**
|
|
3274
|
+
* Stores the text-decoration-thickness property of the text-decoration shorthand
|
|
3275
|
+
* @maxLength 100
|
|
3276
|
+
*/
|
|
3277
|
+
textDecorationThickness?: string | null;
|
|
3278
|
+
/**
|
|
3279
|
+
* Stores the textDecoration shorthand item itself, should be used when you want to achieve with this group partial editing of the textDecoration shorthand
|
|
3280
|
+
* @maxLength 100
|
|
3281
|
+
*/
|
|
3282
|
+
textDecoration?: string | null;
|
|
3283
|
+
}
|
|
3284
|
+
|
|
3285
|
+
export declare interface TextEnum {
|
|
3286
|
+
/**
|
|
3287
|
+
* list of valid enum items
|
|
3288
|
+
* @maxSize 100
|
|
3289
|
+
*/
|
|
3290
|
+
options?: TextEnumOption[];
|
|
3291
|
+
}
|
|
3292
|
+
|
|
3293
|
+
declare interface TextEnumOption {
|
|
3294
|
+
/**
|
|
3295
|
+
* actual text value for this item
|
|
3296
|
+
* @maxLength 100
|
|
3297
|
+
*/
|
|
3298
|
+
value?: string;
|
|
3299
|
+
/**
|
|
3300
|
+
* display name for this text item
|
|
3301
|
+
* @maxLength 100
|
|
3302
|
+
*/
|
|
3303
|
+
displayName?: string;
|
|
3304
|
+
}
|
|
3305
|
+
|
|
3306
|
+
export declare interface TextGroup {
|
|
3307
|
+
/**
|
|
3308
|
+
* Stores the font shorthand item itself, should be used when you want to achieve with this group partial editing of the font shorthand
|
|
3309
|
+
* @maxLength 100
|
|
3310
|
+
*/
|
|
3311
|
+
font?: string | null;
|
|
3312
|
+
/**
|
|
3313
|
+
* Stores the font-style property for this text group
|
|
3314
|
+
* @maxLength 100
|
|
3315
|
+
*/
|
|
3316
|
+
fontStyle?: string | null;
|
|
3317
|
+
/**
|
|
3318
|
+
* Stores the font-variant property for this text group
|
|
3319
|
+
* @maxLength 100
|
|
3320
|
+
*/
|
|
3321
|
+
fontVariant?: string | null;
|
|
3322
|
+
/**
|
|
3323
|
+
* Stores the font-weight property of the font shorthand
|
|
3324
|
+
* @maxLength 100
|
|
3325
|
+
*/
|
|
3326
|
+
fontWeight?: string | null;
|
|
3327
|
+
/**
|
|
3328
|
+
* Stores the font-size property for this text group
|
|
3329
|
+
* @maxLength 100
|
|
3330
|
+
*/
|
|
3331
|
+
fontSize?: string | null;
|
|
3332
|
+
/**
|
|
3333
|
+
* Stores the line-height property for this text group
|
|
3334
|
+
* @maxLength 100
|
|
3335
|
+
*/
|
|
3336
|
+
lineHeight?: string | null;
|
|
3337
|
+
/**
|
|
3338
|
+
* Stores the font-family property for this text group
|
|
3339
|
+
* @maxLength 100
|
|
3340
|
+
*/
|
|
3341
|
+
fontFamily?: string | null;
|
|
3342
|
+
/**
|
|
3343
|
+
* Stores the color property for this text group
|
|
3344
|
+
* @maxLength 100
|
|
3345
|
+
*/
|
|
3346
|
+
color?: string | null;
|
|
3347
|
+
/**
|
|
3348
|
+
* Stores the letter-spacing property for this text group
|
|
3349
|
+
* @maxLength 100
|
|
3350
|
+
*/
|
|
3351
|
+
letterSpacing?: string | null;
|
|
3352
|
+
/**
|
|
3353
|
+
* Stores the text-align property for this text group
|
|
3354
|
+
* @maxLength 100
|
|
3355
|
+
*/
|
|
3356
|
+
textAlign?: string | null;
|
|
3357
|
+
/**
|
|
3358
|
+
* Stores the text-transform property for this text group
|
|
3359
|
+
* @maxLength 100
|
|
3360
|
+
*/
|
|
3361
|
+
textTransform?: string | null;
|
|
3362
|
+
/**
|
|
3363
|
+
* Stores the text-shadow property for this text group
|
|
3364
|
+
* @maxLength 100
|
|
3365
|
+
*/
|
|
3366
|
+
textShadow?: string | null;
|
|
3367
|
+
/**
|
|
3368
|
+
* Stores the text-decoration-line property for this text group
|
|
3369
|
+
* @maxLength 100
|
|
3370
|
+
*/
|
|
3371
|
+
textDecorationLine?: string | null;
|
|
3372
|
+
/**
|
|
3373
|
+
* Stores the writing-mode property for this text group
|
|
3374
|
+
* @maxLength 100
|
|
3375
|
+
*/
|
|
3376
|
+
writingMode?: string | null;
|
|
3377
|
+
/**
|
|
3378
|
+
* Stores the direction data-item for this text group
|
|
3379
|
+
* @maxLength 100
|
|
3380
|
+
*/
|
|
3381
|
+
direction?: string | null;
|
|
3382
|
+
/**
|
|
3383
|
+
* Stores the a11y data-item for this text group
|
|
3384
|
+
* @maxLength 100
|
|
3385
|
+
*/
|
|
3386
|
+
a11y?: string | null;
|
|
3387
|
+
}
|
|
3388
|
+
|
|
3389
|
+
declare interface TranslationResources {
|
|
3390
|
+
/**
|
|
3391
|
+
* The URL that we will add the language to for fetching translations, example: `https://somecdn.com/translations/`
|
|
3392
|
+
* @format WEB_URL
|
|
3393
|
+
*/
|
|
3394
|
+
basePath?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* The list of supported languages according to the [ISO-639-1 specification](https://en.wikipedia.org/wiki/ISO_639-1)
|
|
3397
|
+
* @format LANGUAGE
|
|
3398
|
+
* @maxSize 37
|
|
3399
|
+
*/
|
|
3400
|
+
languages?: string[];
|
|
3401
|
+
}
|
|
3402
|
+
|
|
3403
|
+
export declare interface VectorArt {
|
|
3404
|
+
/** media manager categories to open media manager filtered by the component needs */
|
|
3405
|
+
category?: VectorArtCategoryTypes;
|
|
3406
|
+
}
|
|
3407
|
+
|
|
3408
|
+
declare enum VectorArtCategoryTypes {
|
|
3409
|
+
/** Default value when vector art category is not specified */
|
|
3410
|
+
UNKNOWN_VectorArtCategoryTypes = "UNKNOWN_VectorArtCategoryTypes",
|
|
3411
|
+
/** Vector Art (both basic and art shapes) - mapped to VECTOR_ART */
|
|
3412
|
+
SHAPE_ALL = "SHAPE_ALL",
|
|
3413
|
+
/** Basic Shapes - mapped to SHAPE_BASIC */
|
|
3414
|
+
SHAPE_BASIC = "SHAPE_BASIC",
|
|
3415
|
+
/** Vector Art Shapes - mapped to SHAPE_ART */
|
|
3416
|
+
SHAPE_ART = "SHAPE_ART",
|
|
3417
|
+
/** Social Icons - deprecated use SHAPE_SOCIAL instead */
|
|
3418
|
+
ICON_SOCIAL = "ICON_SOCIAL",
|
|
3419
|
+
/** SVG Shape Dividers - mapped to DIVIDERS */
|
|
3420
|
+
SHAPE_DIVIDERS = "SHAPE_DIVIDERS",
|
|
3421
|
+
/** Location Icons - mapped to SHAPE_LOCATION */
|
|
3422
|
+
SHAPE_LOCATION = "SHAPE_LOCATION",
|
|
3423
|
+
/** Documents Icons - mapped to SHAPE_DOCUMENTS */
|
|
3424
|
+
SHAPE_DOCUMENTS = "SHAPE_DOCUMENTS",
|
|
3425
|
+
/** Social Icons - mapped to SHAPE_SOCIAL from type SVG */
|
|
3426
|
+
SHAPE_SOCIAL = "SHAPE_SOCIAL",
|
|
3427
|
+
/** Arrow Icons - mapped to SHAPE_ARROWS */
|
|
3428
|
+
SHAPE_ARROWS = "SHAPE_ARROWS"
|
|
3429
|
+
}
|
|
3430
|
+
|
|
3431
|
+
declare interface VectorArtOverrides {
|
|
3432
|
+
/** media manager categories to open media manager filtered by the overriding component needs */
|
|
3433
|
+
category?: VectorArtCategoryTypes;
|
|
3434
|
+
}
|
|
3435
|
+
|
|
3436
|
+
declare enum Vertical {
|
|
3437
|
+
NONE = "NONE",
|
|
3438
|
+
TOP = "TOP",
|
|
3439
|
+
CENTER = "CENTER",
|
|
3440
|
+
BOTTOM = "BOTTOM"
|
|
3441
|
+
}
|
|
3442
|
+
|
|
3443
|
+
export declare interface Video {
|
|
3444
|
+
/** media manager categories to open media manager filtered by the component needs */
|
|
3445
|
+
category?: VideoCategoryTypes;
|
|
3446
|
+
}
|
|
3447
|
+
|
|
3448
|
+
declare enum VideoCategoryTypes {
|
|
3449
|
+
/** Default value when video category is not specified */
|
|
3450
|
+
UNKNOWN_VideoCategoryTypes = "UNKNOWN_VideoCategoryTypes",
|
|
3451
|
+
/** Both videos and transparent videos - mapped to VIDEO_BOX */
|
|
3452
|
+
VIDEO = "VIDEO",
|
|
3453
|
+
/** Transparent videos - mapped to VIDEO_ALPHA */
|
|
3454
|
+
VIDEO_TRANSPARENT = "VIDEO_TRANSPARENT",
|
|
3455
|
+
/** Videos without transparency - mapped to VIDEO */
|
|
3456
|
+
VIDEO_OPAQUE = "VIDEO_OPAQUE"
|
|
3457
|
+
}
|
|
3458
|
+
|
|
3459
|
+
declare interface VideoOverrides {
|
|
3460
|
+
/** media manager categories to open media manager filtered by the overriding component needs */
|
|
3461
|
+
category?: VideoCategoryTypes;
|
|
3462
|
+
}
|
|
3463
|
+
|
|
3464
|
+
export declare interface VisibleState {
|
|
3465
|
+
/**
|
|
3466
|
+
* The key of the state that will trigger the visibility of this element
|
|
3467
|
+
* @minLength 1
|
|
3468
|
+
* @maxLength 100
|
|
3469
|
+
*/
|
|
3470
|
+
stateKey?: string;
|
|
3471
|
+
/**
|
|
3472
|
+
* The path to the element that owns the relevant state to trigger, path pattern "/elementkey/elementkey"
|
|
3473
|
+
* @minLength 1
|
|
3474
|
+
* @maxLength 500
|
|
3475
|
+
*/
|
|
3476
|
+
elementPath?: string;
|
|
3477
|
+
}
|
|
3478
|
+
|
|
3479
|
+
export declare interface WritingMode {
|
|
3480
|
+
/**
|
|
3481
|
+
* list of writing-mode values in case we want to reduce the abilities exposed to the User
|
|
3482
|
+
* @maxSize 20
|
|
3483
|
+
*/
|
|
3484
|
+
writingModeValues?: WritingModeValue[];
|
|
3485
|
+
}
|
|
3486
|
+
|
|
3487
|
+
declare enum WritingModeValue {
|
|
3488
|
+
UNKNOWN_WritingModeValue = "UNKNOWN_WritingModeValue",
|
|
3489
|
+
horizontalTb = "horizontalTb",
|
|
3490
|
+
verticalRl = "verticalRl",
|
|
3491
|
+
verticalLr = "verticalLr",
|
|
3492
|
+
sidewaysRl = "sidewaysRl",
|
|
3493
|
+
sidewaysLr = "sidewaysLr"
|
|
3494
|
+
}
|
|
3495
|
+
|
|
3496
|
+
export { }
|