@wix/stores 1.0.959 → 1.0.960
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/_sdk-exports/context-category-by-id-context-provider/runtime.d.ts +4026 -0
- package/_sdk-exports/context-category-by-id-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-category-by-slug-context-provider/runtime.d.ts +4046 -0
- package/_sdk-exports/context-category-by-slug-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-category-info-context-provider/runtime.d.ts +3530 -0
- package/_sdk-exports/context-category-info-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-category-list-context-provider/runtime.d.ts +101 -0
- package/_sdk-exports/context-category-list-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-product-by-id-context-provider/runtime.d.ts +4221 -0
- package/_sdk-exports/context-product-by-id-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-product-by-slug-context-provider/runtime.d.ts +4217 -0
- package/_sdk-exports/context-product-by-slug-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-product-context-provider/runtime.d.ts +4449 -0
- package/_sdk-exports/context-product-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-product-item-context-provider/runtime.d.ts +4102 -0
- package/_sdk-exports/context-product-item-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-product-list-context-provider/runtime.d.ts +3969 -0
- package/_sdk-exports/context-product-list-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-promotion-item-context-provider/runtime.d.ts +85 -0
- package/_sdk-exports/context-promotion-item-context-provider/runtime.js +2 -0
- package/build/cjs/context-category-by-id-context-provider.d.ts +4026 -0
- package/build/cjs/context-category-by-id-context-provider.js +3572 -0
- package/build/cjs/context-category-by-id-context-provider.js.map +1 -0
- package/build/cjs/context-category-by-slug-context-provider.d.ts +4046 -0
- package/build/cjs/context-category-by-slug-context-provider.js +3674 -0
- package/build/cjs/context-category-by-slug-context-provider.js.map +1 -0
- package/build/cjs/context-category-info-context-provider.d.ts +3530 -0
- package/build/cjs/context-category-info-context-provider.js +1201 -0
- package/build/cjs/context-category-info-context-provider.js.map +1 -0
- package/build/cjs/context-category-list-context-provider.d.ts +101 -0
- package/build/cjs/context-category-list-context-provider.js +587 -0
- package/build/cjs/context-category-list-context-provider.js.map +1 -0
- package/build/cjs/context-product-by-id-context-provider.d.ts +4221 -0
- package/build/cjs/context-product-by-id-context-provider.js +3454 -0
- package/build/cjs/context-product-by-id-context-provider.js.map +1 -0
- package/build/cjs/context-product-by-slug-context-provider.d.ts +4217 -0
- package/build/cjs/context-product-by-slug-context-provider.js +3477 -0
- package/build/cjs/context-product-by-slug-context-provider.js.map +1 -0
- package/build/cjs/context-product-context-provider.d.ts +4449 -0
- package/build/cjs/context-product-context-provider.js +587 -0
- package/build/cjs/context-product-context-provider.js.map +1 -0
- package/build/cjs/context-product-item-context-provider.d.ts +4102 -0
- package/build/cjs/context-product-item-context-provider.js +4396 -0
- package/build/cjs/context-product-item-context-provider.js.map +1 -0
- package/build/cjs/context-product-list-context-provider.d.ts +3970 -0
- package/build/cjs/context-product-list-context-provider.js +587 -0
- package/build/cjs/context-product-list-context-provider.js.map +1 -0
- package/build/cjs/context-promotion-item-context-provider.d.ts +85 -0
- package/build/cjs/context-promotion-item-context-provider.js +592 -0
- package/build/cjs/context-promotion-item-context-provider.js.map +1 -0
- package/build/es/context-category-by-id-context-provider.d.mts +4026 -0
- package/build/es/context-category-by-id-context-provider.mjs +3532 -0
- package/build/es/context-category-by-id-context-provider.mjs.map +1 -0
- package/build/es/context-category-by-slug-context-provider.d.mts +4046 -0
- package/build/es/context-category-by-slug-context-provider.mjs +3634 -0
- package/build/es/context-category-by-slug-context-provider.mjs.map +1 -0
- package/build/es/context-category-info-context-provider.d.mts +3530 -0
- package/build/es/context-category-info-context-provider.mjs +1172 -0
- package/build/es/context-category-info-context-provider.mjs.map +1 -0
- package/build/es/context-category-list-context-provider.d.mts +101 -0
- package/build/es/context-category-list-context-provider.mjs +558 -0
- package/build/es/context-category-list-context-provider.mjs.map +1 -0
- package/build/es/context-product-by-id-context-provider.d.mts +4221 -0
- package/build/es/context-product-by-id-context-provider.mjs +3415 -0
- package/build/es/context-product-by-id-context-provider.mjs.map +1 -0
- package/build/es/context-product-by-slug-context-provider.d.mts +4217 -0
- package/build/es/context-product-by-slug-context-provider.mjs +3437 -0
- package/build/es/context-product-by-slug-context-provider.mjs.map +1 -0
- package/build/es/context-product-context-provider.d.mts +4449 -0
- package/build/es/context-product-context-provider.mjs +558 -0
- package/build/es/context-product-context-provider.mjs.map +1 -0
- package/build/es/context-product-item-context-provider.d.mts +4102 -0
- package/build/es/context-product-item-context-provider.mjs +4356 -0
- package/build/es/context-product-item-context-provider.mjs.map +1 -0
- package/build/es/context-product-list-context-provider.d.mts +3970 -0
- package/build/es/context-product-list-context-provider.mjs +558 -0
- package/build/es/context-product-list-context-provider.mjs.map +1 -0
- package/build/es/context-promotion-item-context-provider.d.mts +85 -0
- package/build/es/context-promotion-item-context-provider.mjs +563 -0
- package/build/es/context-promotion-item-context-provider.mjs.map +1 -0
- package/build/internal/cjs/context-category-by-id-context-provider.d.ts +4026 -0
- package/build/internal/cjs/context-category-by-slug-context-provider.d.ts +4046 -0
- package/build/internal/cjs/context-category-info-context-provider.d.ts +3530 -0
- package/build/internal/cjs/context-category-list-context-provider.d.ts +101 -0
- package/build/internal/cjs/context-product-by-id-context-provider.d.ts +4221 -0
- package/build/internal/cjs/context-product-by-slug-context-provider.d.ts +4217 -0
- package/build/internal/cjs/context-product-context-provider.d.ts +4449 -0
- package/build/internal/cjs/context-product-item-context-provider.d.ts +4102 -0
- package/build/internal/cjs/context-product-list-context-provider.d.ts +3970 -0
- package/build/internal/cjs/context-promotion-item-context-provider.d.ts +85 -0
- package/build/internal/es/context-category-by-id-context-provider.d.mts +4026 -0
- package/build/internal/es/context-category-by-slug-context-provider.d.mts +4046 -0
- package/build/internal/es/context-category-info-context-provider.d.mts +3530 -0
- package/build/internal/es/context-category-list-context-provider.d.mts +101 -0
- package/build/internal/es/context-product-by-id-context-provider.d.mts +4221 -0
- package/build/internal/es/context-product-by-slug-context-provider.d.mts +4217 -0
- package/build/internal/es/context-product-context-provider.d.mts +4449 -0
- package/build/internal/es/context-product-item-context-provider.d.mts +4102 -0
- package/build/internal/es/context-product-list-context-provider.d.mts +3970 -0
- package/build/internal/es/context-promotion-item-context-provider.d.mts +85 -0
- package/category-by-id-context-provider/package.json +3 -0
- package/category-by-slug-context-provider/package.json +3 -0
- package/category-info-context-provider/package.json +3 -0
- package/category-list-context-provider/package.json +3 -0
- package/context/category-by-id-context-provider/package.json +3 -0
- package/context/category-by-slug-context-provider/package.json +3 -0
- package/context/category-info-context-provider/package.json +3 -0
- package/context/category-list-context-provider/package.json +3 -0
- package/context/product-by-id-context-provider/package.json +3 -0
- package/context/product-by-slug-context-provider/package.json +3 -0
- package/context/product-context-provider/package.json +3 -0
- package/context/product-item-context-provider/package.json +3 -0
- package/context/product-list-context-provider/package.json +3 -0
- package/context/promotion-item-context-provider/package.json +3 -0
- package/package.json +159 -24
- package/product-by-id-context-provider/package.json +3 -0
- package/product-by-slug-context-provider/package.json +3 -0
- package/product-context-provider/package.json +3 -0
- package/product-item-context-provider/package.json +3 -0
- package/product-list-context-provider/package.json +3 -0
- package/promotion-item-context-provider/package.json +3 -0
|
@@ -0,0 +1,3530 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
//#region ../../node_modules/@wix/ricos/dist/src/ricos-schema/next-schema/generated/ricos_document.d.ts
|
|
4
|
+
type RicosDocument = {
|
|
5
|
+
/** Array of nodes representing content elements, such as `ParagraphNode` or `HeadingNode`. */nodes: RicosDocumentNode[]; /** Information about the Ricos document itself, such as its version. Only relevant when building the Ricos document using the [Ricos playground](https:/ricos.dev), in which case it is auto-generated. */
|
|
6
|
+
metadata?: Metadata; /** Includes styling to be applied throughout the Ricos document for the specified node types. For example, you can define general styling for `headerOne`, and then override some of the properties separately for a specific header. */
|
|
7
|
+
documentStyle?: DocumentStyle;
|
|
8
|
+
};
|
|
9
|
+
type NodeStyle = {
|
|
10
|
+
/** The top padding value in pixels. */paddingTop?: string; /** The bottom padding value in pixels. */
|
|
11
|
+
paddingBottom?: string;
|
|
12
|
+
backgroundColor?: string;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Sets a default styling for specific node types throughout the entire Ricos Document. For example, you can set the text color for all Heading 1 nodes.
|
|
16
|
+
* You can override the styling of specific Text nodes separately using [decorations](#decorations).
|
|
17
|
+
*/
|
|
18
|
+
type DocumentStyle = {
|
|
19
|
+
/** Style for the H1 nodes. */headerOne?: TextNodeStyle; /** Style for the H2 nodes. */
|
|
20
|
+
headerTwo?: TextNodeStyle; /** Style for the H3 nodes. */
|
|
21
|
+
headerThree?: TextNodeStyle; /** Style for the H4 nodes. */
|
|
22
|
+
headerFour?: TextNodeStyle; /** Style for the H5 nodes. */
|
|
23
|
+
headerFive?: TextNodeStyle; /** Style for the H6 nodes. */
|
|
24
|
+
headerSix?: TextNodeStyle; /** Style for the paragraph nodes. */
|
|
25
|
+
paragraph?: TextNodeStyle; /** Style for the block quote nodes. */
|
|
26
|
+
blockquote?: TextNodeStyle; /** Style for the codeblock nodes. */
|
|
27
|
+
codeBlock?: TextNodeStyle;
|
|
28
|
+
};
|
|
29
|
+
type TextNodeStyle = {
|
|
30
|
+
decorations?: Decoration[];
|
|
31
|
+
/**
|
|
32
|
+
* Node style, such as padding.
|
|
33
|
+
* **Note:** This node requires the [lineSpacing](#plugins) plugin to be enabled.
|
|
34
|
+
*/
|
|
35
|
+
nodeStyle?: NodeStyle; /** Text line height. */
|
|
36
|
+
lineHeight?: string;
|
|
37
|
+
};
|
|
38
|
+
type Metadata = {
|
|
39
|
+
/** Ricos document version. */version?: number;
|
|
40
|
+
id?: any;
|
|
41
|
+
createdTimestamp?: any;
|
|
42
|
+
updatedTimestamp?: any;
|
|
43
|
+
};
|
|
44
|
+
/** Node animation, discriminated by `type`. `VIEW` animations play while the node is in view; `POINTER` animations follow the visitor's mouse. The kinds are mutually exclusive by construction — additional kinds (scroll-driven) may be added in the future. */
|
|
45
|
+
type Animation = Animation_View | Animation_Pointer;
|
|
46
|
+
/** Animations that play while the node is in view. At least one of `entrance` or `loop` should be set — an empty `VIEW` is treated as no animation. */
|
|
47
|
+
type Animation_View = {
|
|
48
|
+
/**
|
|
49
|
+
* Animation kind.
|
|
50
|
+
* Must be `VIEW`.
|
|
51
|
+
*/
|
|
52
|
+
type: 'VIEW'; /** Entrance animation, played once when the node first enters the viewport. */
|
|
53
|
+
entrance?: EntranceAnimation; /** Looping animation, repeated indefinitely while the node is on the page. When combined with `entrance`, the loop starts after the entrance finishes. */
|
|
54
|
+
loop?: LoopAnimation;
|
|
55
|
+
};
|
|
56
|
+
/** Animations driven by the visitor's mouse position — the node continuously reacts as the pointer moves. Mutually exclusive with `VIEW` animations by construction. */
|
|
57
|
+
type Animation_Pointer = {
|
|
58
|
+
/**
|
|
59
|
+
* Animation kind.
|
|
60
|
+
* Must be `POINTER`.
|
|
61
|
+
*/
|
|
62
|
+
type: 'POINTER'; /** The mouse effect, discriminated by `type`. */
|
|
63
|
+
effect: PointerEffect; /** How quickly the node settles toward the pointer, in milliseconds (the editor's velocity control). When omitted, the effect's own tuned default is used. */
|
|
64
|
+
transitionDuration?: number;
|
|
65
|
+
};
|
|
66
|
+
/** Entrance animation configuration: the effect to play and its timing options. */
|
|
67
|
+
type EntranceAnimation = {
|
|
68
|
+
/** The entrance effect, discriminated by `type`. */effect: EntranceEffect; /** Effect duration in milliseconds. When omitted, the effect's own tuned default is used — each effect has a different one. */
|
|
69
|
+
duration?: number; /** Delay before the effect starts, in milliseconds. */
|
|
70
|
+
delay?: number;
|
|
71
|
+
};
|
|
72
|
+
/** Entrance effect, discriminated by `type`. Each effect exposes only its own parameters; all parameters are optional and fall back to tuned defaults. */
|
|
73
|
+
type EntranceEffect = EntranceEffect_Fade | EntranceEffect_Arc | EntranceEffect_Blur | EntranceEffect_Bounce | EntranceEffect_Drop | EntranceEffect_Expand | EntranceEffect_Flip | EntranceEffect_Float | EntranceEffect_Fold | EntranceEffect_Glide | EntranceEffect_Reveal | EntranceEffect_Shape | EntranceEffect_Shutters | EntranceEffect_Slide | EntranceEffect_Spin | EntranceEffect_Tilt | EntranceEffect_Turn | EntranceEffect_Wink;
|
|
74
|
+
/** Fades in smoothly from fully transparent to fully opaque. */
|
|
75
|
+
type EntranceEffect_Fade = {
|
|
76
|
+
/**
|
|
77
|
+
* Effect type.
|
|
78
|
+
* Must be `FADE`.
|
|
79
|
+
*/
|
|
80
|
+
type: 'FADE';
|
|
81
|
+
};
|
|
82
|
+
/** Enters along a 3D arc path, rotating into view with depth motion. */
|
|
83
|
+
type EntranceEffect_Arc = {
|
|
84
|
+
/**
|
|
85
|
+
* Effect type.
|
|
86
|
+
* Must be `ARC`.
|
|
87
|
+
*/
|
|
88
|
+
type: 'ARC'; /** Direction the element arcs in from. Defaults to `LEFT`. */
|
|
89
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `MODERATE`. */
|
|
90
|
+
easing?: Animation_Easing;
|
|
91
|
+
};
|
|
92
|
+
/** Transitions from blurred to sharp while fading in. */
|
|
93
|
+
type EntranceEffect_Blur = {
|
|
94
|
+
/**
|
|
95
|
+
* Effect type.
|
|
96
|
+
* Must be `BLUR`.
|
|
97
|
+
*/
|
|
98
|
+
type: 'BLUR'; /** Motion style. Defaults to `GENTLE`. */
|
|
99
|
+
easing?: Animation_Easing;
|
|
100
|
+
};
|
|
101
|
+
/** Bounces into place from a direction with an elastic multi-step curve. */
|
|
102
|
+
type EntranceEffect_Bounce = {
|
|
103
|
+
/**
|
|
104
|
+
* Effect type.
|
|
105
|
+
* Must be `BOUNCE`.
|
|
106
|
+
*/
|
|
107
|
+
type: 'BOUNCE'; /** Direction the element bounces in from. `CENTER` bounces in place, with no travel. Defaults to `TOP`. */
|
|
108
|
+
direction?: EntranceEffect_Bounce_Direction; /** Motion style. Defaults to `GENTLE`. */
|
|
109
|
+
easing?: Animation_Easing;
|
|
110
|
+
};
|
|
111
|
+
type EntranceEffect_Bounce_Direction = 'LEFT' | 'RIGHT' | 'TOP' | 'BOTTOM' | 'CENTER';
|
|
112
|
+
declare const EntranceEffect_Bounce_Direction: {
|
|
113
|
+
readonly LEFT: 'LEFT';
|
|
114
|
+
readonly RIGHT: 'RIGHT';
|
|
115
|
+
readonly TOP: 'TOP';
|
|
116
|
+
readonly BOTTOM: 'BOTTOM';
|
|
117
|
+
readonly CENTER: 'CENTER';
|
|
118
|
+
};
|
|
119
|
+
/** Shrinks down from a larger size to its final scale. */
|
|
120
|
+
type EntranceEffect_Drop = {
|
|
121
|
+
/**
|
|
122
|
+
* Effect type.
|
|
123
|
+
* Must be `DROP`.
|
|
124
|
+
*/
|
|
125
|
+
type: 'DROP'; /** Motion style. Defaults to `GENTLE`. */
|
|
126
|
+
easing?: Animation_Easing;
|
|
127
|
+
};
|
|
128
|
+
/** Expands from a point in a given direction, scaling from small to full size with a fade-in. */
|
|
129
|
+
type EntranceEffect_Expand = {
|
|
130
|
+
/**
|
|
131
|
+
* Effect type.
|
|
132
|
+
* Must be `EXPAND`.
|
|
133
|
+
*/
|
|
134
|
+
type: 'EXPAND'; /** Direction the element travels in from while expanding. `CENTER` expands in place, with no travel. Defaults to `CENTER`. */
|
|
135
|
+
direction?: Animation_RadialDirection; /** Motion style. Defaults to `GENTLE`. */
|
|
136
|
+
easing?: Animation_Easing;
|
|
137
|
+
};
|
|
138
|
+
/** Flips into view with a 3D rotation around the X or Y axis. */
|
|
139
|
+
type EntranceEffect_Flip = {
|
|
140
|
+
/**
|
|
141
|
+
* Effect type.
|
|
142
|
+
* Must be `FLIP`.
|
|
143
|
+
*/
|
|
144
|
+
type: 'FLIP'; /** Direction the element flips in from. Defaults to `BOTTOM`. */
|
|
145
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `GENTLE`. */
|
|
146
|
+
easing?: Animation_Easing;
|
|
147
|
+
};
|
|
148
|
+
/** Drifts gently into place from a direction with a fade-in. */
|
|
149
|
+
type EntranceEffect_Float = {
|
|
150
|
+
/**
|
|
151
|
+
* Effect type.
|
|
152
|
+
* Must be `FLOAT`.
|
|
153
|
+
*/
|
|
154
|
+
type: 'FLOAT'; /** Direction the element floats in from. Defaults to `BOTTOM`. */
|
|
155
|
+
direction?: Animation_Direction;
|
|
156
|
+
};
|
|
157
|
+
/** Unfolds from an edge, rotating around an axis at the edge as if hinged. */
|
|
158
|
+
type EntranceEffect_Fold = {
|
|
159
|
+
/**
|
|
160
|
+
* Effect type.
|
|
161
|
+
* Must be `FOLD`.
|
|
162
|
+
*/
|
|
163
|
+
type: 'FOLD'; /** Edge the element unfolds from. Defaults to `TOP`. */
|
|
164
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `INTENSE`. */
|
|
165
|
+
easing?: Animation_Easing;
|
|
166
|
+
};
|
|
167
|
+
/** Glides in smoothly from off-screen along a direction. */
|
|
168
|
+
type EntranceEffect_Glide = {
|
|
169
|
+
/**
|
|
170
|
+
* Effect type.
|
|
171
|
+
* Must be `GLIDE`.
|
|
172
|
+
*/
|
|
173
|
+
type: 'GLIDE'; /** Direction the element glides in from, including the diagonals. Defaults to `BOTTOM`. */
|
|
174
|
+
direction?: EntranceEffect_Glide_Direction; /** Motion style. Defaults to `GENTLE`. */
|
|
175
|
+
easing?: Animation_Easing;
|
|
176
|
+
};
|
|
177
|
+
type EntranceEffect_Glide_Direction = 'RIGHT' | 'TOP_RIGHT' | 'TOP' | 'TOP_LEFT' | 'LEFT' | 'BOTTOM_LEFT' | 'BOTTOM' | 'BOTTOM_RIGHT';
|
|
178
|
+
declare const EntranceEffect_Glide_Direction: {
|
|
179
|
+
readonly RIGHT: 'RIGHT';
|
|
180
|
+
readonly TOP_RIGHT: 'TOP_RIGHT';
|
|
181
|
+
readonly TOP: 'TOP';
|
|
182
|
+
readonly TOP_LEFT: 'TOP_LEFT';
|
|
183
|
+
readonly LEFT: 'LEFT';
|
|
184
|
+
readonly BOTTOM_LEFT: 'BOTTOM_LEFT';
|
|
185
|
+
readonly BOTTOM: 'BOTTOM';
|
|
186
|
+
readonly BOTTOM_RIGHT: 'BOTTOM_RIGHT';
|
|
187
|
+
};
|
|
188
|
+
/** Progressively revealed by an expanding clip-path from one edge. */
|
|
189
|
+
type EntranceEffect_Reveal = {
|
|
190
|
+
/**
|
|
191
|
+
* Effect type.
|
|
192
|
+
* Must be `REVEAL`.
|
|
193
|
+
*/
|
|
194
|
+
type: 'REVEAL'; /** Edge the reveal starts from. Defaults to `BOTTOM`. */
|
|
195
|
+
direction?: Animation_Direction;
|
|
196
|
+
};
|
|
197
|
+
/** Appears through an expanding geometric clip-path shape. */
|
|
198
|
+
type EntranceEffect_Shape = {
|
|
199
|
+
/**
|
|
200
|
+
* Effect type.
|
|
201
|
+
* Must be `SHAPE`.
|
|
202
|
+
*/
|
|
203
|
+
type: 'SHAPE'; /** Clip-path shape. Defaults to `CIRCLE`. */
|
|
204
|
+
shape?: EntranceEffect_Shape_ClipShape;
|
|
205
|
+
};
|
|
206
|
+
type EntranceEffect_Shape_ClipShape = 'ELLIPSE' | 'CIRCLE' | 'RECTANGLE' | 'DIAMOND';
|
|
207
|
+
declare const EntranceEffect_Shape_ClipShape: {
|
|
208
|
+
readonly ELLIPSE: 'ELLIPSE';
|
|
209
|
+
readonly CIRCLE: 'CIRCLE';
|
|
210
|
+
readonly RECTANGLE: 'RECTANGLE';
|
|
211
|
+
readonly DIAMOND: 'DIAMOND';
|
|
212
|
+
};
|
|
213
|
+
/** Revealed through multiple shutter-like strips that open in sequence. */
|
|
214
|
+
type EntranceEffect_Shutters = {
|
|
215
|
+
/**
|
|
216
|
+
* Effect type.
|
|
217
|
+
* Must be `SHUTTERS`.
|
|
218
|
+
*/
|
|
219
|
+
type: 'SHUTTERS'; /** Direction the shutters open toward. Defaults to `RIGHT`. */
|
|
220
|
+
direction?: Animation_Direction;
|
|
221
|
+
};
|
|
222
|
+
/** Slides in from one side while being revealed with a clip-path mask. */
|
|
223
|
+
type EntranceEffect_Slide = {
|
|
224
|
+
/**
|
|
225
|
+
* Effect type.
|
|
226
|
+
* Must be `SLIDE`.
|
|
227
|
+
*/
|
|
228
|
+
type: 'SLIDE'; /** Direction the element slides in from. Defaults to `BOTTOM`. */
|
|
229
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `INTENSE`. */
|
|
230
|
+
easing?: Animation_Easing;
|
|
231
|
+
};
|
|
232
|
+
/** Spins into view while scaling from small to full size. */
|
|
233
|
+
type EntranceEffect_Spin = {
|
|
234
|
+
/**
|
|
235
|
+
* Effect type.
|
|
236
|
+
* Must be `SPIN`.
|
|
237
|
+
*/
|
|
238
|
+
type: 'SPIN'; /** Rotation direction. Defaults to `CLOCKWISE`. */
|
|
239
|
+
direction?: Animation_SpinDirection; /** Motion style. Defaults to `MODERATE`. */
|
|
240
|
+
easing?: Animation_Easing;
|
|
241
|
+
};
|
|
242
|
+
/** Tilts in from the side with 3D rotation and a clip-path reveal. */
|
|
243
|
+
type EntranceEffect_Tilt = {
|
|
244
|
+
/**
|
|
245
|
+
* Effect type.
|
|
246
|
+
* Must be `TILT`.
|
|
247
|
+
*/
|
|
248
|
+
type: 'TILT'; /** Side the element tilts in from. Defaults to `LEFT`. */
|
|
249
|
+
direction?: Animation_SideDirection;
|
|
250
|
+
};
|
|
251
|
+
/** Rotates into view around a corner pivot point. */
|
|
252
|
+
type EntranceEffect_Turn = {
|
|
253
|
+
/**
|
|
254
|
+
* Effect type.
|
|
255
|
+
* Must be `TURN`.
|
|
256
|
+
*/
|
|
257
|
+
type: 'TURN'; /** Corner pivot the element turns around. Defaults to `BOTTOM_LEFT`. */
|
|
258
|
+
direction?: Animation_CornerDirection; /** Motion style. Defaults to `INTENSE`. */
|
|
259
|
+
easing?: Animation_Easing;
|
|
260
|
+
};
|
|
261
|
+
/** Winks into view by expanding from its horizontal or vertical center, while being revealed with a clip-path. */
|
|
262
|
+
type EntranceEffect_Wink = {
|
|
263
|
+
/**
|
|
264
|
+
* Effect type.
|
|
265
|
+
* Must be `WINK`.
|
|
266
|
+
*/
|
|
267
|
+
type: 'WINK'; /** Axis the wink expands along. Defaults to `VERTICAL`. */
|
|
268
|
+
direction?: Animation_Orientation;
|
|
269
|
+
};
|
|
270
|
+
/** Looping animation configuration: the effect to repeat and its timing options. The effect repeats indefinitely while the node is on the page. */
|
|
271
|
+
type LoopAnimation = {
|
|
272
|
+
/** The looping effect, discriminated by `type`. */effect: LoopEffect; /** Duration of a single iteration in milliseconds. When omitted, the effect's own tuned default is used — each effect has a different one. */
|
|
273
|
+
duration?: number; /** Pause between iterations in milliseconds. */
|
|
274
|
+
iterationDelay?: number;
|
|
275
|
+
};
|
|
276
|
+
/** Looping effect, discriminated by `type`. Each effect exposes only its own parameters; all parameters are optional and fall back to tuned defaults. */
|
|
277
|
+
type LoopEffect = LoopEffect_Bounce | LoopEffect_Breathe | LoopEffect_Cross | LoopEffect_Flash | LoopEffect_Flip | LoopEffect_Fold | LoopEffect_Jello | LoopEffect_Poke | LoopEffect_Pulse | LoopEffect_Rubber | LoopEffect_Spin | LoopEffect_Swing | LoopEffect_Wiggle;
|
|
278
|
+
/** Bounces up and down in place with an elastic multi-step curve. */
|
|
279
|
+
type LoopEffect_Bounce = {
|
|
280
|
+
/**
|
|
281
|
+
* Effect type.
|
|
282
|
+
* Must be `BOUNCE`.
|
|
283
|
+
*/
|
|
284
|
+
type: 'BOUNCE'; /** Motion style. Defaults to `GENTLE`. */
|
|
285
|
+
easing?: Animation_Easing;
|
|
286
|
+
};
|
|
287
|
+
/** Scales gently in and out along an axis, as if breathing. */
|
|
288
|
+
type LoopEffect_Breathe = {
|
|
289
|
+
/**
|
|
290
|
+
* Effect type.
|
|
291
|
+
* Must be `BREATHE`.
|
|
292
|
+
*/
|
|
293
|
+
type: 'BREATHE'; /** Axis the breathing motion travels along. `CENTER` breathes in place with a 3D depth motion instead. Defaults to `VERTICAL`. */
|
|
294
|
+
direction?: LoopEffect_Breathe_Direction;
|
|
295
|
+
};
|
|
296
|
+
type LoopEffect_Breathe_Direction = 'HORIZONTAL' | 'VERTICAL' | 'CENTER';
|
|
297
|
+
declare const LoopEffect_Breathe_Direction: {
|
|
298
|
+
readonly HORIZONTAL: 'HORIZONTAL';
|
|
299
|
+
readonly VERTICAL: 'VERTICAL';
|
|
300
|
+
readonly CENTER: 'CENTER';
|
|
301
|
+
};
|
|
302
|
+
/** Drifts across its container toward one side, then re-enters from the opposite side. */
|
|
303
|
+
type LoopEffect_Cross = {
|
|
304
|
+
/**
|
|
305
|
+
* Effect type.
|
|
306
|
+
* Must be `CROSS`.
|
|
307
|
+
*/
|
|
308
|
+
type: 'CROSS'; /** Side the element drifts toward. Defaults to `RIGHT`. */
|
|
309
|
+
direction?: Animation_SideDirection;
|
|
310
|
+
};
|
|
311
|
+
/** Fades out to fully transparent and back in. */
|
|
312
|
+
type LoopEffect_Flash = {
|
|
313
|
+
/**
|
|
314
|
+
* Effect type.
|
|
315
|
+
* Must be `FLASH`.
|
|
316
|
+
*/
|
|
317
|
+
type: 'FLASH';
|
|
318
|
+
};
|
|
319
|
+
/** Rotates a full turn around its horizontal or vertical axis in 3D. */
|
|
320
|
+
type LoopEffect_Flip = {
|
|
321
|
+
/**
|
|
322
|
+
* Effect type.
|
|
323
|
+
* Must be `FLIP`.
|
|
324
|
+
*/
|
|
325
|
+
type: 'FLIP'; /** Axis the element flips around. Defaults to `HORIZONTAL`. */
|
|
326
|
+
direction?: Animation_Orientation; /** Motion style. Defaults to `GENTLE`. */
|
|
327
|
+
easing?: Animation_Easing;
|
|
328
|
+
};
|
|
329
|
+
/** Folds back and forth around a hinged edge in 3D. */
|
|
330
|
+
type LoopEffect_Fold = {
|
|
331
|
+
/**
|
|
332
|
+
* Effect type.
|
|
333
|
+
* Must be `FOLD`.
|
|
334
|
+
*/
|
|
335
|
+
type: 'FOLD'; /** Edge the element is hinged on. Defaults to `TOP`. */
|
|
336
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `MODERATE`. */
|
|
337
|
+
easing?: Animation_Easing;
|
|
338
|
+
};
|
|
339
|
+
/** Wobbles with a jelly-like skew that settles gradually. */
|
|
340
|
+
type LoopEffect_Jello = {
|
|
341
|
+
/**
|
|
342
|
+
* Effect type.
|
|
343
|
+
* Must be `JELLO`.
|
|
344
|
+
*/
|
|
345
|
+
type: 'JELLO'; /** Motion style. Defaults to `GENTLE`. */
|
|
346
|
+
easing?: Animation_Easing;
|
|
347
|
+
};
|
|
348
|
+
/** Nudges repeatedly toward a direction and springs back. */
|
|
349
|
+
type LoopEffect_Poke = {
|
|
350
|
+
/**
|
|
351
|
+
* Effect type.
|
|
352
|
+
* Must be `POKE`.
|
|
353
|
+
*/
|
|
354
|
+
type: 'POKE'; /** Direction the element pokes toward. Defaults to `RIGHT`. */
|
|
355
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `MODERATE`. */
|
|
356
|
+
easing?: Animation_Easing;
|
|
357
|
+
};
|
|
358
|
+
/** Scales up and back down rhythmically. */
|
|
359
|
+
type LoopEffect_Pulse = {
|
|
360
|
+
/**
|
|
361
|
+
* Effect type.
|
|
362
|
+
* Must be `PULSE`.
|
|
363
|
+
*/
|
|
364
|
+
type: 'PULSE'; /** Motion style. Defaults to `GENTLE`. */
|
|
365
|
+
easing?: Animation_Easing;
|
|
366
|
+
};
|
|
367
|
+
/** Stretches and squashes like a rubber band. */
|
|
368
|
+
type LoopEffect_Rubber = {
|
|
369
|
+
/**
|
|
370
|
+
* Effect type.
|
|
371
|
+
* Must be `RUBBER`.
|
|
372
|
+
*/
|
|
373
|
+
type: 'RUBBER'; /** Motion style. Defaults to `GENTLE`. */
|
|
374
|
+
easing?: Animation_Easing;
|
|
375
|
+
};
|
|
376
|
+
/** Rotates continuously around its center. */
|
|
377
|
+
type LoopEffect_Spin = {
|
|
378
|
+
/**
|
|
379
|
+
* Effect type.
|
|
380
|
+
* Must be `SPIN`.
|
|
381
|
+
*/
|
|
382
|
+
type: 'SPIN'; /** Rotation direction. Defaults to `CLOCKWISE`. */
|
|
383
|
+
direction?: Animation_SpinDirection; /** Motion style. Defaults to `GENTLE`. */
|
|
384
|
+
easing?: Animation_Easing;
|
|
385
|
+
};
|
|
386
|
+
/** Swings back and forth around an edge pivot, like a hanging sign. */
|
|
387
|
+
type LoopEffect_Swing = {
|
|
388
|
+
/**
|
|
389
|
+
* Effect type.
|
|
390
|
+
* Must be `SWING`.
|
|
391
|
+
*/
|
|
392
|
+
type: 'SWING'; /** Edge the element swings from. Defaults to `TOP`. */
|
|
393
|
+
direction?: Animation_Direction; /** Motion style. Defaults to `GENTLE`. */
|
|
394
|
+
easing?: Animation_Easing;
|
|
395
|
+
};
|
|
396
|
+
/** Rocks side to side with a quick, accumulating rotation. */
|
|
397
|
+
type LoopEffect_Wiggle = {
|
|
398
|
+
/**
|
|
399
|
+
* Effect type.
|
|
400
|
+
* Must be `WIGGLE`.
|
|
401
|
+
*/
|
|
402
|
+
type: 'WIGGLE'; /** Motion style. Defaults to `GENTLE`. */
|
|
403
|
+
easing?: Animation_Easing;
|
|
404
|
+
};
|
|
405
|
+
/** Mouse effect, discriminated by `type`. Each effect exposes only its own parameters; all parameters are optional and fall back to tuned defaults. */
|
|
406
|
+
type PointerEffect = PointerEffect_Airy | PointerEffect_Blob | PointerEffect_Blur | PointerEffect_Scale | PointerEffect_Skew | PointerEffect_Swivel | PointerEffect_Tilt3d | PointerEffect_Track | PointerEffect_Track3d;
|
|
407
|
+
/** Drifts loosely after the pointer with a light, floating rotation. */
|
|
408
|
+
type PointerEffect_Airy = {
|
|
409
|
+
/**
|
|
410
|
+
* Effect type.
|
|
411
|
+
* Must be `AIRY`.
|
|
412
|
+
*/
|
|
413
|
+
type: 'AIRY'; /** Moves away from the pointer instead of toward it. Defaults to `false`. */
|
|
414
|
+
inverted?: boolean; /** Axis the movement is constrained to. Defaults to `BOTH`. */
|
|
415
|
+
axis?: Animation_Axis; /** Motion style. Defaults to `MODERATE`. */
|
|
416
|
+
easing?: Animation_Easing;
|
|
417
|
+
};
|
|
418
|
+
/** Squashes and stretches toward the pointer like a soft blob. */
|
|
419
|
+
type PointerEffect_Blob = {
|
|
420
|
+
/**
|
|
421
|
+
* Effect type.
|
|
422
|
+
* Must be `BLOB`.
|
|
423
|
+
*/
|
|
424
|
+
type: 'BLOB'; /** Moves away from the pointer instead of toward it. Defaults to `false`. */
|
|
425
|
+
inverted?: boolean; /** Motion style. Defaults to `MODERATE`. */
|
|
426
|
+
easing?: Animation_Easing;
|
|
427
|
+
};
|
|
428
|
+
/** Shifts after the pointer while blurring, like a motion trail. */
|
|
429
|
+
type PointerEffect_Blur = {
|
|
430
|
+
/**
|
|
431
|
+
* Effect type.
|
|
432
|
+
* Must be `BLUR`.
|
|
433
|
+
*/
|
|
434
|
+
type: 'BLUR'; /** Moves away from the pointer instead of toward it. Defaults to `false`. */
|
|
435
|
+
inverted?: boolean; /** Motion style. Defaults to `MODERATE`. */
|
|
436
|
+
easing?: Animation_Easing;
|
|
437
|
+
};
|
|
438
|
+
/** Scales as the pointer approaches, shrinking or growing around its center. */
|
|
439
|
+
type PointerEffect_Scale = {
|
|
440
|
+
/**
|
|
441
|
+
* Effect type.
|
|
442
|
+
* Must be `SCALE`.
|
|
443
|
+
*/
|
|
444
|
+
type: 'SCALE'; /** Reacts away from the pointer instead of toward it. Defaults to `false`. */
|
|
445
|
+
inverted?: boolean; /** Axis the movement is constrained to. Defaults to `HORIZONTAL`. */
|
|
446
|
+
axis?: Animation_Axis; /** Whether the node grows or shrinks as the pointer nears. Defaults to `DOWN`. */
|
|
447
|
+
direction?: PointerEffect_Scale_Direction; /** Motion style. Defaults to `MODERATE`. */
|
|
448
|
+
easing?: Animation_Easing;
|
|
449
|
+
};
|
|
450
|
+
type PointerEffect_Scale_Direction = 'UP' | 'DOWN';
|
|
451
|
+
declare const PointerEffect_Scale_Direction: {
|
|
452
|
+
readonly UP: 'UP';
|
|
453
|
+
readonly DOWN: 'DOWN';
|
|
454
|
+
};
|
|
455
|
+
/** Skews toward the pointer, shearing the node as it moves. */
|
|
456
|
+
type PointerEffect_Skew = {
|
|
457
|
+
/**
|
|
458
|
+
* Effect type.
|
|
459
|
+
* Must be `SKEW`.
|
|
460
|
+
*/
|
|
461
|
+
type: 'SKEW'; /** Skews away from the pointer instead of toward it. Defaults to `true`. */
|
|
462
|
+
inverted?: boolean; /** Axis the movement is constrained to. Defaults to `BOTH`. */
|
|
463
|
+
axis?: Animation_Axis; /** Motion style. Defaults to `MODERATE`. */
|
|
464
|
+
easing?: Animation_Easing;
|
|
465
|
+
};
|
|
466
|
+
/** Rotates around a pivot edge or axis, following the pointer like a hinged panel. */
|
|
467
|
+
type PointerEffect_Swivel = {
|
|
468
|
+
/**
|
|
469
|
+
* Effect type.
|
|
470
|
+
* Must be `SWIVEL`.
|
|
471
|
+
*/
|
|
472
|
+
type: 'SWIVEL'; /** Swivels away from the pointer instead of toward it. Defaults to `false`. */
|
|
473
|
+
inverted?: boolean; /** Pivot the node swivels around — an edge or a center axis. Defaults to `TOP`. */
|
|
474
|
+
axis?: PointerEffect_Swivel_Axis; /** Motion style. Defaults to `MODERATE`. */
|
|
475
|
+
easing?: Animation_Easing;
|
|
476
|
+
};
|
|
477
|
+
type PointerEffect_Swivel_Axis = 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'CENTER_HORIZONTAL' | 'CENTER_VERTICAL';
|
|
478
|
+
declare const PointerEffect_Swivel_Axis: {
|
|
479
|
+
readonly TOP: 'TOP';
|
|
480
|
+
readonly BOTTOM: 'BOTTOM';
|
|
481
|
+
readonly LEFT: 'LEFT';
|
|
482
|
+
readonly RIGHT: 'RIGHT';
|
|
483
|
+
readonly CENTER_HORIZONTAL: 'CENTER_HORIZONTAL';
|
|
484
|
+
readonly CENTER_VERTICAL: 'CENTER_VERTICAL';
|
|
485
|
+
};
|
|
486
|
+
/** Tilts in 3D perspective toward the pointer, like a card catching the light. */
|
|
487
|
+
type PointerEffect_Tilt3d = {
|
|
488
|
+
/**
|
|
489
|
+
* Effect type.
|
|
490
|
+
* Must be `TILT_3D`.
|
|
491
|
+
*/
|
|
492
|
+
type: 'TILT_3D'; /** Tilts away from the pointer instead of toward it. Defaults to `false`. */
|
|
493
|
+
inverted?: boolean; /** Motion style. Defaults to `MODERATE`. */
|
|
494
|
+
easing?: Animation_Easing;
|
|
495
|
+
};
|
|
496
|
+
/** Follows the pointer's position with a smooth translation. */
|
|
497
|
+
type PointerEffect_Track = {
|
|
498
|
+
/**
|
|
499
|
+
* Effect type.
|
|
500
|
+
* Must be `TRACK`.
|
|
501
|
+
*/
|
|
502
|
+
type: 'TRACK'; /** Moves away from the pointer instead of following it. Defaults to `false`. */
|
|
503
|
+
inverted?: boolean; /** Axis the movement is constrained to. Defaults to `BOTH`. */
|
|
504
|
+
axis?: Animation_Axis; /** Motion style. Defaults to `MODERATE`. */
|
|
505
|
+
easing?: Animation_Easing;
|
|
506
|
+
};
|
|
507
|
+
/** Follows the pointer with a 3D depth motion, rotating slightly in perspective. */
|
|
508
|
+
type PointerEffect_Track3d = {
|
|
509
|
+
/**
|
|
510
|
+
* Effect type.
|
|
511
|
+
* Must be `TRACK_3D`.
|
|
512
|
+
*/
|
|
513
|
+
type: 'TRACK_3D'; /** Moves away from the pointer instead of following it. Defaults to `true`. */
|
|
514
|
+
inverted?: boolean; /** Axis the movement is constrained to. Defaults to `HORIZONTAL`. */
|
|
515
|
+
axis?: Animation_Axis; /** Motion style. Defaults to `MODERATE`. */
|
|
516
|
+
easing?: Animation_Easing;
|
|
517
|
+
};
|
|
518
|
+
type Animation_Direction = 'LEFT' | 'RIGHT' | 'TOP' | 'BOTTOM';
|
|
519
|
+
declare const Animation_Direction: {
|
|
520
|
+
readonly LEFT: 'LEFT';
|
|
521
|
+
readonly RIGHT: 'RIGHT';
|
|
522
|
+
readonly TOP: 'TOP';
|
|
523
|
+
readonly BOTTOM: 'BOTTOM';
|
|
524
|
+
};
|
|
525
|
+
type Animation_Axis = 'HORIZONTAL' | 'VERTICAL' | 'BOTH';
|
|
526
|
+
declare const Animation_Axis: {
|
|
527
|
+
readonly HORIZONTAL: 'HORIZONTAL';
|
|
528
|
+
readonly VERTICAL: 'VERTICAL';
|
|
529
|
+
readonly BOTH: 'BOTH';
|
|
530
|
+
};
|
|
531
|
+
type Animation_RadialDirection = 'RIGHT' | 'TOP_RIGHT' | 'TOP' | 'TOP_LEFT' | 'LEFT' | 'BOTTOM_LEFT' | 'BOTTOM' | 'BOTTOM_RIGHT' | 'CENTER';
|
|
532
|
+
declare const Animation_RadialDirection: {
|
|
533
|
+
readonly RIGHT: 'RIGHT';
|
|
534
|
+
readonly TOP_RIGHT: 'TOP_RIGHT';
|
|
535
|
+
readonly TOP: 'TOP';
|
|
536
|
+
readonly TOP_LEFT: 'TOP_LEFT';
|
|
537
|
+
readonly LEFT: 'LEFT';
|
|
538
|
+
readonly BOTTOM_LEFT: 'BOTTOM_LEFT';
|
|
539
|
+
readonly BOTTOM: 'BOTTOM';
|
|
540
|
+
readonly BOTTOM_RIGHT: 'BOTTOM_RIGHT';
|
|
541
|
+
readonly CENTER: 'CENTER';
|
|
542
|
+
};
|
|
543
|
+
type Animation_SideDirection = 'LEFT' | 'RIGHT';
|
|
544
|
+
declare const Animation_SideDirection: {
|
|
545
|
+
readonly LEFT: 'LEFT';
|
|
546
|
+
readonly RIGHT: 'RIGHT';
|
|
547
|
+
};
|
|
548
|
+
type Animation_CornerDirection = 'TOP_LEFT' | 'BOTTOM_LEFT' | 'TOP_RIGHT' | 'BOTTOM_RIGHT';
|
|
549
|
+
declare const Animation_CornerDirection: {
|
|
550
|
+
readonly TOP_LEFT: 'TOP_LEFT';
|
|
551
|
+
readonly BOTTOM_LEFT: 'BOTTOM_LEFT';
|
|
552
|
+
readonly TOP_RIGHT: 'TOP_RIGHT';
|
|
553
|
+
readonly BOTTOM_RIGHT: 'BOTTOM_RIGHT';
|
|
554
|
+
};
|
|
555
|
+
type Animation_Orientation = 'HORIZONTAL' | 'VERTICAL';
|
|
556
|
+
declare const Animation_Orientation: {
|
|
557
|
+
readonly HORIZONTAL: 'HORIZONTAL';
|
|
558
|
+
readonly VERTICAL: 'VERTICAL';
|
|
559
|
+
};
|
|
560
|
+
type Animation_SpinDirection = 'CLOCKWISE' | 'COUNTER_CLOCKWISE';
|
|
561
|
+
declare const Animation_SpinDirection: {
|
|
562
|
+
readonly CLOCKWISE: 'CLOCKWISE';
|
|
563
|
+
readonly COUNTER_CLOCKWISE: 'COUNTER_CLOCKWISE';
|
|
564
|
+
};
|
|
565
|
+
type Animation_Easing = 'GENTLE' | 'MODERATE' | 'INTENSE';
|
|
566
|
+
declare const Animation_Easing: {
|
|
567
|
+
readonly GENTLE: 'GENTLE';
|
|
568
|
+
readonly MODERATE: 'MODERATE';
|
|
569
|
+
readonly INTENSE: 'INTENSE';
|
|
570
|
+
};
|
|
571
|
+
type TextStyle = {
|
|
572
|
+
/** Text alignment. Supported values: <br> - `AUTO`: Text aligns itself automatically. <br> - `LEFT`: Text is aligned to the left. <br> - `RIGHT`: Text is aligned to the right. <br> - `CENTER`: Text is centered. <br> - `JUSTIFY`: Text is justified to both margins. <br> Default: `AUTO`. */textAlignment?: TextStyle_TextAlignment; /** Vertical spacing between lines of text in an element. */
|
|
573
|
+
lineHeight?: string;
|
|
574
|
+
/**
|
|
575
|
+
* Font size of an empty block: it sizes the empty line, its list marker and the text typed into it. Ignored on a block with text, which is sized by its text's `FONT_SIZE` decorations.
|
|
576
|
+
* **Note:** This property requires the `fontSize` plugin to be enabled.
|
|
577
|
+
*/
|
|
578
|
+
fontSize?: FontSizeData;
|
|
579
|
+
};
|
|
580
|
+
type TextStyle_TextAlignment = 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
581
|
+
declare const TextStyle_TextAlignment: {
|
|
582
|
+
readonly AUTO: 'AUTO';
|
|
583
|
+
readonly LEFT: 'LEFT';
|
|
584
|
+
readonly RIGHT: 'RIGHT';
|
|
585
|
+
readonly CENTER: 'CENTER';
|
|
586
|
+
readonly JUSTIFY: 'JUSTIFY';
|
|
587
|
+
};
|
|
588
|
+
/** Link object. */
|
|
589
|
+
type Link$1 = {
|
|
590
|
+
/** Absolute URL to link to. */url?: string; /** Target [Node ID](#node-ids) to link to. */
|
|
591
|
+
anchor?: string; /** The HTML `target` attribute value for the link. This property defines where the link opens. <br> Supported values: <br> `SELF` - Opens the link in the same frame.<br> `BLANK` - Opens the link in a new browser tab or window.<br> `PARENT` - Opens the link in the parent frame.<br> `TOP` - Opens the link in the full body of the link's browser tab or window. <br> Default: `SELF` */
|
|
592
|
+
target?: Link_Target; /** Relationship between the current document and the linked document. */
|
|
593
|
+
rel?: Link_Rel; /** A serialized object used for a custom or external link panel. */
|
|
594
|
+
customData?: string;
|
|
595
|
+
};
|
|
596
|
+
type Link_Target = 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
597
|
+
declare const Link_Target: {
|
|
598
|
+
readonly SELF: 'SELF';
|
|
599
|
+
readonly BLANK: 'BLANK';
|
|
600
|
+
readonly PARENT: 'PARENT';
|
|
601
|
+
readonly TOP: 'TOP';
|
|
602
|
+
};
|
|
603
|
+
type Link_Rel = {
|
|
604
|
+
/**
|
|
605
|
+
* Indicates to search engine crawlers not to follow the link.
|
|
606
|
+
* Default: `false`
|
|
607
|
+
*/
|
|
608
|
+
nofollow?: boolean;
|
|
609
|
+
/**
|
|
610
|
+
* Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement.
|
|
611
|
+
* Default: `false`
|
|
612
|
+
*/
|
|
613
|
+
sponsored?: boolean;
|
|
614
|
+
/**
|
|
615
|
+
* Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page author.
|
|
616
|
+
* Default: `false`
|
|
617
|
+
*/
|
|
618
|
+
ugc?: boolean; /** Indicates that this link protects referral information from being passed to the target website. */
|
|
619
|
+
noreferrer?: boolean;
|
|
620
|
+
};
|
|
621
|
+
/** File source object. */
|
|
622
|
+
type FileSource = {
|
|
623
|
+
/** File source URL. */url?: string; /** ID that's resolved to a URL by a resolver function. */
|
|
624
|
+
id?: string;
|
|
625
|
+
/**
|
|
626
|
+
* Whether the file's source is private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) in Wix.
|
|
627
|
+
* Default: `false`
|
|
628
|
+
*/
|
|
629
|
+
private?: boolean;
|
|
630
|
+
};
|
|
631
|
+
type Media = {
|
|
632
|
+
/** File source. */src: FileSource; /** Media width in pixels. */
|
|
633
|
+
width?: number; /** Media height in pixels. */
|
|
634
|
+
height?: number; /** Media duration in seconds. Only relevant for audio and video files. */
|
|
635
|
+
duration?: number;
|
|
636
|
+
};
|
|
637
|
+
type VerticalAlignment = 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
638
|
+
declare const VerticalAlignment: {
|
|
639
|
+
readonly TOP: 'TOP';
|
|
640
|
+
readonly MIDDLE: 'MIDDLE';
|
|
641
|
+
readonly BOTTOM: 'BOTTOM';
|
|
642
|
+
};
|
|
643
|
+
type BackgroundImage = {
|
|
644
|
+
/** Background image. */media?: Media; /** Color or gradient drawn on top of the image. When present, this is the authoritative overlay and `opacity` is ignored. Its presence also marks content as authored under the new overlay model (vs. the legacy `opacity`-based dimming on `background`/`backdrop`). */
|
|
645
|
+
overlay?: Background; /** Deprecated: use `overlay` instead. Legacy image opacity (0–100) that dimmed the image to reveal the `background`/`backdrop` color behind it. */
|
|
646
|
+
opacity?: number; /** Background image scaling. */
|
|
647
|
+
scaling?: ImageScaling; /** Position of background. Defaults to `CENTER`. */
|
|
648
|
+
position?: ImagePosition; /** Blur radius in pixels applied to the image layer. `0` (default) leaves the image unblurred; blur is independent of any color overlay and the two stack. */
|
|
649
|
+
blur?: number;
|
|
650
|
+
};
|
|
651
|
+
type ImageScaling = 'AUTO' | 'CONTAIN' | 'COVER';
|
|
652
|
+
declare const ImageScaling: {
|
|
653
|
+
readonly AUTO: 'AUTO';
|
|
654
|
+
readonly CONTAIN: 'CONTAIN';
|
|
655
|
+
readonly COVER: 'COVER';
|
|
656
|
+
};
|
|
657
|
+
type ImagePosition = 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
658
|
+
declare const ImagePosition: {
|
|
659
|
+
readonly CENTER: 'CENTER';
|
|
660
|
+
readonly CENTER_LEFT: 'CENTER_LEFT';
|
|
661
|
+
readonly CENTER_RIGHT: 'CENTER_RIGHT';
|
|
662
|
+
readonly TOP: 'TOP';
|
|
663
|
+
readonly TOP_LEFT: 'TOP_LEFT';
|
|
664
|
+
readonly TOP_RIGHT: 'TOP_RIGHT';
|
|
665
|
+
readonly BOTTOM: 'BOTTOM';
|
|
666
|
+
readonly BOTTOM_LEFT: 'BOTTOM_LEFT';
|
|
667
|
+
readonly BOTTOM_RIGHT: 'BOTTOM_RIGHT';
|
|
668
|
+
};
|
|
669
|
+
/** Gradient configuration. Either linear or radial. */
|
|
670
|
+
type Gradient = Gradient_Linear | Gradient_Radial;
|
|
671
|
+
/** Background styling. Either a solid color or gradient. */
|
|
672
|
+
type Background = Background_ColorVariant | Background_GradientVariant;
|
|
673
|
+
type Background_ColorVariant = {
|
|
674
|
+
type: 'COLOR'; /** Background color as a hexadecimal value. */
|
|
675
|
+
color: string;
|
|
676
|
+
};
|
|
677
|
+
type Background_GradientVariant = {
|
|
678
|
+
type: 'GRADIENT'; /** Gradient configuration. */
|
|
679
|
+
gradient: Gradient;
|
|
680
|
+
};
|
|
681
|
+
type Gradient_Linear = {
|
|
682
|
+
type: 'LINEAR';
|
|
683
|
+
stops: Gradient_Stop[];
|
|
684
|
+
/**
|
|
685
|
+
* Angle in degrees for linear gradient (0-360).
|
|
686
|
+
* Default: `90`
|
|
687
|
+
*/
|
|
688
|
+
angle?: number;
|
|
689
|
+
};
|
|
690
|
+
type Gradient_Radial = {
|
|
691
|
+
type: 'RADIAL';
|
|
692
|
+
stops: Gradient_Stop[];
|
|
693
|
+
/**
|
|
694
|
+
* Horizontal center position (0-100).
|
|
695
|
+
* Default: `50`
|
|
696
|
+
*/
|
|
697
|
+
centerX?: number;
|
|
698
|
+
/**
|
|
699
|
+
* Vertical center position (0-100).
|
|
700
|
+
* Default: `50`
|
|
701
|
+
*/
|
|
702
|
+
centerY?: number;
|
|
703
|
+
};
|
|
704
|
+
type Gradient_Stop = {
|
|
705
|
+
/** Stop color as a hexadecimal value. */color?: string;
|
|
706
|
+
/**
|
|
707
|
+
* Stop position (0-1).
|
|
708
|
+
* Default: `0`
|
|
709
|
+
*/
|
|
710
|
+
position?: number;
|
|
711
|
+
};
|
|
712
|
+
type PluginContainerData = {
|
|
713
|
+
/** Node display width. */width?: PluginContainerData_Width; /** Node alignment in its container. */
|
|
714
|
+
alignment?: PluginContainerData_Alignment; /** Spoiler cover settings. */
|
|
715
|
+
spoiler?: PluginContainerData_Spoiler; /** Node display height. */
|
|
716
|
+
height?: PluginContainerData_Height;
|
|
717
|
+
/**
|
|
718
|
+
* Whether the text should wrap around the node when it's displayed. If `textWrap` is `false`, the node fills the width of its container.
|
|
719
|
+
* Default: `true` for all node types except `DIVIDER`.
|
|
720
|
+
*/
|
|
721
|
+
textWrap?: boolean;
|
|
722
|
+
};
|
|
723
|
+
type PluginContainerData_Alignment = 'CENTER' | 'LEFT' | 'RIGHT';
|
|
724
|
+
declare const PluginContainerData_Alignment: {
|
|
725
|
+
readonly CENTER: 'CENTER';
|
|
726
|
+
readonly LEFT: 'LEFT';
|
|
727
|
+
readonly RIGHT: 'RIGHT';
|
|
728
|
+
};
|
|
729
|
+
type PluginContainerData_Spoiler = {
|
|
730
|
+
/**
|
|
731
|
+
* Whether the spoiler cover is enabled.
|
|
732
|
+
* Default: `false`
|
|
733
|
+
*/
|
|
734
|
+
enabled?: boolean; /** Text displayed on the spoiler cover. */
|
|
735
|
+
description?: string; /** Text that appears on the button that removes the spoiler cover. */
|
|
736
|
+
buttonText?: string;
|
|
737
|
+
};
|
|
738
|
+
/** Node display width. */
|
|
739
|
+
type PluginContainerData_Width = {
|
|
740
|
+
/**
|
|
741
|
+
* Width of a node in a container. Supported values:
|
|
742
|
+
* - `CONTENT`: Width of the container matches the content width.
|
|
743
|
+
* - `SMALL`: Small width.
|
|
744
|
+
* - `ORIGINAL`: Width of the container matches the original image width. **Note:** This value is only applicable for `imageData` containers.
|
|
745
|
+
* `FULL_WIDTH`: Image container takes up the full width of the screen. **Note:** This value is only applicable for `imageData` containers.
|
|
746
|
+
*/
|
|
747
|
+
size?: PluginContainerData_Width_Type; /** A custom width value in pixels. */
|
|
748
|
+
custom?: string;
|
|
749
|
+
};
|
|
750
|
+
type PluginContainerData_Width_Type = 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
751
|
+
declare const PluginContainerData_Width_Type: {
|
|
752
|
+
readonly CONTENT: 'CONTENT';
|
|
753
|
+
readonly SMALL: 'SMALL';
|
|
754
|
+
readonly ORIGINAL: 'ORIGINAL';
|
|
755
|
+
readonly FULL_WIDTH: 'FULL_WIDTH';
|
|
756
|
+
};
|
|
757
|
+
type PluginContainerData_Height = {
|
|
758
|
+
/** Node display height in pixels. */custom?: string;
|
|
759
|
+
};
|
|
760
|
+
type Decoration = BoldDecoration | ItalicDecoration | UnderlineDecoration | SpoilerDecoration | AnchorDecoration | MentionDecoration | LinkDecoration | ColorDecoration | FontSizeDecoration | StrikethroughDecoration | SuperscriptDecoration | SubscriptDecoration | FontFamilyDecoration | SketchDecoration;
|
|
761
|
+
/** Bolds text, which makes it appear thicker and more prominent than normal text. */
|
|
762
|
+
type BoldDecoration = {
|
|
763
|
+
/**
|
|
764
|
+
* Decoration type.
|
|
765
|
+
* Must be `BOLD`.
|
|
766
|
+
*/
|
|
767
|
+
type: 'BOLD'; /** Font weight. */
|
|
768
|
+
fontWeightValue?: number;
|
|
769
|
+
};
|
|
770
|
+
/** Italicizes text, which makes it appear slanted or italicized. Italics are typically used for emphasis, citations, or to distinguish certain types of content. */
|
|
771
|
+
type ItalicDecoration = {
|
|
772
|
+
/**
|
|
773
|
+
* Decoration type.
|
|
774
|
+
* Must be `ITALIC`.
|
|
775
|
+
*/
|
|
776
|
+
type: 'ITALIC'; /** Whether to enable the italic text. */
|
|
777
|
+
italicData?: boolean;
|
|
778
|
+
};
|
|
779
|
+
/** Underlines text. */
|
|
780
|
+
type UnderlineDecoration = {
|
|
781
|
+
/**
|
|
782
|
+
* Decoration type.
|
|
783
|
+
* Must be `UNDERLINE`.
|
|
784
|
+
*/
|
|
785
|
+
type: 'UNDERLINE'; /** Whether to underline the text. */
|
|
786
|
+
underlineData?: boolean;
|
|
787
|
+
};
|
|
788
|
+
/** Strikes-through text. */
|
|
789
|
+
type StrikethroughDecoration = {
|
|
790
|
+
/**
|
|
791
|
+
* Decoration type.
|
|
792
|
+
* Must be `STRIKETHROUGH`.
|
|
793
|
+
*/
|
|
794
|
+
type: 'STRIKETHROUGH'; /** Whether to strikethrough the text. Default: `true`. */
|
|
795
|
+
strikethroughData?: boolean;
|
|
796
|
+
};
|
|
797
|
+
/** Makes text appear smaller and raised above the baseline. */
|
|
798
|
+
type SuperscriptDecoration = {
|
|
799
|
+
/**
|
|
800
|
+
* Decoration type.
|
|
801
|
+
* Must be `SUPERSCRIPT`.
|
|
802
|
+
*/
|
|
803
|
+
type: 'SUPERSCRIPT'; /** Whether to make the text appear smaller and raised above the baseline. */
|
|
804
|
+
superscriptData?: boolean;
|
|
805
|
+
};
|
|
806
|
+
/** Makes text appear smaller and lowered below the baseline. */
|
|
807
|
+
type SubscriptDecoration = {
|
|
808
|
+
/**
|
|
809
|
+
* Decoration type.
|
|
810
|
+
* Must be `SUBSCRIPT`.
|
|
811
|
+
*/
|
|
812
|
+
type: 'SUBSCRIPT'; /** Whether to make the text appear smaller and lowered below the baseline. */
|
|
813
|
+
subscriptData?: boolean;
|
|
814
|
+
};
|
|
815
|
+
/** Blurs text. <br> **Note:** This decoration requires the [`spoiler`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled. */
|
|
816
|
+
type SpoilerDecoration = {
|
|
817
|
+
/**
|
|
818
|
+
* Decoration type.
|
|
819
|
+
* Must be `SPOILER`.
|
|
820
|
+
*/
|
|
821
|
+
type: 'SPOILER'; /** Spoiler details. */
|
|
822
|
+
spoilerData?: SpoilerData;
|
|
823
|
+
};
|
|
824
|
+
/** Makes clickable text a different color. The link navigates to another section of the same page. */
|
|
825
|
+
type AnchorDecoration = {
|
|
826
|
+
/**
|
|
827
|
+
* Decoration type.
|
|
828
|
+
* Must be `ANCHOR`.
|
|
829
|
+
*/
|
|
830
|
+
type: 'ANCHOR'; /** Anchor details. */
|
|
831
|
+
anchorData?: AnchorData;
|
|
832
|
+
};
|
|
833
|
+
/** Text that mentions a specific user, often in social media platforms, forums, or content management systems. <br> **Note:** This decoration requires the [`mention`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled. */
|
|
834
|
+
type MentionDecoration = {
|
|
835
|
+
/**
|
|
836
|
+
* Decoration type.
|
|
837
|
+
* Must be `MENTION`.
|
|
838
|
+
*/
|
|
839
|
+
type: 'MENTION'; /** Anchor details. */
|
|
840
|
+
mentionData?: MentionData;
|
|
841
|
+
};
|
|
842
|
+
/** Makes clickable text a different color. The link navigates to another webpage or resource. <br> **Note:** This decoration requires the [`link`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled. */
|
|
843
|
+
type LinkDecoration = {
|
|
844
|
+
/**
|
|
845
|
+
* Decoration type.
|
|
846
|
+
* Must be `LINK`.
|
|
847
|
+
*/
|
|
848
|
+
type: 'LINK'; /** Link details. */
|
|
849
|
+
linkData?: LinkData;
|
|
850
|
+
};
|
|
851
|
+
/** Styles text using background and text colors. <br> **Note:** This decoration requires the [`colorDecoration`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled. */
|
|
852
|
+
type ColorDecoration = {
|
|
853
|
+
/**
|
|
854
|
+
* Decoration type.
|
|
855
|
+
* Value: `COLOR`
|
|
856
|
+
*/
|
|
857
|
+
type: 'COLOR'; /** Color details. */
|
|
858
|
+
colorData?: ColorData;
|
|
859
|
+
};
|
|
860
|
+
/** Text font size. */
|
|
861
|
+
type FontSizeDecoration = {
|
|
862
|
+
/**
|
|
863
|
+
* Decoration type.
|
|
864
|
+
* Must be `FONT_SIZE`.
|
|
865
|
+
*/
|
|
866
|
+
type: 'FONT_SIZE'; /** Font size details. */
|
|
867
|
+
fontSizeData?: FontSizeData;
|
|
868
|
+
};
|
|
869
|
+
type AnchorData = {
|
|
870
|
+
/** Target Node ID to redirect to. */anchor?: string;
|
|
871
|
+
};
|
|
872
|
+
type ColorData = {
|
|
873
|
+
/** Deprecated: Use `backgroundStyle` instead. Background color as a hexadecimal value. */background?: string; /** Deprecated: Use `foregroundStyle` instead. Text color as a hexadecimal value. */
|
|
874
|
+
foreground?: string; /** Text fill styling (color or gradient). When present, takes precedence over `foreground`. */
|
|
875
|
+
foregroundStyle?: Background; /** Text background (highlight) styling (color or gradient). When present, takes precedence over `background`. */
|
|
876
|
+
backgroundStyle?: Background;
|
|
877
|
+
};
|
|
878
|
+
type LinkData = {
|
|
879
|
+
/** Link object. */link?: Link$1;
|
|
880
|
+
};
|
|
881
|
+
type MentionData = {
|
|
882
|
+
/** Display name of the mentioned user. */name?: string; /** Username of the mentioned user. This is th text that appears after the "@". */
|
|
883
|
+
slug?: string; /** ID of the mentioned user. */
|
|
884
|
+
id?: string; /** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
|
|
885
|
+
type?: string;
|
|
886
|
+
};
|
|
887
|
+
type FontSizeData = {
|
|
888
|
+
/** Font size value. */value: number;
|
|
889
|
+
/**
|
|
890
|
+
* Font size units.
|
|
891
|
+
* Default: `PX`
|
|
892
|
+
*/
|
|
893
|
+
unit?: FontSizeData_fontType;
|
|
894
|
+
};
|
|
895
|
+
type FontSizeData_fontType = 'PX' | 'EM';
|
|
896
|
+
declare const FontSizeData_fontType: {
|
|
897
|
+
readonly PX: 'PX';
|
|
898
|
+
readonly EM: 'EM';
|
|
899
|
+
};
|
|
900
|
+
/** Text font family. */
|
|
901
|
+
type FontFamilyDecoration = {
|
|
902
|
+
/**
|
|
903
|
+
* Decoration type.
|
|
904
|
+
* Must be `FONT_FAMILY`.
|
|
905
|
+
*/
|
|
906
|
+
type: 'FONT_FAMILY'; /** Font family details. */
|
|
907
|
+
fontFamilyData?: FontFamilyData;
|
|
908
|
+
};
|
|
909
|
+
type FontFamilyData = {
|
|
910
|
+
/** Font family value. */value?: string;
|
|
911
|
+
};
|
|
912
|
+
/** Hand-drawn sketch annotation drawn over the text using rough.js. */
|
|
913
|
+
type SketchDecoration = {
|
|
914
|
+
/**
|
|
915
|
+
* Decoration type.
|
|
916
|
+
* Must be `SKETCH`.
|
|
917
|
+
*/
|
|
918
|
+
type: 'SKETCH'; /** Data for a sketch decoration. */
|
|
919
|
+
sketchData?: SketchData;
|
|
920
|
+
};
|
|
921
|
+
type SketchData = {
|
|
922
|
+
/** The sketch annotation variant to draw. */variant: SketchData_Variant; /** Annotation color. Defaults to the theme action color. */
|
|
923
|
+
color?: string; /** Whether the annotation animates on first paint. Defaults to `true`. */
|
|
924
|
+
animate?: boolean;
|
|
925
|
+
};
|
|
926
|
+
type SketchData_Variant = 'UNDERLINE' | 'BOX' | 'CIRCLE' | 'HIGHLIGHT' | 'STRIKETHROUGH' | 'CROSSED_OFF';
|
|
927
|
+
declare const SketchData_Variant: {
|
|
928
|
+
readonly UNDERLINE: 'UNDERLINE';
|
|
929
|
+
readonly BOX: 'BOX';
|
|
930
|
+
readonly CIRCLE: 'CIRCLE';
|
|
931
|
+
readonly HIGHLIGHT: 'HIGHLIGHT';
|
|
932
|
+
readonly STRIKETHROUGH: 'STRIKETHROUGH';
|
|
933
|
+
readonly CROSSED_OFF: 'CROSSED_OFF';
|
|
934
|
+
};
|
|
935
|
+
type SpoilerData = {
|
|
936
|
+
/** [Node ID](#node-ids). */id?: string;
|
|
937
|
+
};
|
|
938
|
+
/** Used to visually distinguish quoted or cited content from the surrounding text. When rendered, it displays as the quoted text with indentation or other styling to visually separate it from the surrounding content. */
|
|
939
|
+
type BlockquoteNode = {
|
|
940
|
+
/**
|
|
941
|
+
* Node type.
|
|
942
|
+
* Must be `BLOCKQUOTE`.
|
|
943
|
+
*/
|
|
944
|
+
type: 'BLOCKQUOTE'; /** Child nodes to define a blockquote paragraph. */
|
|
945
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
946
|
+
id?: string; /** Blockquote details. */
|
|
947
|
+
blockquoteData?: BlockquoteData;
|
|
948
|
+
/**
|
|
949
|
+
* Defines the blockquote style, such as padding and background color.
|
|
950
|
+
* **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled.
|
|
951
|
+
*/
|
|
952
|
+
style?: NodeStyle;
|
|
953
|
+
};
|
|
954
|
+
type BlockquoteData = {
|
|
955
|
+
/**
|
|
956
|
+
* Blockquote margin from the left side.
|
|
957
|
+
* The indentation is measured relative to the font size *em* units by a ratio of 1.5. For example, if the indentation is `2`, then the margin is equal to **3em**. Therefore the margin is 3 times the size of the font.
|
|
958
|
+
*/
|
|
959
|
+
indentation?: number;
|
|
960
|
+
/**
|
|
961
|
+
* Node animation.
|
|
962
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
963
|
+
*/
|
|
964
|
+
animation?: Animation;
|
|
965
|
+
};
|
|
966
|
+
/** Caption container to be attached to media elements, such as images. Captions support formatted text content and can be styled independently from their parent nodes. */
|
|
967
|
+
type CaptionNode = {
|
|
968
|
+
/**
|
|
969
|
+
* Node type.
|
|
970
|
+
* Must be `CAPTION`.
|
|
971
|
+
*/
|
|
972
|
+
type: 'CAPTION';
|
|
973
|
+
nodes: RicosDocumentNode[]; /** Caption [node ID](#node-ids). */
|
|
974
|
+
id?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Defines the caption styling, such as padding and background color.
|
|
977
|
+
* **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled.
|
|
978
|
+
*/
|
|
979
|
+
style?: NodeStyle; /** Caption options. */
|
|
980
|
+
captionData?: CaptionData;
|
|
981
|
+
};
|
|
982
|
+
type CaptionData = {
|
|
983
|
+
/** Caption text styling. */textStyle?: TextStyle;
|
|
984
|
+
};
|
|
985
|
+
/** A card container node that can hold any block-level content. */
|
|
986
|
+
type CardNode = {
|
|
987
|
+
/**
|
|
988
|
+
* Node type.
|
|
989
|
+
* Must be `CARD`.
|
|
990
|
+
*/
|
|
991
|
+
type: 'CARD'; /** Child nodes that the card contains. */
|
|
992
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
993
|
+
id?: string; /** Card details. */
|
|
994
|
+
cardData?: CardData;
|
|
995
|
+
};
|
|
996
|
+
type CardData = {
|
|
997
|
+
/** Background styling (color or gradient). */background?: Background; /** Background image. */
|
|
998
|
+
backgroundImage?: BackgroundImage;
|
|
999
|
+
};
|
|
1000
|
+
/** Presents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code. */
|
|
1001
|
+
type CodeBlockNode = {
|
|
1002
|
+
/**
|
|
1003
|
+
* Node type.
|
|
1004
|
+
* VMust be `CODE_BLOCK`.
|
|
1005
|
+
*/
|
|
1006
|
+
type: 'CODE_BLOCK'; /** Child nodes to define a code block text. */
|
|
1007
|
+
nodes?: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1008
|
+
id?: string; /** Code block details. */
|
|
1009
|
+
codeBlockData?: CodeBlockData;
|
|
1010
|
+
/**
|
|
1011
|
+
* Code block styling, such as padding and background color.
|
|
1012
|
+
* **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled.
|
|
1013
|
+
*/
|
|
1014
|
+
style?: NodeStyle;
|
|
1015
|
+
};
|
|
1016
|
+
type CodeBlockData = {
|
|
1017
|
+
/** Defines the text styling, such as alignment and line height. */textStyle?: TextStyle;
|
|
1018
|
+
/**
|
|
1019
|
+
* Node animation.
|
|
1020
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1021
|
+
*/
|
|
1022
|
+
animation?: Animation;
|
|
1023
|
+
};
|
|
1024
|
+
/** Indicates a heading or title of a section. There are 6 levels of headings, with `1` being the most prominent and `6` being the least. */
|
|
1025
|
+
type HeadingNode = {
|
|
1026
|
+
/**
|
|
1027
|
+
* Node type.
|
|
1028
|
+
* Must be `HEADING`.
|
|
1029
|
+
*/
|
|
1030
|
+
type: 'HEADING'; /** Child nodes to define the heading text. */
|
|
1031
|
+
nodes?: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1032
|
+
id?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Heading styling, such as padding and background color.
|
|
1035
|
+
* **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled.
|
|
1036
|
+
*/
|
|
1037
|
+
style?: NodeStyle; /** Heading options. */
|
|
1038
|
+
headingData?: HeadingData;
|
|
1039
|
+
};
|
|
1040
|
+
type HeadingData = {
|
|
1041
|
+
/** Heading size. <br> Mi: `1` <br> Max: `6` */level?: number; /** Heading text styling, such as text alignment and line height. */
|
|
1042
|
+
textStyle?: TextStyle;
|
|
1043
|
+
/**
|
|
1044
|
+
* Heading margin from the left side.
|
|
1045
|
+
* The indentation is measured relative to the font size *em* units by a ratio of 1.5. For example, if the indentation is `2`, then the margin is equal to **3em**. Therefore the margin is 3 times the size of the font.
|
|
1046
|
+
*/
|
|
1047
|
+
indentation?: number; /** Rendered heading level for SEO/accessibility. When set, overrides the HTML tag (h1-h6) while `level` still controls the visual style. */
|
|
1048
|
+
renderedLevel?: number;
|
|
1049
|
+
/**
|
|
1050
|
+
* Node animation.
|
|
1051
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1052
|
+
*/
|
|
1053
|
+
animation?: Animation;
|
|
1054
|
+
};
|
|
1055
|
+
/** Used to wrap cells in layout container. When rendered, it cells one after the other in a row */
|
|
1056
|
+
type LayoutNode = {
|
|
1057
|
+
/**
|
|
1058
|
+
* Node type.
|
|
1059
|
+
* Must be `LAYOUT`.
|
|
1060
|
+
*/
|
|
1061
|
+
type: 'LAYOUT'; /** Cell items. */
|
|
1062
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1063
|
+
id?: string; /** Layout details. */
|
|
1064
|
+
layoutData?: LayoutData;
|
|
1065
|
+
};
|
|
1066
|
+
type LayoutData = {
|
|
1067
|
+
/** Layout container styling. */containerData?: PluginContainerData; /** Deprecated: Use `background` instead. */
|
|
1068
|
+
backgroundColor?: string; /** Background styling (color or gradient). */
|
|
1069
|
+
background?: Background; /** Background image. */
|
|
1070
|
+
backgroundImage?: BackgroundImage; /** Border color as a hexadecimal value. */
|
|
1071
|
+
borderColor?: string; /** Border width in pixels. */
|
|
1072
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
1073
|
+
borderRadius?: number; /** Deprecated: Use `backdrop` instead. */
|
|
1074
|
+
backdropColor?: string; /** Backdrop styling (color or gradient). */
|
|
1075
|
+
backdrop?: Background; /** Backdrop image. */
|
|
1076
|
+
backdropImage?: BackgroundImage; /** Backdrop padding top in pixels. */
|
|
1077
|
+
backdropPaddingTop?: number; /** Backdrop padding bottom in pixels. */
|
|
1078
|
+
backdropPaddingBottom?: number; /** Horizontal and vertical gap between columns in pixels. */
|
|
1079
|
+
gap?: number; /** Responsiveness behaviour. */
|
|
1080
|
+
responsivenessBehaviour?: LayoutData_ResponsivenessBehaviour; /** Size in pixels when responsivenessBehaviour applies. */
|
|
1081
|
+
responsivenessBreakpoint?: number;
|
|
1082
|
+
cellPadding?: number[]; /** Vertical alignment for the cell's items. */
|
|
1083
|
+
cellVerticalAlignment?: VerticalAlignment; /** Defines where selected design propertied applies to. */
|
|
1084
|
+
designTarget?: LayoutData_DesignTarget; /** Placement of this layout: an edge banner, or the paywall. A layout has at most one placement, so the two can never be combined. */
|
|
1085
|
+
banner?: LayoutData_Banner; /** Shape divider at the top edge of the layout. */
|
|
1086
|
+
topDivider?: LayoutData_SectionDivider; /** Shape divider at the bottom edge of the layout. */
|
|
1087
|
+
bottomDivider?: LayoutData_SectionDivider;
|
|
1088
|
+
/**
|
|
1089
|
+
* Node animation.
|
|
1090
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1091
|
+
*/
|
|
1092
|
+
animation?: Animation;
|
|
1093
|
+
};
|
|
1094
|
+
/** Decorative shape divider at a layout edge, discriminated by shape type. Each shape allows only the customization properties it supports. */
|
|
1095
|
+
type LayoutData_SectionDivider = LayoutData_SectionDivider_Ellipse | LayoutData_SectionDivider_Tilt | LayoutData_SectionDivider_Liquid | LayoutData_SectionDivider_LeftWave | LayoutData_SectionDivider_PaintScribble | LayoutData_SectionDivider_InvertedEllipse | LayoutData_SectionDivider_RightWave | LayoutData_SectionDivider_Dunes | LayoutData_SectionDivider_Waves | LayoutData_SectionDivider_Triangle | LayoutData_SectionDivider_SemiEllipse | LayoutData_SectionDivider_Plants | LayoutData_SectionDivider_LayeredEllipse | LayoutData_SectionDivider_Pixels | LayoutData_SectionDivider_Paint | LayoutData_SectionDivider_Clouds | LayoutData_SectionDivider_OpticalIllusion | LayoutData_SectionDivider_Stripes | LayoutData_SectionDivider_Blobs | LayoutData_SectionDivider_SemiCircles | LayoutData_SectionDivider_Hill | LayoutData_SectionDivider_Brush | LayoutData_SectionDivider_Peaks | LayoutData_SectionDivider_AngledTriangle;
|
|
1096
|
+
type LayoutData_SectionDivider_Ellipse = {
|
|
1097
|
+
/**
|
|
1098
|
+
* Divider shape.
|
|
1099
|
+
* Must be `ELLIPSE`.
|
|
1100
|
+
*/
|
|
1101
|
+
type: 'ELLIPSE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1102
|
+
color?: string; /** Divider height in pixels. */
|
|
1103
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1104
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the section divider shape. */
|
|
1105
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1106
|
+
};
|
|
1107
|
+
type LayoutData_SectionDivider_Tilt = {
|
|
1108
|
+
/**
|
|
1109
|
+
* Divider shape.
|
|
1110
|
+
* Must be `TILT`.
|
|
1111
|
+
*/
|
|
1112
|
+
type: 'TILT'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1113
|
+
color?: string; /** Divider height in pixels. */
|
|
1114
|
+
height?: number; /** Whether the shape is flipped horizontally. */
|
|
1115
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1116
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1117
|
+
};
|
|
1118
|
+
type LayoutData_SectionDivider_Liquid = {
|
|
1119
|
+
/**
|
|
1120
|
+
* Divider shape.
|
|
1121
|
+
* Must be `LIQUID`.
|
|
1122
|
+
*/
|
|
1123
|
+
type: 'LIQUID'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1124
|
+
color?: string; /** Divider height in pixels. */
|
|
1125
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1126
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1127
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1128
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1129
|
+
};
|
|
1130
|
+
type LayoutData_SectionDivider_LeftWave = {
|
|
1131
|
+
/**
|
|
1132
|
+
* Divider shape.
|
|
1133
|
+
* Must be `LEFT_WAVE`.
|
|
1134
|
+
*/
|
|
1135
|
+
type: 'LEFT_WAVE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1136
|
+
color?: string; /** Divider height in pixels. */
|
|
1137
|
+
height?: number; /** Whether the shape is flipped horizontally. */
|
|
1138
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1139
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1140
|
+
};
|
|
1141
|
+
type LayoutData_SectionDivider_PaintScribble = {
|
|
1142
|
+
/**
|
|
1143
|
+
* Divider shape.
|
|
1144
|
+
* Must be `PAINT_SCRIBBLE`.
|
|
1145
|
+
*/
|
|
1146
|
+
type: 'PAINT_SCRIBBLE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1147
|
+
color?: string; /** Divider height in pixels. */
|
|
1148
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1149
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1150
|
+
flipped?: boolean;
|
|
1151
|
+
};
|
|
1152
|
+
type LayoutData_SectionDivider_InvertedEllipse = {
|
|
1153
|
+
/**
|
|
1154
|
+
* Divider shape.
|
|
1155
|
+
* Must be `INVERTED_ELLIPSE`.
|
|
1156
|
+
*/
|
|
1157
|
+
type: 'INVERTED_ELLIPSE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1158
|
+
color?: string; /** Divider height in pixels. */
|
|
1159
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1160
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1161
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1162
|
+
};
|
|
1163
|
+
type LayoutData_SectionDivider_RightWave = {
|
|
1164
|
+
/**
|
|
1165
|
+
* Divider shape.
|
|
1166
|
+
* Must be `RIGHT_WAVE`.
|
|
1167
|
+
*/
|
|
1168
|
+
type: 'RIGHT_WAVE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1169
|
+
color?: string; /** Divider height in pixels. */
|
|
1170
|
+
height?: number; /** Whether the shape is flipped horizontally. */
|
|
1171
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1172
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1173
|
+
};
|
|
1174
|
+
type LayoutData_SectionDivider_Dunes = {
|
|
1175
|
+
/**
|
|
1176
|
+
* Divider shape.
|
|
1177
|
+
* Must be `DUNES`.
|
|
1178
|
+
*/
|
|
1179
|
+
type: 'DUNES'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1180
|
+
color?: string; /** Divider height in pixels. */
|
|
1181
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1182
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1183
|
+
flipped?: boolean;
|
|
1184
|
+
};
|
|
1185
|
+
type LayoutData_SectionDivider_Waves = {
|
|
1186
|
+
/**
|
|
1187
|
+
* Divider shape.
|
|
1188
|
+
* Must be `WAVES`.
|
|
1189
|
+
*/
|
|
1190
|
+
type: 'WAVES'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1191
|
+
color?: string; /** Divider height in pixels. */
|
|
1192
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1193
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1194
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1195
|
+
};
|
|
1196
|
+
type LayoutData_SectionDivider_Triangle = {
|
|
1197
|
+
/**
|
|
1198
|
+
* Divider shape.
|
|
1199
|
+
* Must be `TRIANGLE`.
|
|
1200
|
+
*/
|
|
1201
|
+
type: 'TRIANGLE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1202
|
+
color?: string; /** Divider height in pixels. */
|
|
1203
|
+
height?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1204
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1205
|
+
};
|
|
1206
|
+
type LayoutData_SectionDivider_SemiEllipse = {
|
|
1207
|
+
/**
|
|
1208
|
+
* Divider shape.
|
|
1209
|
+
* Must be `SEMI_ELLIPSE`.
|
|
1210
|
+
*/
|
|
1211
|
+
type: 'SEMI_ELLIPSE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1212
|
+
color?: string; /** Divider height in pixels. */
|
|
1213
|
+
height?: number; /** Whether the shape is flipped horizontally. */
|
|
1214
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1215
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1216
|
+
};
|
|
1217
|
+
type LayoutData_SectionDivider_Plants = {
|
|
1218
|
+
/**
|
|
1219
|
+
* Divider shape.
|
|
1220
|
+
* Must be `PLANTS`.
|
|
1221
|
+
*/
|
|
1222
|
+
type: 'PLANTS'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1223
|
+
color?: string; /** Divider height in pixels. */
|
|
1224
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1225
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1226
|
+
flipped?: boolean;
|
|
1227
|
+
};
|
|
1228
|
+
type LayoutData_SectionDivider_LayeredEllipse = {
|
|
1229
|
+
/**
|
|
1230
|
+
* Divider shape.
|
|
1231
|
+
* Must be `LAYERED_ELLIPSE`.
|
|
1232
|
+
*/
|
|
1233
|
+
type: 'LAYERED_ELLIPSE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1234
|
+
color?: string; /** Divider height in pixels. */
|
|
1235
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1236
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1237
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1238
|
+
};
|
|
1239
|
+
type LayoutData_SectionDivider_Pixels = {
|
|
1240
|
+
/**
|
|
1241
|
+
* Divider shape.
|
|
1242
|
+
* Must be `PIXELS`.
|
|
1243
|
+
*/
|
|
1244
|
+
type: 'PIXELS'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1245
|
+
color?: string; /** Divider height in pixels. */
|
|
1246
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1247
|
+
offsetX?: number;
|
|
1248
|
+
};
|
|
1249
|
+
type LayoutData_SectionDivider_Paint = {
|
|
1250
|
+
/**
|
|
1251
|
+
* Divider shape.
|
|
1252
|
+
* Must be `PAINT`.
|
|
1253
|
+
*/
|
|
1254
|
+
type: 'PAINT'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1255
|
+
color?: string; /** Divider height in pixels. */
|
|
1256
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1257
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1258
|
+
flipped?: boolean;
|
|
1259
|
+
};
|
|
1260
|
+
type LayoutData_SectionDivider_Clouds = {
|
|
1261
|
+
/**
|
|
1262
|
+
* Divider shape.
|
|
1263
|
+
* Must be `CLOUDS`.
|
|
1264
|
+
*/
|
|
1265
|
+
type: 'CLOUDS'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1266
|
+
color?: string; /** Divider height in pixels. */
|
|
1267
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1268
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1269
|
+
flipped?: boolean;
|
|
1270
|
+
};
|
|
1271
|
+
type LayoutData_SectionDivider_OpticalIllusion = {
|
|
1272
|
+
/**
|
|
1273
|
+
* Divider shape.
|
|
1274
|
+
* Must be `OPTICAL_ILLUSION`.
|
|
1275
|
+
*/
|
|
1276
|
+
type: 'OPTICAL_ILLUSION'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1277
|
+
color?: string; /** Divider height in pixels. */
|
|
1278
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1279
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1280
|
+
flipped?: boolean;
|
|
1281
|
+
};
|
|
1282
|
+
type LayoutData_SectionDivider_Stripes = {
|
|
1283
|
+
/**
|
|
1284
|
+
* Divider shape.
|
|
1285
|
+
* Must be `STRIPES`.
|
|
1286
|
+
*/
|
|
1287
|
+
type: 'STRIPES'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1288
|
+
color?: string; /** Divider height in pixels. */
|
|
1289
|
+
height?: number; /** Whether the shape is flipped horizontally. */
|
|
1290
|
+
flipped?: boolean;
|
|
1291
|
+
};
|
|
1292
|
+
type LayoutData_SectionDivider_Blobs = {
|
|
1293
|
+
/**
|
|
1294
|
+
* Divider shape.
|
|
1295
|
+
* Must be `BLOBS`.
|
|
1296
|
+
*/
|
|
1297
|
+
type: 'BLOBS'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1298
|
+
color?: string; /** Divider height in pixels. */
|
|
1299
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1300
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1301
|
+
flipped?: boolean;
|
|
1302
|
+
};
|
|
1303
|
+
type LayoutData_SectionDivider_SemiCircles = {
|
|
1304
|
+
/**
|
|
1305
|
+
* Divider shape.
|
|
1306
|
+
* Must be `SEMI_CIRCLES`.
|
|
1307
|
+
*/
|
|
1308
|
+
type: 'SEMI_CIRCLES'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1309
|
+
color?: string; /** Divider height in pixels. */
|
|
1310
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1311
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1312
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1313
|
+
};
|
|
1314
|
+
type LayoutData_SectionDivider_Hill = {
|
|
1315
|
+
/**
|
|
1316
|
+
* Divider shape.
|
|
1317
|
+
* Must be `HILL`.
|
|
1318
|
+
*/
|
|
1319
|
+
type: 'HILL'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1320
|
+
color?: string; /** Divider height in pixels. */
|
|
1321
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1322
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1323
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1324
|
+
};
|
|
1325
|
+
type LayoutData_SectionDivider_Brush = {
|
|
1326
|
+
/**
|
|
1327
|
+
* Divider shape.
|
|
1328
|
+
* Must be `BRUSH`.
|
|
1329
|
+
*/
|
|
1330
|
+
type: 'BRUSH'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1331
|
+
color?: string; /** Divider height in pixels. */
|
|
1332
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1333
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1334
|
+
flipped?: boolean;
|
|
1335
|
+
};
|
|
1336
|
+
type LayoutData_SectionDivider_Peaks = {
|
|
1337
|
+
/**
|
|
1338
|
+
* Divider shape.
|
|
1339
|
+
* Must be `PEAKS`.
|
|
1340
|
+
*/
|
|
1341
|
+
type: 'PEAKS'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1342
|
+
color?: string; /** Divider height in pixels. */
|
|
1343
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1344
|
+
offsetX?: number; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1345
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1346
|
+
};
|
|
1347
|
+
type LayoutData_SectionDivider_AngledTriangle = {
|
|
1348
|
+
/**
|
|
1349
|
+
* Divider shape.
|
|
1350
|
+
* Must be `ANGLED_TRIANGLE`.
|
|
1351
|
+
*/
|
|
1352
|
+
type: 'ANGLED_TRIANGLE'; /** Divider fill color as a hexadecimal value (may include alpha). */
|
|
1353
|
+
color?: string; /** Divider height in pixels. */
|
|
1354
|
+
height?: number; /** Horizontal offset in pixels. */
|
|
1355
|
+
offsetX?: number; /** Whether the shape is flipped horizontally. */
|
|
1356
|
+
flipped?: boolean; /** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1357
|
+
layers?: LayoutData_SectionDividerLayers;
|
|
1358
|
+
};
|
|
1359
|
+
/** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
1360
|
+
type LayoutData_SectionDividerLayers = {
|
|
1361
|
+
/** Total number of layers including the base shape (1-4). Absent or 1 disables the effect. */count?: number; /** Vertical distance in pixels between the silhouettes of consecutive layers: each successive layer's silhouette is offset from the previous one by this amount. The divider's own `height` is unchanged. Defaults to 20. */
|
|
1362
|
+
offsetY?: number; /** Horizontal distance between consecutive layers in pixels. Defaults to 0. Only applies to shapes that support horizontal offset. */
|
|
1363
|
+
offsetX?: number; /** How the stacked layers fade relative to the base shape. Absent means CENTER. */
|
|
1364
|
+
layerEffect?: LayoutData_SectionDividerLayersLayerEffect;
|
|
1365
|
+
};
|
|
1366
|
+
type LayoutData_SectionDividerLayersLayerEffect = 'CENTER' | 'FADE_TO_TOP' | 'FADE_TO_BOTTOM';
|
|
1367
|
+
declare const LayoutData_SectionDividerLayersLayerEffect: {
|
|
1368
|
+
readonly CENTER: 'CENTER';
|
|
1369
|
+
readonly FADE_TO_TOP: 'FADE_TO_TOP';
|
|
1370
|
+
readonly FADE_TO_BOTTOM: 'FADE_TO_BOTTOM';
|
|
1371
|
+
};
|
|
1372
|
+
/** Where this layout sits, discriminated by position. `TOP` and `BOTTOM` attach it to a document or card edge; `PAYWALL` makes it the cut between free and paid content. One field, so a layout is exactly one of them. */
|
|
1373
|
+
type LayoutData_Banner = LayoutData_Banner_Top | LayoutData_Banner_Bottom | LayoutData_Banner_Paywall;
|
|
1374
|
+
/** Banner placement: attached to the top edge of the document or card. */
|
|
1375
|
+
type LayoutData_Banner_Top = {
|
|
1376
|
+
/**
|
|
1377
|
+
* Edge position.
|
|
1378
|
+
* Must be `TOP`.
|
|
1379
|
+
*/
|
|
1380
|
+
position: 'TOP'; /** Origin of the banner - whether it was created from an image or a layout. */
|
|
1381
|
+
origin?: LayoutData_BannerOrigin;
|
|
1382
|
+
};
|
|
1383
|
+
/** Footer placement: attached to the bottom edge of the document or card. */
|
|
1384
|
+
type LayoutData_Banner_Bottom = {
|
|
1385
|
+
/**
|
|
1386
|
+
* Edge position.
|
|
1387
|
+
* Must be `BOTTOM`.
|
|
1388
|
+
*/
|
|
1389
|
+
position: 'BOTTOM'; /** Origin of the banner - whether it was created from an image or a layout. */
|
|
1390
|
+
origin?: LayoutData_BannerOrigin;
|
|
1391
|
+
};
|
|
1392
|
+
/** Paywall placement: the layout is the cut between free and paid content. It carries every layout feature but no edge, so it has no `origin` and can never be a banner. */
|
|
1393
|
+
type LayoutData_Banner_Paywall = {
|
|
1394
|
+
/**
|
|
1395
|
+
* Edge position.
|
|
1396
|
+
* Must be `PAYWALL`.
|
|
1397
|
+
*/
|
|
1398
|
+
position: 'PAYWALL';
|
|
1399
|
+
};
|
|
1400
|
+
type LayoutData_BannerOrigin = 'IMAGE' | 'LAYOUT';
|
|
1401
|
+
declare const LayoutData_BannerOrigin: {
|
|
1402
|
+
readonly IMAGE: 'IMAGE';
|
|
1403
|
+
readonly LAYOUT: 'LAYOUT';
|
|
1404
|
+
};
|
|
1405
|
+
type LayoutData_ResponsivenessBehaviour = 'STACK' | 'WRAP';
|
|
1406
|
+
declare const LayoutData_ResponsivenessBehaviour: {
|
|
1407
|
+
readonly STACK: 'STACK';
|
|
1408
|
+
readonly WRAP: 'WRAP';
|
|
1409
|
+
};
|
|
1410
|
+
type LayoutData_DesignTarget = 'LAYOUT' | 'CELL';
|
|
1411
|
+
declare const LayoutData_DesignTarget: {
|
|
1412
|
+
readonly LAYOUT: 'LAYOUT';
|
|
1413
|
+
readonly CELL: 'CELL';
|
|
1414
|
+
};
|
|
1415
|
+
/** Used to wrap content inside layout container. When rendered, it shows content inside layout column */
|
|
1416
|
+
type LayoutCellNode = {
|
|
1417
|
+
/**
|
|
1418
|
+
* Node type.
|
|
1419
|
+
* Must be `LAYOUT_CELL`.
|
|
1420
|
+
*/
|
|
1421
|
+
type: 'LAYOUT_CELL'; /** Child nodes that the cell item contains. */
|
|
1422
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1423
|
+
id?: string; /** Layout Cell details. */
|
|
1424
|
+
layoutCellData?: LayoutCellData;
|
|
1425
|
+
};
|
|
1426
|
+
type LayoutCellData = {
|
|
1427
|
+
/** Defines how many columns cell spans inside 12 column grid. If not provided it will divide remaining space equally. */colSpan?: number;
|
|
1428
|
+
};
|
|
1429
|
+
/** Numbered list. */
|
|
1430
|
+
type OrderedListNode = {
|
|
1431
|
+
/**
|
|
1432
|
+
* Node type.
|
|
1433
|
+
* Must be `ORDERED_LIST`.
|
|
1434
|
+
*/
|
|
1435
|
+
type: 'ORDERED_LIST'; /** List items. */
|
|
1436
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1437
|
+
id?: string; /** Ordered list details. */
|
|
1438
|
+
orderedListData?: OrderedListData;
|
|
1439
|
+
};
|
|
1440
|
+
type OrderedListData = {
|
|
1441
|
+
/**
|
|
1442
|
+
* List margin from the left side.
|
|
1443
|
+
* The indentation is measured relative to the font size *em* units by a ratio of 1.5. For example, if the indentation is `2`, then the margin is equal to **3em**. Therefore the margin is 3 times the size of the font.
|
|
1444
|
+
*/
|
|
1445
|
+
indentation?: number; /** Additional indentation of a list node. When offset is `0`, the list node appears at its default nesting level. Higher values cause increased indentation. */
|
|
1446
|
+
offset?: number; /** Number at the top of the numbered list. <br> Default: `1` */
|
|
1447
|
+
start?: number;
|
|
1448
|
+
/**
|
|
1449
|
+
* Node animation.
|
|
1450
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1451
|
+
*/
|
|
1452
|
+
animation?: Animation;
|
|
1453
|
+
};
|
|
1454
|
+
/** Bulleted list. */
|
|
1455
|
+
type BulletedListNode = {
|
|
1456
|
+
/**
|
|
1457
|
+
* Node type.
|
|
1458
|
+
* Must be `BULLETED_LIST`.
|
|
1459
|
+
*/
|
|
1460
|
+
type: 'BULLETED_LIST'; /** List items. */
|
|
1461
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1462
|
+
id?: string; /** Bulleted list details. */
|
|
1463
|
+
bulletedListData?: BulletedListData;
|
|
1464
|
+
};
|
|
1465
|
+
type BulletedListData = {
|
|
1466
|
+
indentation?: number; /** Additional indentation of a list node. When offset is `0`, the list node appears at its default nesting level. Higher values cause increased indentation. */
|
|
1467
|
+
offset?: number;
|
|
1468
|
+
/**
|
|
1469
|
+
* Node animation.
|
|
1470
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1471
|
+
*/
|
|
1472
|
+
animation?: Animation;
|
|
1473
|
+
};
|
|
1474
|
+
/** Checkbox list. */
|
|
1475
|
+
type CheckboxListNode = {
|
|
1476
|
+
/**
|
|
1477
|
+
* Node type.
|
|
1478
|
+
* Must be `CHECKBOX_LIST`.
|
|
1479
|
+
*/
|
|
1480
|
+
type: 'CHECKBOX_LIST'; /** List items. */
|
|
1481
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1482
|
+
id?: string; /** Checkbox list details. */
|
|
1483
|
+
checkboxListData?: CheckboxListData;
|
|
1484
|
+
};
|
|
1485
|
+
type CheckboxListData = {
|
|
1486
|
+
indentation?: number; /** Additional indentation of a list node. When offset is `0`, the list node appears at its default nesting level. Higher values cause increased indentation. */
|
|
1487
|
+
offset?: number;
|
|
1488
|
+
/**
|
|
1489
|
+
* Node animation.
|
|
1490
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1491
|
+
*/
|
|
1492
|
+
animation?: Animation;
|
|
1493
|
+
};
|
|
1494
|
+
type ListItemNode = {
|
|
1495
|
+
/**
|
|
1496
|
+
* Node type.
|
|
1497
|
+
* Value: `LIST_ITEM`
|
|
1498
|
+
*/
|
|
1499
|
+
type: 'LIST_ITEM'; /** Child nodes that the list item contains. */
|
|
1500
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1501
|
+
id?: string; /** List item details. */
|
|
1502
|
+
listItemData?: ListItemNodeData;
|
|
1503
|
+
};
|
|
1504
|
+
type ListItemNodeData = {
|
|
1505
|
+
/** Checkbox list item state. <br> Default: `false` */checked?: boolean;
|
|
1506
|
+
/**
|
|
1507
|
+
* Node animation.
|
|
1508
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1509
|
+
*/
|
|
1510
|
+
animation?: Animation;
|
|
1511
|
+
};
|
|
1512
|
+
/** Structures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content. */
|
|
1513
|
+
type ParagraphNode = {
|
|
1514
|
+
/**
|
|
1515
|
+
* Node type.
|
|
1516
|
+
* Must be `PARAGRAPH`.
|
|
1517
|
+
*/
|
|
1518
|
+
type: 'PARAGRAPH'; /** Paragraph children. */
|
|
1519
|
+
nodes?: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1520
|
+
id?: string;
|
|
1521
|
+
/**
|
|
1522
|
+
* Vertical padding.
|
|
1523
|
+
* **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled.
|
|
1524
|
+
*/
|
|
1525
|
+
style?: NodeStyle; /** Paragraph node attributes. */
|
|
1526
|
+
paragraphData?: ParagraphData;
|
|
1527
|
+
};
|
|
1528
|
+
type ParagraphData = {
|
|
1529
|
+
/** Paragraph text styling. */textStyle?: TextStyle;
|
|
1530
|
+
/**
|
|
1531
|
+
* Paragraph margin from the left side.
|
|
1532
|
+
* The indentation is measured relative to 40px. For example, if the indentation is `2`, then the margin is equal to **80px**.
|
|
1533
|
+
*/
|
|
1534
|
+
indentation?: number; /** Paragraph level for future different paragraphs. */
|
|
1535
|
+
level?: number;
|
|
1536
|
+
/**
|
|
1537
|
+
* Node animation.
|
|
1538
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1539
|
+
*/
|
|
1540
|
+
animation?: Animation;
|
|
1541
|
+
};
|
|
1542
|
+
/** Text nodes hold the text itself, similar to how `span` tags hold text in HTML. Text nodes can't be nested and must contain a non-empty string. Their appearance and behavior can be modified using [decorations](#decorations). */
|
|
1543
|
+
type TextNode = {
|
|
1544
|
+
/**
|
|
1545
|
+
* Node type.
|
|
1546
|
+
* Must be `TEXT`.
|
|
1547
|
+
*/
|
|
1548
|
+
type: 'TEXT'; /** Text options. */
|
|
1549
|
+
textData: TextData; /** [Node ID](#node-ids). */
|
|
1550
|
+
id?: string;
|
|
1551
|
+
nodes?: RicosDocumentNode[];
|
|
1552
|
+
};
|
|
1553
|
+
type TextData = {
|
|
1554
|
+
/** Non-empty string to display as text. */text: string;
|
|
1555
|
+
decorations?: Decoration[];
|
|
1556
|
+
};
|
|
1557
|
+
/** Embeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps. */
|
|
1558
|
+
type AppEmbedNode = {
|
|
1559
|
+
/**
|
|
1560
|
+
* Node type.
|
|
1561
|
+
* Must be `APP_EMBED`.
|
|
1562
|
+
*/
|
|
1563
|
+
type: 'APP_EMBED'; /** Embedded Wix app. */
|
|
1564
|
+
appEmbedData: AppEmbedData; /** [Node ID](#node-ids). */
|
|
1565
|
+
id?: string;
|
|
1566
|
+
nodes?: RicosDocumentNode[];
|
|
1567
|
+
};
|
|
1568
|
+
type AppEmbedData = AppEmbedDataProduct | AppEmbedDataEvent | AppEmbedDataBooking;
|
|
1569
|
+
/** Embedded a product from Wix Stores. */
|
|
1570
|
+
type AppEmbedDataProduct = {
|
|
1571
|
+
/** Must be `PRODUCT`. */type: 'PRODUCT'; /** Embedded content name. */
|
|
1572
|
+
name: string; /** Embedded content URL. */
|
|
1573
|
+
url: string; /** App embed container styling. */
|
|
1574
|
+
containerData?: PluginContainerData; /** Embedded content thumbnail. */
|
|
1575
|
+
image?: Media; /** Embedded content ID. */
|
|
1576
|
+
itemId?: string; /** Deprecated: Use `image` instead. */
|
|
1577
|
+
imageSrc?: string; /** Whether to hide the image. */
|
|
1578
|
+
hideImage?: boolean; /** Whether to hide the title. */
|
|
1579
|
+
hideTitle?: boolean; /** Whether to hide the price. */
|
|
1580
|
+
hidePrice?: boolean; /** Whether to hide the button. */
|
|
1581
|
+
hideButton?: boolean; /** Whether to hide the ribbon. */
|
|
1582
|
+
hideRibbon?: boolean; /** Button styling options. */
|
|
1583
|
+
buttonStyles?: AppEmbedData_ButtonStyles; /** Image styling options. */
|
|
1584
|
+
imageStyles?: AppEmbedData_ImageStyles; /** Ribbon styling options. */
|
|
1585
|
+
ribbonStyles?: AppEmbedData_RibbonStyles; /** Card styling options. */
|
|
1586
|
+
cardStyles?: AppEmbedData_CardStyles; /** Pricing information for the embedded content. */
|
|
1587
|
+
pricingData?: AppEmbedData_PricingData;
|
|
1588
|
+
/**
|
|
1589
|
+
* Node animation.
|
|
1590
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1591
|
+
*/
|
|
1592
|
+
animation?: Animation;
|
|
1593
|
+
};
|
|
1594
|
+
/** Embeds an event from Wix Events. */
|
|
1595
|
+
type AppEmbedDataEvent = {
|
|
1596
|
+
/** Must be `EVENT`. */type: 'EVENT'; /** Embedded content name. */
|
|
1597
|
+
name: string; /** Embedded content URL. */
|
|
1598
|
+
url: string; /** App embed container styling. */
|
|
1599
|
+
containerData?: PluginContainerData; /** Embedded event content. */
|
|
1600
|
+
eventData?: AppEmbedData_EventData; /** Embedded content thumbnail. */
|
|
1601
|
+
image?: Media; /** Embedded content ID. */
|
|
1602
|
+
itemId?: string; /** Deprecated: Use `image` instead. */
|
|
1603
|
+
imageSrc?: string; /** Whether to hide the image. */
|
|
1604
|
+
hideImage?: boolean; /** Whether to hide the title. */
|
|
1605
|
+
hideTitle?: boolean; /** Whether to hide the price. */
|
|
1606
|
+
hidePrice?: boolean; /** Whether to hide the description. */
|
|
1607
|
+
hideDescription?: boolean; /** Whether to hide the date and time. */
|
|
1608
|
+
hideDateTime?: boolean; /** Whether to hide the location. */
|
|
1609
|
+
hideLocation?: boolean; /** Whether to hide the button. */
|
|
1610
|
+
hideButton?: boolean; /** Whether to hide the ribbon. */
|
|
1611
|
+
hideRibbon?: boolean; /** Button styling options. */
|
|
1612
|
+
buttonStyles?: AppEmbedData_ButtonStyles; /** Image styling options. */
|
|
1613
|
+
imageStyles?: AppEmbedData_ImageStyles; /** Ribbon styling options. */
|
|
1614
|
+
ribbonStyles?: AppEmbedData_RibbonStyles; /** Card styling options. */
|
|
1615
|
+
cardStyles?: AppEmbedData_CardStyles; /** Pricing information for the embedded content. */
|
|
1616
|
+
pricingData?: AppEmbedData_PricingData;
|
|
1617
|
+
/**
|
|
1618
|
+
* Node animation.
|
|
1619
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1620
|
+
*/
|
|
1621
|
+
animation?: Animation;
|
|
1622
|
+
};
|
|
1623
|
+
/** Embeds a booking from Wix Bookings. */
|
|
1624
|
+
type AppEmbedDataBooking = {
|
|
1625
|
+
type: 'BOOKING'; /** Embedded content name. */
|
|
1626
|
+
name: string; /** Embedded content URL. */
|
|
1627
|
+
url: string; /** App embed container styling. */
|
|
1628
|
+
containerData?: PluginContainerData; /** Embedded content thumbnail. */
|
|
1629
|
+
image?: Media; /** Embedded content ID. */
|
|
1630
|
+
itemId?: string; /** Embedded booking content. */
|
|
1631
|
+
bookingData?: AppEmbedData_BookingData; /** Deprecated: Use `image` instead. */
|
|
1632
|
+
imageSrc?: string; /** Whether to hide the image. */
|
|
1633
|
+
hideImage?: boolean; /** Whether to hide the title. */
|
|
1634
|
+
hideTitle?: boolean; /** Whether to hide the price. */
|
|
1635
|
+
hidePrice?: boolean; /** Whether to hide the description. */
|
|
1636
|
+
hideDescription?: boolean; /** Whether to hide the duration. */
|
|
1637
|
+
hideDuration?: boolean; /** Whether to hide the location. */
|
|
1638
|
+
hideLocation?: boolean; /** Whether to hide the button. */
|
|
1639
|
+
hideButton?: boolean; /** Whether to hide the ribbon. */
|
|
1640
|
+
hideRibbon?: boolean; /** Button styling options. */
|
|
1641
|
+
buttonStyles?: AppEmbedData_ButtonStyles; /** Image styling options. */
|
|
1642
|
+
imageStyles?: AppEmbedData_ImageStyles; /** Ribbon styling options. */
|
|
1643
|
+
ribbonStyles?: AppEmbedData_RibbonStyles; /** Card styling options. */
|
|
1644
|
+
cardStyles?: AppEmbedData_CardStyles; /** Pricing information for the embedded content. */
|
|
1645
|
+
pricingData?: AppEmbedData_PricingData;
|
|
1646
|
+
/**
|
|
1647
|
+
* Node animation.
|
|
1648
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1649
|
+
*/
|
|
1650
|
+
animation?: Animation;
|
|
1651
|
+
};
|
|
1652
|
+
type AppEmbedData_BookingData = {
|
|
1653
|
+
/** Booking duration in minutes. */durations?: string;
|
|
1654
|
+
};
|
|
1655
|
+
type AppEmbedData_EventData = {
|
|
1656
|
+
/** Event schedule. */scheduling?: string; /** Event location. */
|
|
1657
|
+
location?: string;
|
|
1658
|
+
};
|
|
1659
|
+
type AppEmbedData_ButtonStyles = {
|
|
1660
|
+
/** Text to display on the button. */buttonText?: string; /** Border width in pixels. */
|
|
1661
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
1662
|
+
borderRadius?: number; /** Border color as a hexadecimal value. */
|
|
1663
|
+
borderColor?: string; /** Text color as a hexadecimal value. */
|
|
1664
|
+
textColor?: string; /** Background color as a hexadecimal value. */
|
|
1665
|
+
backgroundColor?: string; /** Border color as a hexadecimal value (hover state). */
|
|
1666
|
+
borderColorHover?: string; /** Text color as a hexadecimal value (hover state). */
|
|
1667
|
+
textColorHover?: string; /** Background color as a hexadecimal value (hover state). */
|
|
1668
|
+
backgroundColorHover?: string; /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1669
|
+
buttonSize?: string;
|
|
1670
|
+
};
|
|
1671
|
+
type AppEmbedData_ImageStyles = {
|
|
1672
|
+
/** Position of image. Defaults to `START`. */imagePosition?: AppEmbedData_ImageStyles_Position; /** Aspect ratio for the image. Defaults to `SQUARE`. */
|
|
1673
|
+
aspectRatio?: AppEmbedData_ImageStyles_AspectRatio; /** How the image should be resized. Defaults to `FILL`. */
|
|
1674
|
+
resizing?: AppEmbedData_ImageStyles_Resizing; /** Image border color as a hexadecimal value. */
|
|
1675
|
+
borderColor?: string; /** Image border width in pixels. */
|
|
1676
|
+
borderWidth?: number; /** Image border radius in pixels. */
|
|
1677
|
+
borderRadius?: number;
|
|
1678
|
+
};
|
|
1679
|
+
type AppEmbedData_ImageStyles_Position = 'START' | 'END' | 'TOP';
|
|
1680
|
+
declare const AppEmbedData_ImageStyles_Position: {
|
|
1681
|
+
readonly START: 'START';
|
|
1682
|
+
readonly END: 'END';
|
|
1683
|
+
readonly TOP: 'TOP';
|
|
1684
|
+
};
|
|
1685
|
+
type AppEmbedData_ImageStyles_AspectRatio = 'SQUARE' | 'RECTANGLE';
|
|
1686
|
+
declare const AppEmbedData_ImageStyles_AspectRatio: {
|
|
1687
|
+
readonly SQUARE: 'SQUARE';
|
|
1688
|
+
readonly RECTANGLE: 'RECTANGLE';
|
|
1689
|
+
};
|
|
1690
|
+
type AppEmbedData_ImageStyles_Resizing = 'FILL' | 'FIT';
|
|
1691
|
+
declare const AppEmbedData_ImageStyles_Resizing: {
|
|
1692
|
+
readonly FILL: 'FILL';
|
|
1693
|
+
readonly FIT: 'FIT';
|
|
1694
|
+
};
|
|
1695
|
+
type AppEmbedData_RibbonStyles = {
|
|
1696
|
+
/** Text to display on the ribbon. */ribbonText?: string; /** Placement of the ribbon. Defaults to `IMAGE`. */
|
|
1697
|
+
ribbonPlacement?: AppEmbedData_RibbonStyles_Placement; /** Ribbon background color as a hexadecimal value. */
|
|
1698
|
+
backgroundColor?: string; /** Ribbon text color as a hexadecimal value. */
|
|
1699
|
+
textColor?: string; /** Ribbon border color as a hexadecimal value. */
|
|
1700
|
+
borderColor?: string; /** Ribbon border width in pixels. */
|
|
1701
|
+
borderWidth?: number; /** Ribbon border radius in pixels. */
|
|
1702
|
+
borderRadius?: number;
|
|
1703
|
+
};
|
|
1704
|
+
type AppEmbedData_RibbonStyles_Placement = 'IMAGE' | 'PRODUCT_INFO';
|
|
1705
|
+
declare const AppEmbedData_RibbonStyles_Placement: {
|
|
1706
|
+
readonly IMAGE: 'IMAGE';
|
|
1707
|
+
readonly PRODUCT_INFO: 'PRODUCT_INFO';
|
|
1708
|
+
};
|
|
1709
|
+
type AppEmbedData_CardStyles = {
|
|
1710
|
+
/** Card background color as a hexadecimal value. */backgroundColor?: string; /** Card border color as a hexadecimal value. */
|
|
1711
|
+
borderColor?: string; /** Card border width in pixels. */
|
|
1712
|
+
borderWidth?: number; /** Card border radius in pixels. */
|
|
1713
|
+
borderRadius?: number; /** Card type. Defaults to `CONTAINED`. */
|
|
1714
|
+
type?: AppEmbedData_CardStyles_Type; /** Content alignment. Defaults to `START`. */
|
|
1715
|
+
alignment?: AppEmbedData_CardStyles_Alignment; /** Layout for title and price. Defaults to `STACKED`. */
|
|
1716
|
+
titlePriceLayout?: AppEmbedData_CardStyles_Layout; /** Title text color as a hexadecimal value. */
|
|
1717
|
+
titleColor?: string; /** Text color as a hexadecimal value. */
|
|
1718
|
+
textColor?: string;
|
|
1719
|
+
};
|
|
1720
|
+
type AppEmbedData_CardStyles_Type = 'CONTAINED' | 'FRAMELESS';
|
|
1721
|
+
declare const AppEmbedData_CardStyles_Type: {
|
|
1722
|
+
readonly CONTAINED: 'CONTAINED';
|
|
1723
|
+
readonly FRAMELESS: 'FRAMELESS';
|
|
1724
|
+
};
|
|
1725
|
+
type AppEmbedData_CardStyles_Alignment = 'START' | 'CENTER' | 'END';
|
|
1726
|
+
declare const AppEmbedData_CardStyles_Alignment: {
|
|
1727
|
+
readonly START: 'START';
|
|
1728
|
+
readonly CENTER: 'CENTER';
|
|
1729
|
+
readonly END: 'END';
|
|
1730
|
+
};
|
|
1731
|
+
/** Layout options for arranging elements. */
|
|
1732
|
+
type AppEmbedData_CardStyles_Layout = 'STACKED' | 'SIDE_BY_SIDE';
|
|
1733
|
+
type AppEmbedData_PricingData = {
|
|
1734
|
+
/** Minimum numeric price value as string (e.g., "10.99"). */valueFrom?: string; /** Maximum numeric price value as string (e.g., "19.99"). */
|
|
1735
|
+
valueTo?: string; /** Numeric price value as string after discount application (e.g., "15.99"). */
|
|
1736
|
+
discountedValue?: string; /** Currency of the value in ISO 4217 format (e.g., "USD", "EUR"). */
|
|
1737
|
+
currency?: string; /** Pricing plan ID. */
|
|
1738
|
+
pricingPlanId?: string;
|
|
1739
|
+
};
|
|
1740
|
+
/** Embeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio. */
|
|
1741
|
+
type AudioNode = {
|
|
1742
|
+
/**
|
|
1743
|
+
* Node type.
|
|
1744
|
+
* Must be `AUDIO`.
|
|
1745
|
+
*/
|
|
1746
|
+
type: 'AUDIO'; /** Audio details. */
|
|
1747
|
+
audioData: AudioData; /** [Node ID](#node-ids). */
|
|
1748
|
+
id?: string;
|
|
1749
|
+
nodes?: RicosDocumentNode[];
|
|
1750
|
+
};
|
|
1751
|
+
type AudioData = {
|
|
1752
|
+
/** Audio node container styling. */containerData?: PluginContainerData; /** Audio file details. */
|
|
1753
|
+
audio?: Media;
|
|
1754
|
+
/**
|
|
1755
|
+
* Whether the audio download button is disabled.
|
|
1756
|
+
* Default: `false`
|
|
1757
|
+
*/
|
|
1758
|
+
disableDownload?: boolean; /** Cover image. */
|
|
1759
|
+
coverImage?: Media; /** Track name. */
|
|
1760
|
+
name?: string; /** Author name. */
|
|
1761
|
+
authorName?: string; /** HTML version of the audio node. */
|
|
1762
|
+
html?: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* Node animation.
|
|
1765
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1766
|
+
*/
|
|
1767
|
+
animation?: Animation;
|
|
1768
|
+
};
|
|
1769
|
+
/** Button to trigger an action. */
|
|
1770
|
+
type ButtonNode = {
|
|
1771
|
+
/**
|
|
1772
|
+
* Node type.
|
|
1773
|
+
* Must be `BUTTON`
|
|
1774
|
+
*/
|
|
1775
|
+
type: 'BUTTON'; /** Button details. */
|
|
1776
|
+
buttonData: ButtonData; /** [Node ID](#node-ids). */
|
|
1777
|
+
id?: string;
|
|
1778
|
+
nodes?: RicosDocumentNode[];
|
|
1779
|
+
};
|
|
1780
|
+
type ButtonData = {
|
|
1781
|
+
/** Button type. Supported values: <br> - `LINK`: Redirects to a webpage. <br> - `ACTION`: Performs an action. */type: ButtonData_Type; /** Button text. */
|
|
1782
|
+
text: string; /** Button container styling. */
|
|
1783
|
+
containerData?: PluginContainerData; /** Button styling. */
|
|
1784
|
+
styles?: ButtonData_Styles; /** Button link details. */
|
|
1785
|
+
link?: Link$1;
|
|
1786
|
+
/**
|
|
1787
|
+
* Node animation.
|
|
1788
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1789
|
+
*/
|
|
1790
|
+
animation?: Animation;
|
|
1791
|
+
};
|
|
1792
|
+
type ButtonData_Type = 'LINK' | 'ACTION';
|
|
1793
|
+
declare const ButtonData_Type: {
|
|
1794
|
+
readonly LINK: 'LINK';
|
|
1795
|
+
readonly ACTION: 'ACTION';
|
|
1796
|
+
};
|
|
1797
|
+
type ButtonData_Styles = {
|
|
1798
|
+
/** Deprecated: Use `borderWidth` and `borderRadius` instead. */border?: ButtonData_Styles_Border; /** Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead. */
|
|
1799
|
+
colors?: ButtonData_Styles_Colors; /** Border width in pixels. */
|
|
1800
|
+
borderWidth?: number; /** Deprecated: Use `borderWidth` for normal/hover states instead. */
|
|
1801
|
+
borderWidthHover?: number; /** Border radius in pixels. */
|
|
1802
|
+
borderRadius?: number; /** Border color as a hexadecimal value. */
|
|
1803
|
+
borderColor?: string; /** Border color as a hexadecimal value (hover state). */
|
|
1804
|
+
borderColorHover?: string; /** Text color as a hexadecimal value. */
|
|
1805
|
+
textColor?: string; /** Text color as a hexadecimal value (hover state). */
|
|
1806
|
+
textColorHover?: string; /** Deprecated: Use `background` instead. */
|
|
1807
|
+
backgroundColor?: string; /** Deprecated: Use `backgroundHover` instead. */
|
|
1808
|
+
backgroundColorHover?: string; /** Background styling (color or gradient). */
|
|
1809
|
+
background?: Background; /** Background styling for hover state (color or gradient). */
|
|
1810
|
+
backgroundHover?: Background; /** Button size. Defaults to `MEDIUM`. */
|
|
1811
|
+
buttonSize?: ButtonData_Styles_ButtonSize;
|
|
1812
|
+
};
|
|
1813
|
+
type ButtonData_Styles_ButtonSize = 'MEDIUM' | 'SMALL' | 'LARGE';
|
|
1814
|
+
declare const ButtonData_Styles_ButtonSize: {
|
|
1815
|
+
readonly MEDIUM: 'MEDIUM';
|
|
1816
|
+
readonly SMALL: 'SMALL';
|
|
1817
|
+
readonly LARGE: 'LARGE';
|
|
1818
|
+
};
|
|
1819
|
+
type ButtonData_Styles_Colors = {
|
|
1820
|
+
/** Deprecated: Use `textColor` in `styles` instead. */text?: string; /** Deprecated: Use `borderColor` in `styles` instead. */
|
|
1821
|
+
border?: string; /** Deprecated: Use `backgroundColor` in `styles` instead. */
|
|
1822
|
+
background?: string;
|
|
1823
|
+
};
|
|
1824
|
+
type ButtonData_Styles_Border = {
|
|
1825
|
+
/** Deprecated: Use `borderWidth` in `styles` instead. */width?: number; /** Deprecated: Use `borderRadius` in `styles` instead */
|
|
1826
|
+
radius?: number;
|
|
1827
|
+
};
|
|
1828
|
+
/** List of items where each item can be expanded or collapsed. */
|
|
1829
|
+
type CollapsibleListNode = {
|
|
1830
|
+
/**
|
|
1831
|
+
* Node type.
|
|
1832
|
+
* Must be `COLLAPSIBLE_LIST`
|
|
1833
|
+
*/
|
|
1834
|
+
type: 'COLLAPSIBLE_LIST'; /** Collapsible list child nodes. */
|
|
1835
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1836
|
+
id?: string; /** Collapsible list details. */
|
|
1837
|
+
collapsibleListData?: CollapsibleListData;
|
|
1838
|
+
};
|
|
1839
|
+
type CollapsibleListData = {
|
|
1840
|
+
/** Collapsible list container styling. */containerData?: PluginContainerData;
|
|
1841
|
+
/**
|
|
1842
|
+
* Whether only one item can be expanded at a time.
|
|
1843
|
+
* Default: `false`.
|
|
1844
|
+
*/
|
|
1845
|
+
expandOnlyOne?: boolean; /** Sets which items are automatically expanded after the page loads. */
|
|
1846
|
+
initialExpandedItems?: CollapsibleListData_InitialExpandedItems;
|
|
1847
|
+
/**
|
|
1848
|
+
* Direction of the text in the list. Supported values:
|
|
1849
|
+
* - `LTR`: Left to right.
|
|
1850
|
+
* - `RTL`: Right to left.
|
|
1851
|
+
*/
|
|
1852
|
+
direction?: CollapsibleListData_Direction; /** Whether the collapsible item will appear in search results as an FAQ. */
|
|
1853
|
+
isQapageData?: boolean;
|
|
1854
|
+
/**
|
|
1855
|
+
* Node animation.
|
|
1856
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1857
|
+
*/
|
|
1858
|
+
animation?: Animation;
|
|
1859
|
+
};
|
|
1860
|
+
type CollapsibleListData_InitialExpandedItems = 'FIRST' | 'ALL' | 'NONE';
|
|
1861
|
+
declare const CollapsibleListData_InitialExpandedItems: {
|
|
1862
|
+
readonly FIRST: 'FIRST';
|
|
1863
|
+
readonly ALL: 'ALL';
|
|
1864
|
+
readonly NONE: 'NONE';
|
|
1865
|
+
};
|
|
1866
|
+
type CollapsibleListData_Direction = 'LTR' | 'RTL';
|
|
1867
|
+
declare const CollapsibleListData_Direction: {
|
|
1868
|
+
readonly LTR: 'LTR';
|
|
1869
|
+
readonly RTL: 'RTL';
|
|
1870
|
+
};
|
|
1871
|
+
type CollapsibleItemNode = {
|
|
1872
|
+
/**
|
|
1873
|
+
* Node type.
|
|
1874
|
+
* Must be `COLLAPSIBLE_ITEM`
|
|
1875
|
+
*/
|
|
1876
|
+
type: 'COLLAPSIBLE_ITEM'; /** Collapsible list item. */
|
|
1877
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1878
|
+
id?: string;
|
|
1879
|
+
};
|
|
1880
|
+
/** Collapsible list item title. */
|
|
1881
|
+
type CollapsibleItemTitleNode = {
|
|
1882
|
+
/**
|
|
1883
|
+
* Node type.
|
|
1884
|
+
* Must be `COLLAPSIBLE_ITEM_TITLE`.
|
|
1885
|
+
*/
|
|
1886
|
+
type: 'COLLAPSIBLE_ITEM_TITLE'; /** Collapsible list item title child nodes. */
|
|
1887
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1888
|
+
id?: string;
|
|
1889
|
+
};
|
|
1890
|
+
/** Collapsible list item body. */
|
|
1891
|
+
type CollapsibleItemBodyNode = {
|
|
1892
|
+
/**
|
|
1893
|
+
* Node type.
|
|
1894
|
+
* Must be `COLLAPSIBLE_ITEM_BODY`.
|
|
1895
|
+
*/
|
|
1896
|
+
type: 'COLLAPSIBLE_ITEM_BODY'; /** Collapsible list item body child nodes. */
|
|
1897
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
1898
|
+
id?: string;
|
|
1899
|
+
};
|
|
1900
|
+
/** Horizontal line between different content. */
|
|
1901
|
+
type DividerNode = {
|
|
1902
|
+
/**
|
|
1903
|
+
* Node type.
|
|
1904
|
+
* Must be `DIVIDER`.
|
|
1905
|
+
*/
|
|
1906
|
+
type: 'DIVIDER'; /** [Node ID](#node-ids). */
|
|
1907
|
+
id?: string; /** Divider details. */
|
|
1908
|
+
dividerData?: DividerData;
|
|
1909
|
+
nodes?: RicosDocumentNode[];
|
|
1910
|
+
};
|
|
1911
|
+
/** Divider data discriminated by line style. */
|
|
1912
|
+
type DividerData = DividerData_SingleLine | DividerData_DoubleLine | DividerData_DashedLine | DividerData_DottedLine;
|
|
1913
|
+
type DividerData_SingleLine = {
|
|
1914
|
+
/** Must be `SINGLE`. */lineStyle: 'SINGLE'; /** Divider container styling. */
|
|
1915
|
+
containerData?: PluginContainerData; /** Divider width. */
|
|
1916
|
+
width?: DividerData_Width; /** Divider alignment. */
|
|
1917
|
+
alignment?: DividerData_Alignment; /** Visual styling for the divider lines. */
|
|
1918
|
+
styles?: DividerData_SingleLine_Styles;
|
|
1919
|
+
/**
|
|
1920
|
+
* Node animation.
|
|
1921
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1922
|
+
*/
|
|
1923
|
+
animation?: Animation;
|
|
1924
|
+
};
|
|
1925
|
+
type DividerData_DoubleLine = {
|
|
1926
|
+
/** Must be `DOUBLE`. */lineStyle: 'DOUBLE'; /** Divider container styling. */
|
|
1927
|
+
containerData?: PluginContainerData; /** Divider width. */
|
|
1928
|
+
width?: DividerData_Width; /** Divider alignment. */
|
|
1929
|
+
alignment?: DividerData_Alignment; /** Visual styling for the divider lines. */
|
|
1930
|
+
styles?: DividerData_DoubleLine_Styles;
|
|
1931
|
+
/**
|
|
1932
|
+
* Node animation.
|
|
1933
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1934
|
+
*/
|
|
1935
|
+
animation?: Animation;
|
|
1936
|
+
};
|
|
1937
|
+
type DividerData_DashedLine = {
|
|
1938
|
+
/** Must be `DASHED`. */lineStyle: 'DASHED'; /** Divider container styling. */
|
|
1939
|
+
containerData?: PluginContainerData; /** Divider width. */
|
|
1940
|
+
width?: DividerData_Width; /** Divider alignment. */
|
|
1941
|
+
alignment?: DividerData_Alignment; /** Visual styling for the divider lines. */
|
|
1942
|
+
styles?: DividerData_DashedLine_Styles;
|
|
1943
|
+
/**
|
|
1944
|
+
* Node animation.
|
|
1945
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1946
|
+
*/
|
|
1947
|
+
animation?: Animation;
|
|
1948
|
+
};
|
|
1949
|
+
type DividerData_DottedLine = {
|
|
1950
|
+
/** Must be `DOTTED`. */lineStyle: 'DOTTED'; /** Divider container styling. */
|
|
1951
|
+
containerData?: PluginContainerData; /** Divider width. */
|
|
1952
|
+
width?: DividerData_Width; /** Divider alignment. */
|
|
1953
|
+
alignment?: DividerData_Alignment; /** Visual styling for the divider lines. */
|
|
1954
|
+
styles?: DividerData_DottedLine_Styles;
|
|
1955
|
+
/**
|
|
1956
|
+
* Node animation.
|
|
1957
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
1958
|
+
*/
|
|
1959
|
+
animation?: Animation;
|
|
1960
|
+
};
|
|
1961
|
+
type DividerData_Width = 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1962
|
+
declare const DividerData_Width: {
|
|
1963
|
+
readonly LARGE: 'LARGE';
|
|
1964
|
+
readonly MEDIUM: 'MEDIUM';
|
|
1965
|
+
readonly SMALL: 'SMALL';
|
|
1966
|
+
};
|
|
1967
|
+
type DividerData_Alignment = 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1968
|
+
declare const DividerData_Alignment: {
|
|
1969
|
+
readonly CENTER: 'CENTER';
|
|
1970
|
+
readonly LEFT: 'LEFT';
|
|
1971
|
+
readonly RIGHT: 'RIGHT';
|
|
1972
|
+
};
|
|
1973
|
+
type DividerData_Styles_LineCap = 'SQUARE' | 'ROUND';
|
|
1974
|
+
declare const DividerData_Styles_LineCap: {
|
|
1975
|
+
readonly SQUARE: 'SQUARE';
|
|
1976
|
+
readonly ROUND: 'ROUND';
|
|
1977
|
+
};
|
|
1978
|
+
type DividerData_SingleLine_Styles = {
|
|
1979
|
+
/** Divider color as a hexadecimal value. An alpha channel controls opacity. */color?: string; /** Divider line ending shape. */
|
|
1980
|
+
lineCap?: DividerData_Styles_LineCap;
|
|
1981
|
+
lineThickness?: number[];
|
|
1982
|
+
};
|
|
1983
|
+
type DividerData_DoubleLine_Styles = {
|
|
1984
|
+
/** Divider color as a hexadecimal value. An alpha channel controls opacity. */color?: string; /** Divider line ending shape. */
|
|
1985
|
+
lineCap?: DividerData_Styles_LineCap;
|
|
1986
|
+
lineThickness?: number[]; /** Gap between divider lines in pixels. */
|
|
1987
|
+
lineGap?: number;
|
|
1988
|
+
};
|
|
1989
|
+
type DividerData_DashedLine_Styles = {
|
|
1990
|
+
/** Divider color as a hexadecimal value. An alpha channel controls opacity. */color?: string; /** Divider line ending shape. */
|
|
1991
|
+
lineCap?: DividerData_Styles_LineCap;
|
|
1992
|
+
lineThickness?: number[]; /** Visible dash length for dashed dividers, in pixels. The pattern is snapped to a whole number of dashes so that the first and last dash touch the divider's edges - narrower containers show fewer dashes at the same size. */
|
|
1993
|
+
dashLength?: number; /** Visible gap between dashes or dots, in pixels. */
|
|
1994
|
+
dashGap?: number;
|
|
1995
|
+
};
|
|
1996
|
+
type DividerData_DottedLine_Styles = {
|
|
1997
|
+
/** Divider color as a hexadecimal value. An alpha channel controls opacity. */color?: string; /** Divider line ending shape. */
|
|
1998
|
+
lineCap?: DividerData_Styles_LineCap;
|
|
1999
|
+
lineThickness?: number[]; /** Visible gap between dashes or dots, in pixels. */
|
|
2000
|
+
dashGap?: number;
|
|
2001
|
+
};
|
|
2002
|
+
/** Embedded content when you include a link to a resource, without having to parse the resource directly. This provides a standardized way for web developers to include content such as videos, images, and other multimedia elements from supported providers. To learn more, see [oembed](https://oembed.com/). */
|
|
2003
|
+
type EmbedNode = {
|
|
2004
|
+
/**
|
|
2005
|
+
* Node type.
|
|
2006
|
+
* Must be `EMBED`.
|
|
2007
|
+
*/
|
|
2008
|
+
type: 'EMBED'; /** oEmbed details. */
|
|
2009
|
+
embedData: EmbedData; /** [Node ID](#node-ids). */
|
|
2010
|
+
id?: string;
|
|
2011
|
+
nodes?: RicosDocumentNode[];
|
|
2012
|
+
};
|
|
2013
|
+
type EmbedData = {
|
|
2014
|
+
/** oEmbed node container styling. */containerData?: PluginContainerData; /** [oEmbed](https://www.oembed.com) details. */
|
|
2015
|
+
oembed?: Oembed; /** Original asset source. */
|
|
2016
|
+
src?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* Node animation.
|
|
2019
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2020
|
+
*/
|
|
2021
|
+
animation?: Animation;
|
|
2022
|
+
};
|
|
2023
|
+
type Oembed = {
|
|
2024
|
+
/** Resource type. */type?: string; /** Width of the resource specified in the `url` field in pixels. */
|
|
2025
|
+
width?: number; /** Height of the resource specified in the `url` field in pixels. */
|
|
2026
|
+
height?: number; /** Resource title. */
|
|
2027
|
+
title?: string; /** Resource source URL. */
|
|
2028
|
+
url?: string; /** HTML to embed a video player. The HTML should have no padding or margins. */
|
|
2029
|
+
html?: string; /** Name of the author or owner of the resource. */
|
|
2030
|
+
authorName?: string; /** URL for the author or owner of the resource. */
|
|
2031
|
+
authorUrl?: string; /** Name of the resource provider. */
|
|
2032
|
+
providerName?: string; /** URL for the resource provider. */
|
|
2033
|
+
providerUrl?: string; /** Thumbnail image URL for the resource. If defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
2034
|
+
thumbnailUrl?: string; /** Resource's thumbnail image width. If defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
2035
|
+
thumbnailWidth?: string; /** Resource's thumbnail image height. If defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
2036
|
+
thumbnailHeight?: string; /** Embedded video URL. */
|
|
2037
|
+
videoUrl?: string; /** The oEmbed version number. Must be `1.0`. */
|
|
2038
|
+
version?: string;
|
|
2039
|
+
};
|
|
2040
|
+
type ExternalNode = {
|
|
2041
|
+
type: 'EXTERNAL';
|
|
2042
|
+
id?: string;
|
|
2043
|
+
htmlData?: any;
|
|
2044
|
+
externalData?: Record<string, any>;
|
|
2045
|
+
nodes?: RicosDocumentNode[];
|
|
2046
|
+
};
|
|
2047
|
+
/** File that is uploaded and accessed in a page. Files can be different types of content, such as text documents, images, and videos. */
|
|
2048
|
+
type FileNode = {
|
|
2049
|
+
/**
|
|
2050
|
+
* Node type.
|
|
2051
|
+
* Must be `FILE`.
|
|
2052
|
+
*/
|
|
2053
|
+
type: 'FILE'; /** File details. */
|
|
2054
|
+
fileData: FileData; /** [Node ID](#node-ids). */
|
|
2055
|
+
id?: string;
|
|
2056
|
+
nodes?: RicosDocumentNode[];
|
|
2057
|
+
};
|
|
2058
|
+
type FileData = {
|
|
2059
|
+
/** File container styling. */containerData?: PluginContainerData; /** File data source. */
|
|
2060
|
+
src?: FileSource; /** File name. */
|
|
2061
|
+
name?: string; /** File type. */
|
|
2062
|
+
type?: string; /** Deprecated. Replaced by `sizeInKb` */
|
|
2063
|
+
size?: number; /** File size in KB. */
|
|
2064
|
+
sizeInKb?: string; /** Settings for PDF files. */
|
|
2065
|
+
pdfSettings?: FileData_PDFSettings; /** File MIME type. */
|
|
2066
|
+
mimeType?: string; /** File path. */
|
|
2067
|
+
path?: string;
|
|
2068
|
+
/**
|
|
2069
|
+
* Node animation.
|
|
2070
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2071
|
+
*/
|
|
2072
|
+
animation?: Animation;
|
|
2073
|
+
};
|
|
2074
|
+
type FileData_PDFSettings = {
|
|
2075
|
+
/**
|
|
2076
|
+
* PDF view mode. Supported values:
|
|
2077
|
+
* - `NONE`: PDF isn't displayed.
|
|
2078
|
+
* - `FULL`: Full PDF page view is displayed.
|
|
2079
|
+
* - `MINI`: Mini view of the PDF is displayed.
|
|
2080
|
+
*/
|
|
2081
|
+
viewMode?: FileData_PDFSettings_ViewMode;
|
|
2082
|
+
/**
|
|
2083
|
+
* Whether the PDF download button is disabled.
|
|
2084
|
+
* Default: `false`
|
|
2085
|
+
*/
|
|
2086
|
+
disableDownload?: boolean;
|
|
2087
|
+
/**
|
|
2088
|
+
* Whether the PDF print button is disabled.
|
|
2089
|
+
* Default: `false`
|
|
2090
|
+
*/
|
|
2091
|
+
disablePrint?: boolean;
|
|
2092
|
+
};
|
|
2093
|
+
type FileData_PDFSettings_ViewMode = 'NONE' | 'FULL' | 'MINI';
|
|
2094
|
+
declare const FileData_PDFSettings_ViewMode: {
|
|
2095
|
+
readonly NONE: 'NONE';
|
|
2096
|
+
readonly FULL: 'FULL';
|
|
2097
|
+
readonly MINI: 'MINI';
|
|
2098
|
+
};
|
|
2099
|
+
/** Collection of images displayed together. */
|
|
2100
|
+
type GalleryNode = {
|
|
2101
|
+
/**
|
|
2102
|
+
* Node type.
|
|
2103
|
+
* Must be `GALLERY`.
|
|
2104
|
+
*/
|
|
2105
|
+
type: 'GALLERY'; /** Gallery node details. */
|
|
2106
|
+
galleryData: GalleryData; /** [Node ID](#node-ids). */
|
|
2107
|
+
id?: string;
|
|
2108
|
+
nodes?: RicosDocumentNode[];
|
|
2109
|
+
};
|
|
2110
|
+
type GalleryData = {
|
|
2111
|
+
items: GalleryData_Item[]; /** Gallery container styling. */
|
|
2112
|
+
containerData?: PluginContainerData; /** Gallery appearance options. */
|
|
2113
|
+
options?: GalleryOptions;
|
|
2114
|
+
/**
|
|
2115
|
+
* Whether the expand button is disabled.
|
|
2116
|
+
* Default: `false`
|
|
2117
|
+
*/
|
|
2118
|
+
disableExpand?: boolean;
|
|
2119
|
+
/**
|
|
2120
|
+
* Whether the download button is disabled.
|
|
2121
|
+
* Default: `false`
|
|
2122
|
+
*/
|
|
2123
|
+
disableDownload?: boolean;
|
|
2124
|
+
/**
|
|
2125
|
+
* Node animation.
|
|
2126
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2127
|
+
*/
|
|
2128
|
+
animation?: Animation;
|
|
2129
|
+
};
|
|
2130
|
+
type GalleryOptions = {
|
|
2131
|
+
/** Gallery layout. */layout?: GalleryOptions_Layout; /** Styling for gallery items. */
|
|
2132
|
+
item?: GalleryOptions_ItemStyle; /** Styling for gallery thumbnail images. */
|
|
2133
|
+
thumbnails?: GalleryOptions_Thumbnails;
|
|
2134
|
+
};
|
|
2135
|
+
type GalleryOptions_Layout = {
|
|
2136
|
+
/** Gallery layout. Supported values: <br> - `COLLAGE`: Presents images in various sizes and positions, creating an artistic or dynamic layout. <br> - `MASONRY`: Grid-based design that places items in optimal positions based on available vertical space, creating an arrangement where items of varying heights fit together like bricks in a wall. <br> - `GRID`: A layout structure that organizes items into rows and columns, creating a uniform arrangement of images. <br> - `THUMBNAIL`: Smaller, scaled-down version of an image that serves as a preview. <br> - `SLIDER`: Component that allows users to browse through a set of images by sliding or swiping through them, typically in a confined viewing area. <br> - `SLIDESHOW`: A component that automatically or manually transitions through a set of images in a designated area. <br> - `PANORAMA`: Wide-angle or 360-degree image that allows users to view an extended horizontal view of a scene. <br> - `COLUMN`: Arrangement of the gallery items in vertical sections. <br> - `MAGIC`: Visually stunning, dynamic effects that enhance the user experience. <br> - `FULLSIZE`: A layout where each image or item is displayed at its full size, sometimes taking up the entire viewport or a significant portion of the screen. */type?: GalleryOptions_Layout_Type;
|
|
2137
|
+
/**
|
|
2138
|
+
* Whether the horizontal scroll is enabled.
|
|
2139
|
+
* Default: `true`, unless the `type` field is set to `GRID` or `COLLAGE`.
|
|
2140
|
+
*/
|
|
2141
|
+
horizontalScroll?: boolean; /** Gallery orientation. */
|
|
2142
|
+
orientation?: GalleryOptions_Layout_Orientation; /** Number of columns to display on computer screens. */
|
|
2143
|
+
numberOfColumns?: number; /** Number of columns to display on mobile phone screens. */
|
|
2144
|
+
mobileNumberOfColumns?: number;
|
|
2145
|
+
};
|
|
2146
|
+
type GalleryOptions_Layout_Type = 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2147
|
+
declare const GalleryOptions_Layout_Type: {
|
|
2148
|
+
readonly COLLAGE: 'COLLAGE';
|
|
2149
|
+
readonly MASONRY: 'MASONRY';
|
|
2150
|
+
readonly GRID: 'GRID';
|
|
2151
|
+
readonly THUMBNAIL: 'THUMBNAIL';
|
|
2152
|
+
readonly SLIDER: 'SLIDER';
|
|
2153
|
+
readonly SLIDESHOW: 'SLIDESHOW';
|
|
2154
|
+
readonly PANORAMA: 'PANORAMA';
|
|
2155
|
+
readonly COLUMN: 'COLUMN';
|
|
2156
|
+
readonly MAGIC: 'MAGIC';
|
|
2157
|
+
readonly FULLSIZE: 'FULLSIZE';
|
|
2158
|
+
};
|
|
2159
|
+
type GalleryOptions_Layout_Orientation = 'ROWS' | 'COLUMNS';
|
|
2160
|
+
declare const GalleryOptions_Layout_Orientation: {
|
|
2161
|
+
readonly ROWS: 'ROWS';
|
|
2162
|
+
readonly COLUMNS: 'COLUMNS';
|
|
2163
|
+
};
|
|
2164
|
+
type GalleryOptions_ItemStyle = {
|
|
2165
|
+
/** Dimensions for each gallery item in pixels. Behavior may change with gallery type. */targetSize?: number; /** Height to width ratio. */
|
|
2166
|
+
ratio?: number; /** Cropping strategy. Supported values: <br> - `FILL`: Each item in the gallery is cropped and resized to completely fill its container. <br> - `FIT`: Each item in the gallery is resized to fit exactly in its container without cropping. */
|
|
2167
|
+
crop?: GalleryOptions_ItemStyle_Crop; /** Spacing between gallery items in pixels. */
|
|
2168
|
+
spacing?: number;
|
|
2169
|
+
};
|
|
2170
|
+
type GalleryOptions_ItemStyle_Crop = 'FILL' | 'FIT';
|
|
2171
|
+
declare const GalleryOptions_ItemStyle_Crop: {
|
|
2172
|
+
readonly FILL: 'FILL';
|
|
2173
|
+
readonly FIT: 'FIT';
|
|
2174
|
+
};
|
|
2175
|
+
type GalleryOptions_Thumbnails = {
|
|
2176
|
+
/** Thumbnail alignment. */placement?: GalleryOptions_Thumbnails_Alignment; /** Spacing between thumbnails in pixels. */
|
|
2177
|
+
spacing?: number;
|
|
2178
|
+
};
|
|
2179
|
+
type GalleryOptions_Thumbnails_Alignment = 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2180
|
+
declare const GalleryOptions_Thumbnails_Alignment: {
|
|
2181
|
+
readonly TOP: 'TOP';
|
|
2182
|
+
readonly RIGHT: 'RIGHT';
|
|
2183
|
+
readonly BOTTOM: 'BOTTOM';
|
|
2184
|
+
readonly LEFT: 'LEFT';
|
|
2185
|
+
readonly NONE: 'NONE';
|
|
2186
|
+
};
|
|
2187
|
+
type GalleryData_Item = {
|
|
2188
|
+
/** Item title. */title?: string; /** Item's alternative text. */
|
|
2189
|
+
altText?: string; /** Image item. */
|
|
2190
|
+
image?: GalleryData_Item_Image; /** Video item. */
|
|
2191
|
+
video?: GalleryData_Item_Video;
|
|
2192
|
+
};
|
|
2193
|
+
type GalleryData_Item_Video = {
|
|
2194
|
+
/** Video file details. */media: Media; /** Video thumbnail file details. */
|
|
2195
|
+
thumbnail?: Media;
|
|
2196
|
+
};
|
|
2197
|
+
type GalleryData_Item_Image = {
|
|
2198
|
+
/** Image file details. */media: Media; /** Link details for images, if relevant. */
|
|
2199
|
+
link?: Link$1;
|
|
2200
|
+
};
|
|
2201
|
+
/** GIF images. */
|
|
2202
|
+
type GifNode = {
|
|
2203
|
+
/**
|
|
2204
|
+
* Node type.
|
|
2205
|
+
* Must be `GIF`.
|
|
2206
|
+
*/
|
|
2207
|
+
type: 'GIF'; /** GIF details. */
|
|
2208
|
+
gifData: GIFData; /** [Node ID](#node-ids). */
|
|
2209
|
+
id?: string; /** Child nodes to define a GIF caption. */
|
|
2210
|
+
nodes?: RicosDocumentNode[];
|
|
2211
|
+
};
|
|
2212
|
+
type GIFData = {
|
|
2213
|
+
/** GIF container styling. */containerData?: PluginContainerData; /** Source for the full size GIF. */
|
|
2214
|
+
original?: GIF; /** Source for the downsized GIF. */
|
|
2215
|
+
downsized?: GIF; /** Height in pixels. */
|
|
2216
|
+
height?: number; /** Width in pixels. */
|
|
2217
|
+
width?: number;
|
|
2218
|
+
/**
|
|
2219
|
+
* Type of GIF (Sticker or NORMAL).
|
|
2220
|
+
* Default: `NORMAL`
|
|
2221
|
+
*/
|
|
2222
|
+
gifType?: GIFData_GIFType;
|
|
2223
|
+
/**
|
|
2224
|
+
* Node animation.
|
|
2225
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2226
|
+
*/
|
|
2227
|
+
animation?: Animation;
|
|
2228
|
+
};
|
|
2229
|
+
type GIFData_GIFType = 'NORMAL' | 'STICKER';
|
|
2230
|
+
declare const GIFData_GIFType: {
|
|
2231
|
+
readonly NORMAL: 'NORMAL';
|
|
2232
|
+
readonly STICKER: 'STICKER';
|
|
2233
|
+
};
|
|
2234
|
+
type GIF = {
|
|
2235
|
+
/** GIF source URL. */gif?: string; /** MP4 source URL. */
|
|
2236
|
+
mp4?: string; /** GIF thumbnail URL. */
|
|
2237
|
+
still?: string;
|
|
2238
|
+
};
|
|
2239
|
+
/** HTML block that incorporates external content, such as interactive maps or entire web pages. */
|
|
2240
|
+
type HtmlNode = {
|
|
2241
|
+
/**
|
|
2242
|
+
* Node type.
|
|
2243
|
+
* Mst be `HTML`.
|
|
2244
|
+
*/
|
|
2245
|
+
type: 'HTML'; /** HTML details. */
|
|
2246
|
+
htmlData: HTMLData; /** [Node ID](#node-ids). */
|
|
2247
|
+
id?: string;
|
|
2248
|
+
nodes?: RicosDocumentNode[];
|
|
2249
|
+
};
|
|
2250
|
+
type HTMLData = {
|
|
2251
|
+
/** HTML node container styling. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */containerData?: PluginContainerData;
|
|
2252
|
+
/**
|
|
2253
|
+
* HTML code type. Possible values:
|
|
2254
|
+
* - `HTML`: HTML code.
|
|
2255
|
+
* - [`ADSENSE`](https://adsense.google.com/start/): Service provided by Google for rendering advertisements on web pages.
|
|
2256
|
+
* - `AI`: AI-generated HTML code.
|
|
2257
|
+
*/
|
|
2258
|
+
source?: HTMLData_Source; /** HTML code URL. */
|
|
2259
|
+
url?: string; /** HTML code. */
|
|
2260
|
+
html?: string; /** WixelWidget ID. Used when source is `AI_WIDGET`. */
|
|
2261
|
+
widgetId?: string;
|
|
2262
|
+
/**
|
|
2263
|
+
* If container height is aligned with its content height.
|
|
2264
|
+
* Default: `true`
|
|
2265
|
+
*/
|
|
2266
|
+
autoHeight?: boolean;
|
|
2267
|
+
/**
|
|
2268
|
+
* Node animation.
|
|
2269
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2270
|
+
*/
|
|
2271
|
+
animation?: Animation;
|
|
2272
|
+
};
|
|
2273
|
+
type HTMLData_Source = 'HTML' | 'ADSENSE' | 'AI' | 'AI_WIDGET';
|
|
2274
|
+
declare const HTMLData_Source: {
|
|
2275
|
+
readonly HTML: 'HTML';
|
|
2276
|
+
readonly ADSENSE: 'ADSENSE';
|
|
2277
|
+
readonly AI: 'AI';
|
|
2278
|
+
readonly AI_WIDGET: 'AI_WIDGET';
|
|
2279
|
+
};
|
|
2280
|
+
/** Standalone images in a page. */
|
|
2281
|
+
type ImageNode = {
|
|
2282
|
+
/**
|
|
2283
|
+
* Node type.
|
|
2284
|
+
* Must be `IMAGE`.
|
|
2285
|
+
*/
|
|
2286
|
+
type: 'IMAGE'; /** Image options. */
|
|
2287
|
+
imageData: ImageData; /** [Node ID](#node-ids). */
|
|
2288
|
+
id?: string; /** Child nodes to define an image caption. */
|
|
2289
|
+
nodes?: RicosDocumentNode[];
|
|
2290
|
+
};
|
|
2291
|
+
type ImageData = {
|
|
2292
|
+
/** Image file details. */image: Media; /** Image container styling. */
|
|
2293
|
+
containerData?: PluginContainerData; /** Image link details. */
|
|
2294
|
+
link?: Link$1;
|
|
2295
|
+
/**
|
|
2296
|
+
* Whether the image expands to the full screen when clicked.
|
|
2297
|
+
* Default: `false`
|
|
2298
|
+
*/
|
|
2299
|
+
disableExpand?: boolean; /** Alternate text for accessibility and display when the image doesn't load. */
|
|
2300
|
+
altText?: string; /** Deprecated. Use `CaptionNode` instead. */
|
|
2301
|
+
caption?: string;
|
|
2302
|
+
/**
|
|
2303
|
+
* Whether the download image button is disabled.
|
|
2304
|
+
* Default: `false`
|
|
2305
|
+
*/
|
|
2306
|
+
disableDownload?: boolean; /** Whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
2307
|
+
decorative?: boolean; /** Image styling. */
|
|
2308
|
+
styles?: ImageData_Styles; /** Non-destructive crop rectangle, expressed as fractions (0-1) of the original image. When omitted, the full image is shown. */
|
|
2309
|
+
crop?: ImageData_Crop; /** Optional shape mask applied to the visible crop. */
|
|
2310
|
+
cropShape?: ImageData_CropShape;
|
|
2311
|
+
/**
|
|
2312
|
+
* Node animation.
|
|
2313
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2314
|
+
*/
|
|
2315
|
+
animation?: Animation;
|
|
2316
|
+
};
|
|
2317
|
+
type ImageData_CropShape = 'CIRCLE' | 'OVAL' | 'STAR' | 'PENTAGON' | 'HEXAGON' | 'TRIANGLE' | 'HEART' | 'RHOMBUS' | 'FLUID' | 'WINDOW';
|
|
2318
|
+
declare const ImageData_CropShape: {
|
|
2319
|
+
readonly CIRCLE: 'CIRCLE';
|
|
2320
|
+
readonly OVAL: 'OVAL';
|
|
2321
|
+
readonly STAR: 'STAR';
|
|
2322
|
+
readonly PENTAGON: 'PENTAGON';
|
|
2323
|
+
readonly HEXAGON: 'HEXAGON';
|
|
2324
|
+
readonly TRIANGLE: 'TRIANGLE';
|
|
2325
|
+
readonly HEART: 'HEART';
|
|
2326
|
+
readonly RHOMBUS: 'RHOMBUS';
|
|
2327
|
+
readonly FLUID: 'FLUID';
|
|
2328
|
+
readonly WINDOW: 'WINDOW';
|
|
2329
|
+
};
|
|
2330
|
+
type ImageData_Crop = {
|
|
2331
|
+
/** Left edge of the crop, as a fraction (0-1) of the original image width. */x?: number; /** Top edge of the crop, as a fraction (0-1) of the original image height. */
|
|
2332
|
+
y?: number; /** Visible width of the crop, as a fraction (0-1) of the original image width. */
|
|
2333
|
+
width?: number; /** Visible height of the crop, as a fraction (0-1) of the original image height. */
|
|
2334
|
+
height?: number;
|
|
2335
|
+
};
|
|
2336
|
+
type ImageData_Styles = {
|
|
2337
|
+
/** Border properties. */border?: ImageData_Styles_Border;
|
|
2338
|
+
};
|
|
2339
|
+
type ImageData_Styles_Border = {
|
|
2340
|
+
/** Border width in pixels. */width?: number; /** Border color as a hexadecimal value. */
|
|
2341
|
+
color?: string; /** Border radius in pixels. */
|
|
2342
|
+
radius?: number;
|
|
2343
|
+
};
|
|
2344
|
+
/** Preview or summary of a webpage. Link previews include elements such as the title of the linked page, a brief description or excerpt of the content, and sometimes a thumbnail image or other relevant information. */
|
|
2345
|
+
type LinkPreviewNode = {
|
|
2346
|
+
/**
|
|
2347
|
+
* Node type.
|
|
2348
|
+
* Must be `LINK_PREVIEW`.
|
|
2349
|
+
*/
|
|
2350
|
+
type: 'LINK_PREVIEW'; /** Link preview details. */
|
|
2351
|
+
linkPreviewData: LinkPreviewData; /** [Node ID](#node-ids). */
|
|
2352
|
+
id?: string;
|
|
2353
|
+
nodes?: RicosDocumentNode[];
|
|
2354
|
+
};
|
|
2355
|
+
type LinkPreviewData = {
|
|
2356
|
+
/** Link preview container styling. */containerData?: PluginContainerData; /** Link details. */
|
|
2357
|
+
link?: Link$1; /** Preview title. */
|
|
2358
|
+
title?: string; /** Preview thumbnail URL. */
|
|
2359
|
+
thumbnailUrl?: string; /** Preview description. */
|
|
2360
|
+
description?: string; /** Preview content as HTML. */
|
|
2361
|
+
html?: string; /** Styling for the link preview. */
|
|
2362
|
+
styles?: LinkPreviewData_Styles;
|
|
2363
|
+
/**
|
|
2364
|
+
* Node animation.
|
|
2365
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2366
|
+
*/
|
|
2367
|
+
animation?: Animation;
|
|
2368
|
+
};
|
|
2369
|
+
type LinkPreviewData_Styles = {
|
|
2370
|
+
/** Background color as a hexadecimal value. */backgroundColor?: string; /** Title color as a hexadecimal value. */
|
|
2371
|
+
titleColor?: string; /** Subtitle color as a hexadecimal value. */
|
|
2372
|
+
subtitleColor?: string; /** Link color as a hexadecimal value. */
|
|
2373
|
+
linkColor?: string; /** Border width in pixels. */
|
|
2374
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2375
|
+
borderRadius?: number; /** Border color as a hexadecimal value. */
|
|
2376
|
+
borderColor?: string; /** Position of thumbnail. Defaults to `START`. */
|
|
2377
|
+
thumbnailPosition?: 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2378
|
+
};
|
|
2379
|
+
/** Provides a question with several options, where the options' cumulative total may be shown. */
|
|
2380
|
+
type PollNode = {
|
|
2381
|
+
/**
|
|
2382
|
+
* Node type.
|
|
2383
|
+
* Must be `POLL`.
|
|
2384
|
+
*/
|
|
2385
|
+
type: 'POLL'; /** Poll details. */
|
|
2386
|
+
pollData: PollData; /** [Node ID](#node-ids). */
|
|
2387
|
+
id?: string;
|
|
2388
|
+
nodes?: RicosDocumentNode[];
|
|
2389
|
+
};
|
|
2390
|
+
type PollData = {
|
|
2391
|
+
/** Poll container styling. */containerData?: PluginContainerData; /** Poll data. */
|
|
2392
|
+
poll?: PollData_Poll; /** Poll layout settings. */
|
|
2393
|
+
layout?: PollData_Layout; /** Poll design. */
|
|
2394
|
+
design?: PollData_Design;
|
|
2395
|
+
/**
|
|
2396
|
+
* Node animation.
|
|
2397
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2398
|
+
*/
|
|
2399
|
+
animation?: Animation;
|
|
2400
|
+
};
|
|
2401
|
+
type PollData_Poll = {
|
|
2402
|
+
/** [Node ID](#node-ids). */id?: string; /** Poll title. */
|
|
2403
|
+
title?: string; /** Poll creator ID. */
|
|
2404
|
+
creatorId?: string; /** Main poll image. */
|
|
2405
|
+
image?: Media;
|
|
2406
|
+
options?: PollData_Poll_Option[]; /** Poll display settings. */
|
|
2407
|
+
settings?: PollData_Poll_Settings;
|
|
2408
|
+
};
|
|
2409
|
+
type PollData_Poll_Option = {
|
|
2410
|
+
/** Poll option ID. */id?: string; /** Poll option title */
|
|
2411
|
+
title?: string; /** Image displayed with the option. */
|
|
2412
|
+
image?: Media;
|
|
2413
|
+
};
|
|
2414
|
+
type PollData_Poll_Settings = {
|
|
2415
|
+
/** Voting permission settings. */permissions?: PollData_Poll_Settings_Permissions;
|
|
2416
|
+
/**
|
|
2417
|
+
* Whether to display the voters in the vote results.
|
|
2418
|
+
* Default: `true`.
|
|
2419
|
+
*/
|
|
2420
|
+
showVoters?: boolean;
|
|
2421
|
+
/**
|
|
2422
|
+
* Whether to display the vote count.
|
|
2423
|
+
* Default: `true`.
|
|
2424
|
+
*/
|
|
2425
|
+
showVotesCount?: boolean;
|
|
2426
|
+
};
|
|
2427
|
+
type PollData_Poll_Settings_Permissions = {
|
|
2428
|
+
/** Who can view the poll results. */view?: PollData_Poll_Settings_Permissions_ViewRole; /** Who can vote. */
|
|
2429
|
+
vote?: PollData_Poll_Settings_Permissions_VoteRole;
|
|
2430
|
+
/**
|
|
2431
|
+
* Whether a user can vote multiple times.
|
|
2432
|
+
* Default: `false`
|
|
2433
|
+
*/
|
|
2434
|
+
allowMultipleVotes?: boolean;
|
|
2435
|
+
};
|
|
2436
|
+
type PollData_Poll_Settings_Permissions_ViewRole = 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2437
|
+
declare const PollData_Poll_Settings_Permissions_ViewRole: {
|
|
2438
|
+
readonly CREATOR: 'CREATOR';
|
|
2439
|
+
readonly VOTERS: 'VOTERS';
|
|
2440
|
+
readonly EVERYONE: 'EVERYONE';
|
|
2441
|
+
};
|
|
2442
|
+
type PollData_Poll_Settings_Permissions_VoteRole = 'SITE_MEMBERS' | 'ALL';
|
|
2443
|
+
declare const PollData_Poll_Settings_Permissions_VoteRole: {
|
|
2444
|
+
readonly SITE_MEMBERS: 'SITE_MEMBERS';
|
|
2445
|
+
readonly ALL: 'ALL';
|
|
2446
|
+
};
|
|
2447
|
+
type PollData_Layout = {
|
|
2448
|
+
/** Poll layout settings. */poll?: PollData_Layout_PollLayout; /** Poll options layout settings. */
|
|
2449
|
+
options?: PollData_Layout_OptionLayout;
|
|
2450
|
+
};
|
|
2451
|
+
type PollData_Layout_PollLayout = {
|
|
2452
|
+
/** Voting options layout. */type?: PollData_Layout_PollLayout_Type; /** Direction of the text in the poll. Supported values: <br> - `LTR`: Left to right. <br> - `RTL`: Right to left. */
|
|
2453
|
+
direction?: PollData_Layout_PollLayout_Direction;
|
|
2454
|
+
/**
|
|
2455
|
+
* Whether to display the main poll image.
|
|
2456
|
+
* Default: `false`
|
|
2457
|
+
*/
|
|
2458
|
+
enableImage?: boolean;
|
|
2459
|
+
};
|
|
2460
|
+
type PollData_Layout_PollLayout_Type = 'LIST' | 'GRID';
|
|
2461
|
+
declare const PollData_Layout_PollLayout_Type: {
|
|
2462
|
+
readonly LIST: 'LIST';
|
|
2463
|
+
readonly GRID: 'GRID';
|
|
2464
|
+
};
|
|
2465
|
+
type PollData_Layout_PollLayout_Direction = 'LTR' | 'RTL';
|
|
2466
|
+
declare const PollData_Layout_PollLayout_Direction: {
|
|
2467
|
+
readonly LTR: 'LTR';
|
|
2468
|
+
readonly RTL: 'RTL';
|
|
2469
|
+
};
|
|
2470
|
+
type PollData_Layout_OptionLayout = {
|
|
2471
|
+
/**
|
|
2472
|
+
* Whether to display option images.
|
|
2473
|
+
* Defaults: `false`.
|
|
2474
|
+
*/
|
|
2475
|
+
enableImage?: boolean;
|
|
2476
|
+
};
|
|
2477
|
+
type PollData_Design = {
|
|
2478
|
+
/** Poll styling. */poll?: PollData_Design_PollDesign; /** Voting options styling. */
|
|
2479
|
+
options?: PollData_Design_OptionDesign;
|
|
2480
|
+
};
|
|
2481
|
+
type PollData_Design_PollDesign = {
|
|
2482
|
+
/** Poll background styling. */background?: PollData_Design_PollDesign_Background; /** Border radius in pixels. */
|
|
2483
|
+
borderRadius?: number;
|
|
2484
|
+
};
|
|
2485
|
+
type PollData_Design_PollDesign_Background = PollData_Background_ColorVariant | PollData_Background_ImageVariant | PollData_Background_GradientVariant;
|
|
2486
|
+
type PollData_Background_ColorVariant = {
|
|
2487
|
+
type: 'COLOR'; /** Background color as a hexademical value. */
|
|
2488
|
+
color?: string;
|
|
2489
|
+
};
|
|
2490
|
+
type PollData_Background_ImageVariant = {
|
|
2491
|
+
type: 'IMAGE'; /** Image to use for the background. */
|
|
2492
|
+
image?: Media;
|
|
2493
|
+
};
|
|
2494
|
+
type PollData_Background_GradientVariant = {
|
|
2495
|
+
type: 'GRADIENT'; /** Gradient background details. */
|
|
2496
|
+
gradient?: PollData_Design_PollDesign_Background_Gradient;
|
|
2497
|
+
};
|
|
2498
|
+
type PollData_Design_PollDesign_Background_Gradient = {
|
|
2499
|
+
/** Gradient angle in degrees. */angle?: number; /** Start color as a hexadecimal value. */
|
|
2500
|
+
startColor?: string; /** End color as a hexadecimal value. */
|
|
2501
|
+
lastColor?: string;
|
|
2502
|
+
};
|
|
2503
|
+
type PollData_Design_OptionDesign = {
|
|
2504
|
+
/** Border radius in pixels. */borderRadius?: number;
|
|
2505
|
+
};
|
|
2506
|
+
/** Standalone shapes in a page. */
|
|
2507
|
+
type ShapeNode = {
|
|
2508
|
+
/**
|
|
2509
|
+
* Node type.
|
|
2510
|
+
* Must be `SHAPE`.
|
|
2511
|
+
*/
|
|
2512
|
+
type: 'SHAPE'; /** [Node ID](#node-ids). */
|
|
2513
|
+
id: string; /** Shape options. */
|
|
2514
|
+
shapeData: ShapeData;
|
|
2515
|
+
nodes?: RicosDocumentNode[];
|
|
2516
|
+
};
|
|
2517
|
+
type ShapeData = {
|
|
2518
|
+
/** Shape file details. */shape: Media; /** Shape container styling. */
|
|
2519
|
+
containerData?: PluginContainerData; /** Styling for the shape. */
|
|
2520
|
+
styles?: ShapeData_Styles;
|
|
2521
|
+
/**
|
|
2522
|
+
* Node animation.
|
|
2523
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2524
|
+
*/
|
|
2525
|
+
animation?: Animation; /** Shape link details. */
|
|
2526
|
+
link?: Link$1; /** Alternate text describing the link's purpose for accessibility. Applies only when `link` is set; a shape without a link stays decorative and hidden from screen readers. */
|
|
2527
|
+
altText?: string;
|
|
2528
|
+
};
|
|
2529
|
+
type ShapeData_Styles = {
|
|
2530
|
+
colors?: Record<string, string>;
|
|
2531
|
+
};
|
|
2532
|
+
/** Block whose content is rendered by an integration, for example a Wix Forms form. When the integration isn't available, Ricos shows a placeholder. */
|
|
2533
|
+
type SlotNode = {
|
|
2534
|
+
/**
|
|
2535
|
+
* Node type.
|
|
2536
|
+
* Must be `SLOT`.
|
|
2537
|
+
*/
|
|
2538
|
+
type: 'SLOT'; /** [Node ID](#node-ids). */
|
|
2539
|
+
id?: string; /** Slot details. */
|
|
2540
|
+
slotData?: SlotData;
|
|
2541
|
+
nodes?: RicosDocumentNode[];
|
|
2542
|
+
};
|
|
2543
|
+
type SlotData = {
|
|
2544
|
+
/** Integration type, for example `wix.forms.form`. Used to render the slot in the editor and viewer. */integrationType: string; /** ID of the resource the slot renders, for example a form ID. Passed as-is to the integration, which uses it to load the content. */
|
|
2545
|
+
resourceId?: string;
|
|
2546
|
+
/**
|
|
2547
|
+
* Node animation.
|
|
2548
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2549
|
+
*/
|
|
2550
|
+
animation?: Animation; /** Design overrides for this slot. Unset colours use the Ricos theme; unset sizes default to 0. */
|
|
2551
|
+
design?: SlotDesign;
|
|
2552
|
+
};
|
|
2553
|
+
/** Slot design. Every field is optional: unset colours use the Ricos theme and unset sizes default to 0. Ricos converts theme colour tokens to CSS colours before passing the design to the integration. */
|
|
2554
|
+
type SlotDesign = {
|
|
2555
|
+
/** Text colour. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */textColor?: string; /** Accent colour, for example field focus or selection. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */
|
|
2556
|
+
accentColor?: string; /** Button background colour. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */
|
|
2557
|
+
buttonColor?: string; /** Button text colour. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */
|
|
2558
|
+
buttonTextColor?: string; /** Block background colour. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */
|
|
2559
|
+
backgroundColor?: string; /** Block border colour. A CSS colour or a `$theme-color-N[-opacity]` token, stored as written. */
|
|
2560
|
+
borderColor?: string; /** Block border width. In CSS pixels. */
|
|
2561
|
+
borderWidth?: number; /** Block corner radius. In CSS pixels. */
|
|
2562
|
+
borderRadius?: number; /** Horizontal inner padding. In CSS pixels. */
|
|
2563
|
+
paddingHorizontal?: number; /** Vertical inner padding. In CSS pixels. */
|
|
2564
|
+
paddingVertical?: number; /** Vertical gap between rows. In CSS pixels. */
|
|
2565
|
+
rowGap?: number; /** Horizontal gap between columns. In CSS pixels. */
|
|
2566
|
+
columnGap?: number;
|
|
2567
|
+
};
|
|
2568
|
+
/** A smart block node that allows switching between different visual representations (variants) while preserving content. */
|
|
2569
|
+
type SmartBlockNode = {
|
|
2570
|
+
/**
|
|
2571
|
+
* Node type.
|
|
2572
|
+
* Must be `SMART_BLOCK`.
|
|
2573
|
+
*/
|
|
2574
|
+
type: 'SMART_BLOCK'; /** Smart block cells. */
|
|
2575
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
2576
|
+
id?: string; /** Smart block details. */
|
|
2577
|
+
smartBlockData?: SmartBlockData;
|
|
2578
|
+
};
|
|
2579
|
+
/** Smart block data discriminated by type. */
|
|
2580
|
+
type SmartBlockData = SmartBlockData_SolidBoxes | SmartBlockData_NumberedBoxes | SmartBlockData_Stats | SmartBlockData_BarStats | SmartBlockData_CircleStats | SmartBlockData_SolidBoxesAlternating | SmartBlockData_SolidJoinedBoxes | SmartBlockData_SideLineText | SmartBlockData_TopLineText | SmartBlockData_OutlineBoxesWithTopCircle | SmartBlockData_BigBullets | SmartBlockData_SmallBullets | SmartBlockData_ArrowBullets | SmartBlockData_ProcessSteps | SmartBlockData_Timeline | SmartBlockData_MinimalTimeline | SmartBlockData_Pills | SmartBlockData_StarRating | SmartBlockData_QuoteBoxes | SmartBlockData_Circle | SmartBlockData_Pyramid | SmartBlockData_Staircase | SmartBlockData_VerticalFunnel;
|
|
2581
|
+
type SmartBlockData_SolidBoxes = {
|
|
2582
|
+
/**
|
|
2583
|
+
* Variant type.
|
|
2584
|
+
* Must be `SOLID_BOXES`.
|
|
2585
|
+
*/
|
|
2586
|
+
type: 'SOLID_BOXES'; /** Number of columns per row. */
|
|
2587
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2588
|
+
/**
|
|
2589
|
+
* Node animation.
|
|
2590
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2591
|
+
*/
|
|
2592
|
+
animation?: Animation;
|
|
2593
|
+
};
|
|
2594
|
+
type SmartBlockData_NumberedBoxes = {
|
|
2595
|
+
/**
|
|
2596
|
+
* Variant type.
|
|
2597
|
+
* Must be `NUMBERED_BOXES`.
|
|
2598
|
+
*/
|
|
2599
|
+
type: 'NUMBERED_BOXES'; /** Number of columns per row. */
|
|
2600
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2601
|
+
/**
|
|
2602
|
+
* Node animation.
|
|
2603
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2604
|
+
*/
|
|
2605
|
+
animation?: Animation;
|
|
2606
|
+
};
|
|
2607
|
+
type SmartBlockData_Stats = {
|
|
2608
|
+
/**
|
|
2609
|
+
* Variant type.
|
|
2610
|
+
* Must be `STATS`.
|
|
2611
|
+
*/
|
|
2612
|
+
type: 'STATS'; /** Number of columns per row. */
|
|
2613
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2614
|
+
/**
|
|
2615
|
+
* Node animation.
|
|
2616
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2617
|
+
*/
|
|
2618
|
+
animation?: Animation;
|
|
2619
|
+
};
|
|
2620
|
+
type SmartBlockData_BarStats = {
|
|
2621
|
+
/**
|
|
2622
|
+
* Variant type.
|
|
2623
|
+
* Must be `BAR_STATS`.
|
|
2624
|
+
*/
|
|
2625
|
+
type: 'BAR_STATS'; /** Number of columns per row. */
|
|
2626
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2627
|
+
/**
|
|
2628
|
+
* Node animation.
|
|
2629
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2630
|
+
*/
|
|
2631
|
+
animation?: Animation;
|
|
2632
|
+
};
|
|
2633
|
+
type SmartBlockData_CircleStats = {
|
|
2634
|
+
/**
|
|
2635
|
+
* Variant type.
|
|
2636
|
+
* Must be `CIRCLE_STATS`.
|
|
2637
|
+
*/
|
|
2638
|
+
type: 'CIRCLE_STATS'; /** Number of columns per row. */
|
|
2639
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2640
|
+
/**
|
|
2641
|
+
* Node animation.
|
|
2642
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2643
|
+
*/
|
|
2644
|
+
animation?: Animation;
|
|
2645
|
+
};
|
|
2646
|
+
type SmartBlockData_SolidBoxesAlternating = {
|
|
2647
|
+
/**
|
|
2648
|
+
* Variant type.
|
|
2649
|
+
* Must be `SOLID_BOXES_ALTERNATING`.
|
|
2650
|
+
*/
|
|
2651
|
+
type: 'SOLID_BOXES_ALTERNATING'; /** Number of columns per row. */
|
|
2652
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2653
|
+
orientation?: SmartBlockData_Orientation;
|
|
2654
|
+
/**
|
|
2655
|
+
* Node animation.
|
|
2656
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2657
|
+
*/
|
|
2658
|
+
animation?: Animation;
|
|
2659
|
+
};
|
|
2660
|
+
type SmartBlockData_SolidJoinedBoxes = {
|
|
2661
|
+
/**
|
|
2662
|
+
* Variant type.
|
|
2663
|
+
* Must be `SOLID_JOINED_BOXES`.
|
|
2664
|
+
*/
|
|
2665
|
+
type: 'SOLID_JOINED_BOXES'; /** Number of columns per row. */
|
|
2666
|
+
columnSize?: SmartBlockData_ColumnSize; /** Border color as a hexadecimal value. */
|
|
2667
|
+
borderColor?: string; /** Border width in pixels. */
|
|
2668
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2669
|
+
borderRadius?: number;
|
|
2670
|
+
/**
|
|
2671
|
+
* Node animation.
|
|
2672
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2673
|
+
*/
|
|
2674
|
+
animation?: Animation;
|
|
2675
|
+
};
|
|
2676
|
+
type SmartBlockData_SideLineText = {
|
|
2677
|
+
/**
|
|
2678
|
+
* Variant type.
|
|
2679
|
+
* Must be `SIDE_LINE_TEXT`.
|
|
2680
|
+
*/
|
|
2681
|
+
type: 'SIDE_LINE_TEXT'; /** Number of columns per row. */
|
|
2682
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2683
|
+
/**
|
|
2684
|
+
* Node animation.
|
|
2685
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2686
|
+
*/
|
|
2687
|
+
animation?: Animation;
|
|
2688
|
+
};
|
|
2689
|
+
type SmartBlockData_TopLineText = {
|
|
2690
|
+
/**
|
|
2691
|
+
* Variant type.
|
|
2692
|
+
* Must be `TOP_LINE_TEXT`.
|
|
2693
|
+
*/
|
|
2694
|
+
type: 'TOP_LINE_TEXT'; /** Number of columns per row. */
|
|
2695
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2696
|
+
/**
|
|
2697
|
+
* Node animation.
|
|
2698
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2699
|
+
*/
|
|
2700
|
+
animation?: Animation;
|
|
2701
|
+
};
|
|
2702
|
+
type SmartBlockData_OutlineBoxesWithTopCircle = {
|
|
2703
|
+
/**
|
|
2704
|
+
* Variant type.
|
|
2705
|
+
* Must be `OUTLINE_BOXES_WITH_TOP_CIRCLE`.
|
|
2706
|
+
*/
|
|
2707
|
+
type: 'OUTLINE_BOXES_WITH_TOP_CIRCLE'; /** Number of columns per row. */
|
|
2708
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2709
|
+
/**
|
|
2710
|
+
* Node animation.
|
|
2711
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2712
|
+
*/
|
|
2713
|
+
animation?: Animation;
|
|
2714
|
+
};
|
|
2715
|
+
type SmartBlockData_BigBullets = {
|
|
2716
|
+
/**
|
|
2717
|
+
* Variant type.
|
|
2718
|
+
* Must be `BIG_BULLETS`.
|
|
2719
|
+
*/
|
|
2720
|
+
type: 'BIG_BULLETS'; /** Number of columns per row. */
|
|
2721
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2722
|
+
orientation?: SmartBlockData_Orientation;
|
|
2723
|
+
/**
|
|
2724
|
+
* Node animation.
|
|
2725
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2726
|
+
*/
|
|
2727
|
+
animation?: Animation;
|
|
2728
|
+
};
|
|
2729
|
+
type SmartBlockData_SmallBullets = {
|
|
2730
|
+
/**
|
|
2731
|
+
* Variant type.
|
|
2732
|
+
* Must be `SMALL_BULLETS`.
|
|
2733
|
+
*/
|
|
2734
|
+
type: 'SMALL_BULLETS'; /** Number of columns per row. */
|
|
2735
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2736
|
+
orientation?: SmartBlockData_Orientation;
|
|
2737
|
+
/**
|
|
2738
|
+
* Node animation.
|
|
2739
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2740
|
+
*/
|
|
2741
|
+
animation?: Animation;
|
|
2742
|
+
};
|
|
2743
|
+
type SmartBlockData_ArrowBullets = {
|
|
2744
|
+
/**
|
|
2745
|
+
* Variant type.
|
|
2746
|
+
* Must be `ARROW_BULLETS`.
|
|
2747
|
+
*/
|
|
2748
|
+
type: 'ARROW_BULLETS'; /** Number of columns per row. */
|
|
2749
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2750
|
+
orientation?: SmartBlockData_Orientation;
|
|
2751
|
+
/**
|
|
2752
|
+
* Node animation.
|
|
2753
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2754
|
+
*/
|
|
2755
|
+
animation?: Animation;
|
|
2756
|
+
};
|
|
2757
|
+
type SmartBlockData_ProcessSteps = {
|
|
2758
|
+
/**
|
|
2759
|
+
* Variant type.
|
|
2760
|
+
* Must be `PROCESS_STEPS`.
|
|
2761
|
+
*/
|
|
2762
|
+
type: 'PROCESS_STEPS'; /** Number of columns per row. */
|
|
2763
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2764
|
+
/**
|
|
2765
|
+
* Node animation.
|
|
2766
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2767
|
+
*/
|
|
2768
|
+
animation?: Animation;
|
|
2769
|
+
};
|
|
2770
|
+
type SmartBlockData_Timeline = {
|
|
2771
|
+
/**
|
|
2772
|
+
* Variant type.
|
|
2773
|
+
* Must be `TIMELINE`.
|
|
2774
|
+
*/
|
|
2775
|
+
type: 'TIMELINE'; /** Number of columns per row. Not exposed in the editor toolbar for TIMELINE (gated by the toolbar resolver), but kept in the schema for parity with the proto wire format which always carries this field. */
|
|
2776
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2777
|
+
orientation?: SmartBlockData_Orientation;
|
|
2778
|
+
/**
|
|
2779
|
+
* Node animation.
|
|
2780
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2781
|
+
*/
|
|
2782
|
+
animation?: Animation;
|
|
2783
|
+
};
|
|
2784
|
+
type SmartBlockData_MinimalTimeline = {
|
|
2785
|
+
/**
|
|
2786
|
+
* Variant type.
|
|
2787
|
+
* Must be `MINIMAL_TIMELINE`.
|
|
2788
|
+
*/
|
|
2789
|
+
type: 'MINIMAL_TIMELINE'; /** Number of columns per row. Not exposed in the editor toolbar for MINIMAL_TIMELINE (gated by the toolbar resolver), but kept in the schema for parity with the proto wire format which always carries this field. */
|
|
2790
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. */
|
|
2791
|
+
orientation?: SmartBlockData_Orientation;
|
|
2792
|
+
/**
|
|
2793
|
+
* Node animation.
|
|
2794
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2795
|
+
*/
|
|
2796
|
+
animation?: Animation;
|
|
2797
|
+
};
|
|
2798
|
+
type SmartBlockData_Pills = {
|
|
2799
|
+
/**
|
|
2800
|
+
* Variant type.
|
|
2801
|
+
* Must be `PILLS`.
|
|
2802
|
+
*/
|
|
2803
|
+
type: 'PILLS'; /** Number of columns per row. */
|
|
2804
|
+
columnSize?: SmartBlockData_ColumnSize; /** Layout orientation. HORIZONTAL places the pill on top of the cell content; VERTICAL places it on the left. */
|
|
2805
|
+
orientation?: SmartBlockData_Orientation;
|
|
2806
|
+
/**
|
|
2807
|
+
* Node animation.
|
|
2808
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2809
|
+
*/
|
|
2810
|
+
animation?: Animation;
|
|
2811
|
+
};
|
|
2812
|
+
type SmartBlockData_StarRating = {
|
|
2813
|
+
/**
|
|
2814
|
+
* Variant type.
|
|
2815
|
+
* Must be `STAR_RATING`.
|
|
2816
|
+
*/
|
|
2817
|
+
type: 'STAR_RATING'; /** Number of columns per row. */
|
|
2818
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2819
|
+
/**
|
|
2820
|
+
* Node animation.
|
|
2821
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2822
|
+
*/
|
|
2823
|
+
animation?: Animation;
|
|
2824
|
+
};
|
|
2825
|
+
type SmartBlockData_QuoteBoxes = {
|
|
2826
|
+
/**
|
|
2827
|
+
* Variant type.
|
|
2828
|
+
* Must be `QUOTE_BOXES`.
|
|
2829
|
+
*/
|
|
2830
|
+
type: 'QUOTE_BOXES'; /** Number of columns per row. */
|
|
2831
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2832
|
+
/**
|
|
2833
|
+
* Node animation.
|
|
2834
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2835
|
+
*/
|
|
2836
|
+
animation?: Animation;
|
|
2837
|
+
};
|
|
2838
|
+
type SmartBlockData_Circle = {
|
|
2839
|
+
/**
|
|
2840
|
+
* Variant type.
|
|
2841
|
+
* Must be `CIRCLE`.
|
|
2842
|
+
*/
|
|
2843
|
+
type: 'CIRCLE'; /** Number of columns per row. */
|
|
2844
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2845
|
+
/**
|
|
2846
|
+
* Node animation.
|
|
2847
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2848
|
+
*/
|
|
2849
|
+
animation?: Animation;
|
|
2850
|
+
};
|
|
2851
|
+
type SmartBlockData_Pyramid = {
|
|
2852
|
+
/**
|
|
2853
|
+
* Variant type.
|
|
2854
|
+
* Must be `PYRAMID`.
|
|
2855
|
+
*/
|
|
2856
|
+
type: 'PYRAMID'; /** Number of columns per row. Scales the overall pyramid width. */
|
|
2857
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2858
|
+
/**
|
|
2859
|
+
* Node animation.
|
|
2860
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2861
|
+
*/
|
|
2862
|
+
animation?: Animation;
|
|
2863
|
+
};
|
|
2864
|
+
type SmartBlockData_Staircase = {
|
|
2865
|
+
/**
|
|
2866
|
+
* Variant type.
|
|
2867
|
+
* Must be `STAIRCASE`.
|
|
2868
|
+
*/
|
|
2869
|
+
type: 'STAIRCASE'; /** Number of columns per row. */
|
|
2870
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2871
|
+
/**
|
|
2872
|
+
* Node animation.
|
|
2873
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2874
|
+
*/
|
|
2875
|
+
animation?: Animation;
|
|
2876
|
+
};
|
|
2877
|
+
type SmartBlockData_VerticalFunnel = {
|
|
2878
|
+
/**
|
|
2879
|
+
* Variant type.
|
|
2880
|
+
* Must be `VERTICAL_FUNNEL`.
|
|
2881
|
+
*/
|
|
2882
|
+
type: 'VERTICAL_FUNNEL'; /** Number of columns per row. Scales the overall funnel width. */
|
|
2883
|
+
columnSize?: SmartBlockData_ColumnSize;
|
|
2884
|
+
/**
|
|
2885
|
+
* Node animation.
|
|
2886
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
2887
|
+
*/
|
|
2888
|
+
animation?: Animation;
|
|
2889
|
+
};
|
|
2890
|
+
type SmartBlockData_ColumnSize = 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
2891
|
+
declare const SmartBlockData_ColumnSize: {
|
|
2892
|
+
readonly SMALL: 'SMALL';
|
|
2893
|
+
readonly MEDIUM: 'MEDIUM';
|
|
2894
|
+
readonly LARGE: 'LARGE';
|
|
2895
|
+
readonly EXTRA_LARGE: 'EXTRA_LARGE';
|
|
2896
|
+
};
|
|
2897
|
+
type SmartBlockData_Orientation = 'HORIZONTAL' | 'VERTICAL';
|
|
2898
|
+
declare const SmartBlockData_Orientation: {
|
|
2899
|
+
readonly HORIZONTAL: 'HORIZONTAL';
|
|
2900
|
+
readonly VERTICAL: 'VERTICAL';
|
|
2901
|
+
};
|
|
2902
|
+
/** A cell within a smart block containing title, body, and optional icon/image. */
|
|
2903
|
+
type SmartBlockCellNode = {
|
|
2904
|
+
/**
|
|
2905
|
+
* Node type.
|
|
2906
|
+
* Must be `SMART_BLOCK_CELL`.
|
|
2907
|
+
*/
|
|
2908
|
+
type: 'SMART_BLOCK_CELL'; /** Child nodes that the cell contains (heading, paragraph, image, etc.). */
|
|
2909
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
2910
|
+
id?: string; /** Cell-level variant data. */
|
|
2911
|
+
smartBlockCellData?: SmartBlockCellData;
|
|
2912
|
+
};
|
|
2913
|
+
/** Cell data discriminated by type. Type must match the parent SmartBlockData type. */
|
|
2914
|
+
type SmartBlockCellData = SmartBlockCellData_SolidBoxes | SmartBlockCellData_NumberedBoxes | SmartBlockCellData_Stats | SmartBlockCellData_BarStats | SmartBlockCellData_CircleStats | SmartBlockCellData_SolidBoxesAlternating | SmartBlockCellData_SolidJoinedBoxes | SmartBlockCellData_SideLineText | SmartBlockCellData_TopLineText | SmartBlockCellData_OutlineBoxesWithTopCircle | SmartBlockCellData_BigBullets | SmartBlockCellData_SmallBullets | SmartBlockCellData_ArrowBullets | SmartBlockCellData_ProcessSteps | SmartBlockCellData_Timeline | SmartBlockCellData_MinimalTimeline | SmartBlockCellData_Pills | SmartBlockCellData_StarRating | SmartBlockCellData_QuoteBoxes | SmartBlockCellData_Circle | SmartBlockCellData_Pyramid | SmartBlockCellData_Staircase | SmartBlockCellData_VerticalFunnel;
|
|
2915
|
+
type SmartBlockCellData_SolidBoxes = {
|
|
2916
|
+
/**
|
|
2917
|
+
* Cell data type.
|
|
2918
|
+
* Must be `SOLID_BOXES`.
|
|
2919
|
+
*/
|
|
2920
|
+
type: 'SOLID_BOXES'; /** Border color as a hexadecimal value. */
|
|
2921
|
+
borderColor?: string; /** Border width in pixels. */
|
|
2922
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2923
|
+
borderRadius?: number; /** Background color as a hexadecimal value. */
|
|
2924
|
+
backgroundColor?: string;
|
|
2925
|
+
};
|
|
2926
|
+
type SmartBlockCellData_NumberedBoxes = {
|
|
2927
|
+
/**
|
|
2928
|
+
* Cell data type.
|
|
2929
|
+
* Must be `NUMBERED_BOXES`.
|
|
2930
|
+
*/
|
|
2931
|
+
type: 'NUMBERED_BOXES'; /** Border color as a hexadecimal value. */
|
|
2932
|
+
borderColor?: string; /** Border width in pixels. */
|
|
2933
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2934
|
+
borderRadius?: number; /** Accent color as a hexadecimal value. */
|
|
2935
|
+
accentColor?: string; /** Shape file details. */
|
|
2936
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
2937
|
+
shapeColor?: string;
|
|
2938
|
+
};
|
|
2939
|
+
type SmartBlockCellData_Stats = {
|
|
2940
|
+
/**
|
|
2941
|
+
* Cell data type.
|
|
2942
|
+
* Must be `STATS`.
|
|
2943
|
+
*/
|
|
2944
|
+
type: 'STATS'; /** Cell label text. */
|
|
2945
|
+
label?: string; /** Border color as a hexadecimal value. */
|
|
2946
|
+
borderColor?: string; /** Border width in pixels. */
|
|
2947
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2948
|
+
borderRadius?: number; /** Accent color as a hexadecimal value. */
|
|
2949
|
+
accentColor?: string;
|
|
2950
|
+
};
|
|
2951
|
+
type SmartBlockCellData_BarStats = {
|
|
2952
|
+
/**
|
|
2953
|
+
* Cell data type.
|
|
2954
|
+
* Must be `BAR_STATS`.
|
|
2955
|
+
*/
|
|
2956
|
+
type: 'BAR_STATS'; /** Cell label text. */
|
|
2957
|
+
label?: string; /** Accent color as a hexadecimal value. */
|
|
2958
|
+
accentColor?: string;
|
|
2959
|
+
};
|
|
2960
|
+
type SmartBlockCellData_CircleStats = {
|
|
2961
|
+
/**
|
|
2962
|
+
* Cell data type.
|
|
2963
|
+
* Must be `CIRCLE_STATS`.
|
|
2964
|
+
*/
|
|
2965
|
+
type: 'CIRCLE_STATS'; /** Cell label text. */
|
|
2966
|
+
label?: string; /** Accent color as a hexadecimal value. */
|
|
2967
|
+
accentColor?: string;
|
|
2968
|
+
};
|
|
2969
|
+
type SmartBlockCellData_SolidBoxesAlternating = {
|
|
2970
|
+
/**
|
|
2971
|
+
* Cell data type.
|
|
2972
|
+
* Must be `SOLID_BOXES_ALTERNATING`.
|
|
2973
|
+
*/
|
|
2974
|
+
type: 'SOLID_BOXES_ALTERNATING'; /** Border color as a hexadecimal value. */
|
|
2975
|
+
borderColor?: string; /** Border width in pixels. */
|
|
2976
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
2977
|
+
borderRadius?: number; /** Background color as a hexadecimal value. */
|
|
2978
|
+
backgroundColor?: string;
|
|
2979
|
+
};
|
|
2980
|
+
type SmartBlockCellData_SolidJoinedBoxes = {
|
|
2981
|
+
/**
|
|
2982
|
+
* Cell data type.
|
|
2983
|
+
* Must be `SOLID_JOINED_BOXES`.
|
|
2984
|
+
*/
|
|
2985
|
+
type: 'SOLID_JOINED_BOXES'; /** Background color as a hexadecimal value. */
|
|
2986
|
+
backgroundColor?: string;
|
|
2987
|
+
};
|
|
2988
|
+
type SmartBlockCellData_SideLineText = {
|
|
2989
|
+
/**
|
|
2990
|
+
* Cell data type.
|
|
2991
|
+
* Must be `SIDE_LINE_TEXT`.
|
|
2992
|
+
*/
|
|
2993
|
+
type: 'SIDE_LINE_TEXT'; /** Accent color as a hexadecimal value. */
|
|
2994
|
+
accentColor?: string;
|
|
2995
|
+
};
|
|
2996
|
+
type SmartBlockCellData_TopLineText = {
|
|
2997
|
+
/**
|
|
2998
|
+
* Cell data type.
|
|
2999
|
+
* Must be `TOP_LINE_TEXT`.
|
|
3000
|
+
*/
|
|
3001
|
+
type: 'TOP_LINE_TEXT'; /** Accent color as a hexadecimal value. */
|
|
3002
|
+
accentColor?: string;
|
|
3003
|
+
};
|
|
3004
|
+
type SmartBlockCellData_OutlineBoxesWithTopCircle = {
|
|
3005
|
+
/**
|
|
3006
|
+
* Cell data type.
|
|
3007
|
+
* Must be `OUTLINE_BOXES_WITH_TOP_CIRCLE`.
|
|
3008
|
+
*/
|
|
3009
|
+
type: 'OUTLINE_BOXES_WITH_TOP_CIRCLE'; /** Accent color as a hexadecimal value. */
|
|
3010
|
+
accentColor?: string; /** Shape file details. */
|
|
3011
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3012
|
+
shapeColor?: string;
|
|
3013
|
+
};
|
|
3014
|
+
type SmartBlockCellData_BigBullets = {
|
|
3015
|
+
/**
|
|
3016
|
+
* Cell data type.
|
|
3017
|
+
* Must be `BIG_BULLETS`.
|
|
3018
|
+
*/
|
|
3019
|
+
type: 'BIG_BULLETS'; /** Border color as a hexadecimal value. */
|
|
3020
|
+
borderColor?: string; /** Border width in pixels. */
|
|
3021
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
3022
|
+
borderRadius?: number; /** Accent color as a hexadecimal value. */
|
|
3023
|
+
accentColor?: string; /** Shape file details. */
|
|
3024
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3025
|
+
shapeColor?: string;
|
|
3026
|
+
};
|
|
3027
|
+
type SmartBlockCellData_SmallBullets = {
|
|
3028
|
+
/**
|
|
3029
|
+
* Cell data type.
|
|
3030
|
+
* Must be `SMALL_BULLETS`.
|
|
3031
|
+
*/
|
|
3032
|
+
type: 'SMALL_BULLETS'; /** Border color as a hexadecimal value. */
|
|
3033
|
+
borderColor?: string; /** Border width in pixels. */
|
|
3034
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
3035
|
+
borderRadius?: number; /** Accent color as a hexadecimal value. */
|
|
3036
|
+
accentColor?: string;
|
|
3037
|
+
};
|
|
3038
|
+
type SmartBlockCellData_ArrowBullets = {
|
|
3039
|
+
/**
|
|
3040
|
+
* Cell data type.
|
|
3041
|
+
* Must be `ARROW_BULLETS`.
|
|
3042
|
+
*/
|
|
3043
|
+
type: 'ARROW_BULLETS'; /** Shape file details. */
|
|
3044
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3045
|
+
shapeColor?: string; /** Border color as a hexadecimal value. */
|
|
3046
|
+
borderColor?: string; /** Border width in pixels. */
|
|
3047
|
+
borderWidth?: number; /** Border radius in pixels. */
|
|
3048
|
+
borderRadius?: number; /** Accent color as a hexadecimal value. */
|
|
3049
|
+
accentColor?: string;
|
|
3050
|
+
};
|
|
3051
|
+
type SmartBlockCellData_ProcessSteps = {
|
|
3052
|
+
/**
|
|
3053
|
+
* Cell data type.
|
|
3054
|
+
* Must be `PROCESS_STEPS`.
|
|
3055
|
+
*/
|
|
3056
|
+
type: 'PROCESS_STEPS'; /** Accent color as a hexadecimal value. */
|
|
3057
|
+
accentColor?: string; /** Shape file details. */
|
|
3058
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3059
|
+
shapeColor?: string;
|
|
3060
|
+
};
|
|
3061
|
+
type SmartBlockCellData_Timeline = {
|
|
3062
|
+
/**
|
|
3063
|
+
* Cell data type.
|
|
3064
|
+
* Must be `TIMELINE`.
|
|
3065
|
+
*/
|
|
3066
|
+
type: 'TIMELINE'; /** Accent color as a hexadecimal value. */
|
|
3067
|
+
accentColor?: string; /** Shape file details. */
|
|
3068
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3069
|
+
shapeColor?: string;
|
|
3070
|
+
};
|
|
3071
|
+
type SmartBlockCellData_MinimalTimeline = {
|
|
3072
|
+
/**
|
|
3073
|
+
* Cell data type.
|
|
3074
|
+
* Must be `MINIMAL_TIMELINE`.
|
|
3075
|
+
*/
|
|
3076
|
+
type: 'MINIMAL_TIMELINE'; /** Accent color as a hexadecimal value. */
|
|
3077
|
+
accentColor?: string;
|
|
3078
|
+
};
|
|
3079
|
+
type SmartBlockCellData_Pills = {
|
|
3080
|
+
/**
|
|
3081
|
+
* Cell data type.
|
|
3082
|
+
* Must be `PILLS`.
|
|
3083
|
+
*/
|
|
3084
|
+
type: 'PILLS'; /** Pill background color as a hexadecimal value. */
|
|
3085
|
+
accentColor?: string; /** Shape file details rendered inside the pill instead of the cell number. */
|
|
3086
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3087
|
+
shapeColor?: string;
|
|
3088
|
+
};
|
|
3089
|
+
type SmartBlockCellData_StarRating = {
|
|
3090
|
+
/**
|
|
3091
|
+
* Cell data type.
|
|
3092
|
+
* Must be `STAR_RATING`.
|
|
3093
|
+
*/
|
|
3094
|
+
type: 'STAR_RATING'; /** Cell rating value as text (e.g. `3.5`). Drives the star fill. */
|
|
3095
|
+
label?: string; /** Accent color as a hexadecimal value. */
|
|
3096
|
+
accentColor?: string;
|
|
3097
|
+
};
|
|
3098
|
+
type SmartBlockCellData_QuoteBoxes = {
|
|
3099
|
+
/**
|
|
3100
|
+
* Cell data type.
|
|
3101
|
+
* Must be `QUOTE_BOXES`.
|
|
3102
|
+
*/
|
|
3103
|
+
type: 'QUOTE_BOXES'; /** Accent color as a hexadecimal value. Drives both the quote-glyph fill and the cell border. */
|
|
3104
|
+
accentColor?: string;
|
|
3105
|
+
};
|
|
3106
|
+
type SmartBlockCellData_Circle = {
|
|
3107
|
+
/**
|
|
3108
|
+
* Cell data type.
|
|
3109
|
+
* Must be `CIRCLE`.
|
|
3110
|
+
*/
|
|
3111
|
+
type: 'CIRCLE'; /** Accent color used to fill this cell's donut segment. */
|
|
3112
|
+
accentColor?: string; /** Shape rendered inside the segment in place of the auto-generated number. */
|
|
3113
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3114
|
+
shapeColor?: string;
|
|
3115
|
+
};
|
|
3116
|
+
type SmartBlockCellData_Pyramid = {
|
|
3117
|
+
/**
|
|
3118
|
+
* Cell data type.
|
|
3119
|
+
* Must be `PYRAMID`.
|
|
3120
|
+
*/
|
|
3121
|
+
type: 'PYRAMID'; /** Fill color of the pyramid slice as a hexadecimal value. */
|
|
3122
|
+
accentColor?: string; /** Shape file details rendered inside the slice instead of the cell number. */
|
|
3123
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3124
|
+
shapeColor?: string;
|
|
3125
|
+
};
|
|
3126
|
+
type SmartBlockCellData_Staircase = {
|
|
3127
|
+
/**
|
|
3128
|
+
* Cell data type.
|
|
3129
|
+
* Must be `STAIRCASE`.
|
|
3130
|
+
*/
|
|
3131
|
+
type: 'STAIRCASE'; /** Accent color as a hexadecimal value. Drives the staircase bar fill. */
|
|
3132
|
+
accentColor?: string; /** Shape file details rendered inside the bar instead of the cell number. */
|
|
3133
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3134
|
+
shapeColor?: string;
|
|
3135
|
+
};
|
|
3136
|
+
type SmartBlockCellData_VerticalFunnel = {
|
|
3137
|
+
/**
|
|
3138
|
+
* Cell data type.
|
|
3139
|
+
* Must be `VERTICAL_FUNNEL`.
|
|
3140
|
+
*/
|
|
3141
|
+
type: 'VERTICAL_FUNNEL'; /** Fill color of the funnel slice as a hexadecimal value. */
|
|
3142
|
+
accentColor?: string; /** Shape file details rendered inside the slice instead of the cell number. */
|
|
3143
|
+
shape?: Media; /** Shape fill color as a hexadecimal value. */
|
|
3144
|
+
shapeColor?: string;
|
|
3145
|
+
};
|
|
3146
|
+
/** Data in rows and columns. */
|
|
3147
|
+
type TableNode = {
|
|
3148
|
+
/**
|
|
3149
|
+
* Node type.
|
|
3150
|
+
* Must be `TABLE`.
|
|
3151
|
+
*/
|
|
3152
|
+
type: 'TABLE'; /** Child nodes to define table rows. */
|
|
3153
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
3154
|
+
id?: string; /** Table details. */
|
|
3155
|
+
tableData?: TableData;
|
|
3156
|
+
};
|
|
3157
|
+
type TableRowNode = {
|
|
3158
|
+
/**
|
|
3159
|
+
* Node type.
|
|
3160
|
+
* Must be `TABLE_ROW`.
|
|
3161
|
+
*/
|
|
3162
|
+
type: 'TABLE_ROW'; /** [Node ID](#node-ids). */
|
|
3163
|
+
id?: string; /** Child nodes to define table cells. */
|
|
3164
|
+
nodes?: RicosDocumentNode[];
|
|
3165
|
+
};
|
|
3166
|
+
type TableData = {
|
|
3167
|
+
/** Table container styling. */containerData?: PluginContainerData; /** Table dimensions. */
|
|
3168
|
+
dimensions?: TableData_Dimensions; /** Whether the table's first row is a heading. <br> Default: `false` */
|
|
3169
|
+
rowHeader?: boolean; /** Whether the table's first column is a heading. <br> Default: `false` */
|
|
3170
|
+
columnHeader?: boolean; /** The spacing between cells. */
|
|
3171
|
+
cellSpacing?: number;
|
|
3172
|
+
cellPadding?: number[]; /** Table's alternative text. */
|
|
3173
|
+
altText?: string;
|
|
3174
|
+
/**
|
|
3175
|
+
* Node animation.
|
|
3176
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
3177
|
+
*/
|
|
3178
|
+
animation?: Animation;
|
|
3179
|
+
};
|
|
3180
|
+
type TableData_Dimensions = {
|
|
3181
|
+
colsWidthRatio?: number[];
|
|
3182
|
+
rowsHeight?: number[];
|
|
3183
|
+
colsMinWidth?: number[];
|
|
3184
|
+
};
|
|
3185
|
+
type TableCellNode = {
|
|
3186
|
+
/**
|
|
3187
|
+
* Node type.
|
|
3188
|
+
* Must be `TABLE_CELL`.
|
|
3189
|
+
*/
|
|
3190
|
+
type: 'TABLE_CELL'; /** Child nodes to define cell content. */
|
|
3191
|
+
nodes: RicosDocumentNode[]; /** [Node ID](#node-ids). */
|
|
3192
|
+
id?: string; /** Table cell details. */
|
|
3193
|
+
tableCellData?: TableCellData;
|
|
3194
|
+
};
|
|
3195
|
+
type TableCellData = {
|
|
3196
|
+
/** Cell styling. */cellStyle?: TableCellData_CellStyle; /** Cell border colors. */
|
|
3197
|
+
borderColors?: TableCellData_BorderColors; /** Cell border widths. */
|
|
3198
|
+
borderWidths?: TableCellData_BorderWidths; /** Defines how many columns the cell spans. */
|
|
3199
|
+
colspan?: number; /** Defines how many rows the cell spans. */
|
|
3200
|
+
rowspan?: number;
|
|
3201
|
+
};
|
|
3202
|
+
type TableCellData_CellStyle = {
|
|
3203
|
+
/** Vertical alignment for the cell's text. */verticalAlignment?: 'TOP' | 'MIDDLE' | 'BOTTOM'; /** Cell background color as a hexadecimal value. */
|
|
3204
|
+
backgroundColor?: string;
|
|
3205
|
+
};
|
|
3206
|
+
type TableCellData_BorderColors = {
|
|
3207
|
+
/** Left border color as a hexadecimal value. */left?: string; /** Right border color as a hexadecimal value. */
|
|
3208
|
+
right?: string; /** Top border color as a hexadecimal value. */
|
|
3209
|
+
top?: string; /** Bottom border color as a hexadecimal value. */
|
|
3210
|
+
bottom?: string;
|
|
3211
|
+
};
|
|
3212
|
+
type TableCellData_BorderWidths = {
|
|
3213
|
+
/** Left border width. */left?: number; /** Right border width. */
|
|
3214
|
+
right?: number; /** Top border width. */
|
|
3215
|
+
top?: number; /** Bottom border width. */
|
|
3216
|
+
bottom?: number;
|
|
3217
|
+
};
|
|
3218
|
+
/** Dynamic table of contents block that renders links to headings in the document. */
|
|
3219
|
+
type TocNode = {
|
|
3220
|
+
/**
|
|
3221
|
+
* Node type.
|
|
3222
|
+
* Must be `TOC`.
|
|
3223
|
+
*/
|
|
3224
|
+
type: 'TOC'; /** [Node ID](#node-ids). */
|
|
3225
|
+
id?: string; /** Table of contents block settings. */
|
|
3226
|
+
tocData?: TocData;
|
|
3227
|
+
nodes?: RicosDocumentNode[];
|
|
3228
|
+
};
|
|
3229
|
+
type TocData = {
|
|
3230
|
+
includedHeadings?: number[]; /** List style. Default: `NUMBERED`. */
|
|
3231
|
+
listStyle?: TocData_ListStyle; /** Optional override for the font size in pixels. */
|
|
3232
|
+
fontSize?: number; /** Optional override for the vertical spacing between items in pixels. */
|
|
3233
|
+
itemSpacing?: number; /** Optional override for the text color. */
|
|
3234
|
+
color?: string; /** Indentation style. Default: `NESTED`. */
|
|
3235
|
+
indentation?: TocData_Indentation;
|
|
3236
|
+
/**
|
|
3237
|
+
* Node animation.
|
|
3238
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
3239
|
+
*/
|
|
3240
|
+
animation?: Animation;
|
|
3241
|
+
};
|
|
3242
|
+
type TocData_ListStyle = 'BULLETED' | 'NUMBERED' | 'LETTERS' | 'ROMAN' | 'PLAIN' | 'ALPHABETICAL_INDEX' | 'ALPHABETICAL_INDEX_COMPACT';
|
|
3243
|
+
declare const TocData_ListStyle: {
|
|
3244
|
+
readonly BULLETED: 'BULLETED';
|
|
3245
|
+
readonly NUMBERED: 'NUMBERED';
|
|
3246
|
+
readonly LETTERS: 'LETTERS';
|
|
3247
|
+
readonly ROMAN: 'ROMAN';
|
|
3248
|
+
readonly PLAIN: 'PLAIN';
|
|
3249
|
+
readonly ALPHABETICAL_INDEX: 'ALPHABETICAL_INDEX';
|
|
3250
|
+
readonly ALPHABETICAL_INDEX_COMPACT: 'ALPHABETICAL_INDEX_COMPACT';
|
|
3251
|
+
};
|
|
3252
|
+
type TocData_Indentation = 'NESTED' | 'FLAT';
|
|
3253
|
+
declare const TocData_Indentation: {
|
|
3254
|
+
readonly NESTED: 'NESTED';
|
|
3255
|
+
readonly FLAT: 'FLAT';
|
|
3256
|
+
};
|
|
3257
|
+
/** Embeds and plays video content directly in a page. When rendered, it is displayed as the video player with the specified video file. Users can interact with the controls to play, pause, rewind, and adjust the volume of the video. */
|
|
3258
|
+
type VideoNode = {
|
|
3259
|
+
/**
|
|
3260
|
+
* Node type.
|
|
3261
|
+
* Must be `VIDEO`.
|
|
3262
|
+
*/
|
|
3263
|
+
type: 'VIDEO'; /** Video details. */
|
|
3264
|
+
videoData: VideoData; /** [Node ID](#node-ids). */
|
|
3265
|
+
id?: string; /** Child nodes to define a video caption. */
|
|
3266
|
+
nodes?: RicosDocumentNode[];
|
|
3267
|
+
};
|
|
3268
|
+
type VideoData = {
|
|
3269
|
+
/** Video file details. */video: Media; /** Video container styling. */
|
|
3270
|
+
containerData?: PluginContainerData; /** Video thumbnail details. */
|
|
3271
|
+
thumbnail?: Media;
|
|
3272
|
+
/**
|
|
3273
|
+
* Whether the video download button is disabled.
|
|
3274
|
+
* Default: `false`
|
|
3275
|
+
*/
|
|
3276
|
+
disableDownload?: boolean; /** Video title. */
|
|
3277
|
+
title?: string; /** Playback details. */
|
|
3278
|
+
options?: PlaybackOptions;
|
|
3279
|
+
/**
|
|
3280
|
+
* Node animation.
|
|
3281
|
+
* **Note:** This property requires the animation feature to be enabled.
|
|
3282
|
+
*/
|
|
3283
|
+
animation?: Animation;
|
|
3284
|
+
};
|
|
3285
|
+
type PlaybackOptions = {
|
|
3286
|
+
/** Whether the media automatically starts playing after opening a page. */autoPlay?: boolean; /** Whether the media is looped. */
|
|
3287
|
+
playInLoop?: boolean; /** Whether to show the media controls. */
|
|
3288
|
+
showControls?: boolean;
|
|
3289
|
+
};
|
|
3290
|
+
/** Union of all Ricos document node types. */
|
|
3291
|
+
type RicosDocumentNode = BlockquoteNode | CaptionNode | CardNode | CodeBlockNode | HeadingNode | LayoutNode | LayoutCellNode | OrderedListNode | BulletedListNode | CheckboxListNode | ListItemNode | ParagraphNode | TextNode | AppEmbedNode | AudioNode | ButtonNode | CollapsibleListNode | CollapsibleItemNode | CollapsibleItemTitleNode | CollapsibleItemBodyNode | DividerNode | EmbedNode | ExternalNode | FileNode | GalleryNode | GifNode | HtmlNode | ImageNode | LinkPreviewNode | PollNode | ShapeNode | SlotNode | SmartBlockNode | SmartBlockCellNode | TableNode | TableRowNode | TableCellNode | TocNode | VideoNode;
|
|
3292
|
+
//#endregion
|
|
3293
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/links.d.ts
|
|
3294
|
+
type LinkTarget = '_self' | '_blank';
|
|
3295
|
+
/**
|
|
3296
|
+
* A link to a URL, used for navigation within components.
|
|
3297
|
+
*
|
|
3298
|
+
* @example
|
|
3299
|
+
* ```tsx
|
|
3300
|
+
* import type { Link } from '@wix/editor-react-types';
|
|
3301
|
+
*
|
|
3302
|
+
* interface MyComponentProps {
|
|
3303
|
+
* link?: Link;
|
|
3304
|
+
* }
|
|
3305
|
+
* ```
|
|
3306
|
+
*/
|
|
3307
|
+
type Link = {
|
|
3308
|
+
/**
|
|
3309
|
+
* The link URL. For partial links (see `pageRole`), this is the router prefix
|
|
3310
|
+
* (e.g. `https://www.my-site.com/prefix`) rather than a fully resolved URL.
|
|
3311
|
+
*/
|
|
3312
|
+
href?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Where this link should open.
|
|
3315
|
+
* - `'_self'` — opens in the same page.
|
|
3316
|
+
* - `'_blank'` — opens in a new tab.
|
|
3317
|
+
*/
|
|
3318
|
+
target?: LinkTarget; /** The `rel` attribute of the link. Accepts LinkRel values separated by a space. */
|
|
3319
|
+
rel?: string;
|
|
3320
|
+
/**
|
|
3321
|
+
* Page role identifier. Present only on partial links, where only the router prefix is
|
|
3322
|
+
* known and the full URL format is owned by the Router/App. Applications can use such
|
|
3323
|
+
* links in functions to resolve the complete URL at runtime (e.g. for binding links).
|
|
3324
|
+
* Resolved links will not have this field.
|
|
3325
|
+
*/
|
|
3326
|
+
pageRole?: string;
|
|
3327
|
+
};
|
|
3328
|
+
//#endregion
|
|
3329
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/image.d.ts
|
|
3330
|
+
type Point = {
|
|
3331
|
+
x: number;
|
|
3332
|
+
y: number;
|
|
3333
|
+
};
|
|
3334
|
+
type Crop = Point & {
|
|
3335
|
+
width: number;
|
|
3336
|
+
height: number;
|
|
3337
|
+
};
|
|
3338
|
+
/**
|
|
3339
|
+
* An image from Wix Media.
|
|
3340
|
+
*
|
|
3341
|
+
* @example
|
|
3342
|
+
* ```tsx
|
|
3343
|
+
* import type { Image } from '@wix/editor-react-types';
|
|
3344
|
+
*
|
|
3345
|
+
* interface MyComponentProps {
|
|
3346
|
+
* image?: Image;
|
|
3347
|
+
* }
|
|
3348
|
+
*
|
|
3349
|
+
* const MyComponent = ({ image }: MyComponentProps) => (
|
|
3350
|
+
* <img src={image?.url} alt={image?.alt} />
|
|
3351
|
+
* );
|
|
3352
|
+
* ```
|
|
3353
|
+
*/
|
|
3354
|
+
type Image = {
|
|
3355
|
+
/** The image URI. */uri?: string; /** The image URL. */
|
|
3356
|
+
url: string; /** The image file name. */
|
|
3357
|
+
name?: string; /** The image height in pixels. */
|
|
3358
|
+
height?: number; /** The image width in pixels. */
|
|
3359
|
+
width?: number; /** Whether the image is animated (e.g. GIF). */
|
|
3360
|
+
animated?: boolean; /** The crop region applied to the image. */
|
|
3361
|
+
crop?: Crop; /** The image quality, as a percentage from 0 to 100. */
|
|
3362
|
+
quality?: number; /** The image alt text for accessibility. */
|
|
3363
|
+
alt?: string;
|
|
3364
|
+
};
|
|
3365
|
+
//#endregion
|
|
3366
|
+
//#region ../../node_modules/type-fest/source/observable-like.d.ts
|
|
3367
|
+
declare global {
|
|
3368
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
3369
|
+
interface SymbolConstructor {
|
|
3370
|
+
readonly observable: symbol;
|
|
3371
|
+
}
|
|
3372
|
+
}
|
|
3373
|
+
/**
|
|
3374
|
+
@remarks
|
|
3375
|
+
The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
|
|
3376
|
+
As well, some guidance on making an `Observable` to not include `closed` property.
|
|
3377
|
+
@see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
|
|
3378
|
+
@see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
|
|
3379
|
+
@see https://github.com/benlesh/symbol-observable#making-an-object-observable
|
|
3380
|
+
|
|
3381
|
+
@category Observable
|
|
3382
|
+
*/
|
|
3383
|
+
//#endregion
|
|
3384
|
+
//#region ../../node_modules/@wix/sdk-types/internal/build/index.d.ts
|
|
3385
|
+
declare global {
|
|
3386
|
+
interface ContextualClient {}
|
|
3387
|
+
}
|
|
3388
|
+
/**
|
|
3389
|
+
* Creates concrete types from SDK descriptors when a contextual client is
|
|
3390
|
+
* available.
|
|
3391
|
+
*
|
|
3392
|
+
* For a REST descriptor the built (bound) API is intersected with the original
|
|
3393
|
+
* descriptor, matching what `contextualizeRESTModuleV2` returns at runtime — a
|
|
3394
|
+
* value callable as the bound API and still usable as a descriptor. Keeping the
|
|
3395
|
+
* descriptor half lets contextual modules be passed to descriptor-constrained
|
|
3396
|
+
* helpers such as `elevate` from `@wix/sdk/context` (FEDINF-14092).
|
|
3397
|
+
*
|
|
3398
|
+
* The `& T` is scoped to REST descriptors — the only shape codegen wraps in
|
|
3399
|
+
* `MaybeContext` — so `BuildDescriptors` (used by `createClient().use`) is left
|
|
3400
|
+
* unchanged and stays bound-only. The fix lives here rather than in `elevate`,
|
|
3401
|
+
* which is kept strict on purpose (see #941) so it still rejects bound-only
|
|
3402
|
+
* functions that are unsafe through `createRESTModule`.
|
|
3403
|
+
*/
|
|
3404
|
+
declare global {
|
|
3405
|
+
/**
|
|
3406
|
+
* A global interface to set the exposure toggle for the SDK.
|
|
3407
|
+
* @example
|
|
3408
|
+
* ```ts
|
|
3409
|
+
* declare global {
|
|
3410
|
+
* interface SDKExposureToggle {
|
|
3411
|
+
* alpha: true;
|
|
3412
|
+
* }
|
|
3413
|
+
* }
|
|
3414
|
+
*/
|
|
3415
|
+
interface SDKExposureToggle {}
|
|
3416
|
+
}
|
|
3417
|
+
declare global {
|
|
3418
|
+
/**
|
|
3419
|
+
* A global interface to set the type mode for the SDK.
|
|
3420
|
+
* @example
|
|
3421
|
+
* ```ts
|
|
3422
|
+
* declare global {
|
|
3423
|
+
* interface SDKTypeMode {
|
|
3424
|
+
* strict: true;
|
|
3425
|
+
* }
|
|
3426
|
+
* }
|
|
3427
|
+
*/
|
|
3428
|
+
interface SDKTypeMode {}
|
|
3429
|
+
}
|
|
3430
|
+
//#endregion
|
|
3431
|
+
//#region src/domain/category/category.d.ts
|
|
3432
|
+
type CategoryImage = Image;
|
|
3433
|
+
interface CategoryBreadcrumb {
|
|
3434
|
+
id: string;
|
|
3435
|
+
name: string;
|
|
3436
|
+
slug: string;
|
|
3437
|
+
href: string;
|
|
3438
|
+
}
|
|
3439
|
+
interface CategorySeoTag {
|
|
3440
|
+
type?: string;
|
|
3441
|
+
props?: Record<string, unknown>;
|
|
3442
|
+
meta?: Record<string, unknown>;
|
|
3443
|
+
children?: string;
|
|
3444
|
+
custom?: boolean;
|
|
3445
|
+
disabled?: boolean;
|
|
3446
|
+
}
|
|
3447
|
+
interface CategorySeoKeyword {
|
|
3448
|
+
term?: string;
|
|
3449
|
+
isMain?: boolean;
|
|
3450
|
+
origin?: string;
|
|
3451
|
+
}
|
|
3452
|
+
interface CategorySeoSettings {
|
|
3453
|
+
preventAutoRedirect?: boolean;
|
|
3454
|
+
keywords?: CategorySeoKeyword[];
|
|
3455
|
+
}
|
|
3456
|
+
interface CategorySeoData {
|
|
3457
|
+
tags?: CategorySeoTag[];
|
|
3458
|
+
settings?: CategorySeoSettings;
|
|
3459
|
+
}
|
|
3460
|
+
interface Category {
|
|
3461
|
+
id: string;
|
|
3462
|
+
name: string;
|
|
3463
|
+
slug: string;
|
|
3464
|
+
description?: string;
|
|
3465
|
+
itemCounter?: number;
|
|
3466
|
+
parentCategoryId?: string;
|
|
3467
|
+
seoData?: CategorySeoData;
|
|
3468
|
+
richContentDescription?: RicosDocument;
|
|
3469
|
+
image?: CategoryImage;
|
|
3470
|
+
breadcrumbs: CategoryBreadcrumb[];
|
|
3471
|
+
}
|
|
3472
|
+
//#endregion
|
|
3473
|
+
//#region src/extensions/gallery/providers/category-info-context/contract.d.ts
|
|
3474
|
+
interface CategoryInfoContextValue {
|
|
3475
|
+
/** Category id. Pass this to product queries to scope them to the current category. */
|
|
3476
|
+
id: string;
|
|
3477
|
+
/** Category's display name. */
|
|
3478
|
+
name: string;
|
|
3479
|
+
/** Category's URL slug */
|
|
3480
|
+
slug: string;
|
|
3481
|
+
/** Link to the category's page */
|
|
3482
|
+
link: Link | undefined;
|
|
3483
|
+
/**
|
|
3484
|
+
* Plain-text category description. `undefined` when the category has no description.
|
|
3485
|
+
* Prefer {@link richContentDescription} for display — this one is the unformatted fallback,
|
|
3486
|
+
* useful for meta tags and single-line summaries.
|
|
3487
|
+
*/
|
|
3488
|
+
description: string | undefined;
|
|
3489
|
+
/** Category's description as a Ricos rich-text document. */
|
|
3490
|
+
richContentDescription: RicosDocument | undefined;
|
|
3491
|
+
/** Category image, with `uri`/`width`/`height` parsed off the Wix media URL. `undefined` when unset. */
|
|
3492
|
+
image: CategoryImage | undefined;
|
|
3493
|
+
/**
|
|
3494
|
+
* Ancestor trail from the top-level category down to the parent of the current
|
|
3495
|
+
* category, each with its category ID and a ready-to-use `href`. The current
|
|
3496
|
+
* category is not included — consumers append it themselves. Empty for a
|
|
3497
|
+
* top-level category.
|
|
3498
|
+
*/
|
|
3499
|
+
breadcrumbs: CategoryBreadcrumb[];
|
|
3500
|
+
}
|
|
3501
|
+
//#endregion
|
|
3502
|
+
//#region src/extensions/gallery/providers/hooks/use-category-context-value/use-category-info/use-category-info.d.ts
|
|
3503
|
+
declare function useCategoryInfo(category: Category): {
|
|
3504
|
+
id: string;
|
|
3505
|
+
name: string;
|
|
3506
|
+
slug: string;
|
|
3507
|
+
link: Link | undefined;
|
|
3508
|
+
description: string | undefined;
|
|
3509
|
+
richContentDescription: RicosDocument | undefined;
|
|
3510
|
+
image: Image | undefined;
|
|
3511
|
+
breadcrumbs: CategoryBreadcrumb[];
|
|
3512
|
+
};
|
|
3513
|
+
//#endregion
|
|
3514
|
+
//#region src/extensions/gallery/providers/category-info-context/category-info-context-provider.d.ts
|
|
3515
|
+
type CategoryInfoContextImplementation = ReturnType<typeof useCategoryInfo>;
|
|
3516
|
+
/** Reads the category details supplied by a surrounding category info provider. */
|
|
3517
|
+
declare function useCategoryInfoContext(): CategoryInfoContextValue;
|
|
3518
|
+
/** Props accepted by {@link CategoryInfoContextProvider}. */
|
|
3519
|
+
interface CategoryInfoContextProviderProps extends React.PropsWithChildren {
|
|
3520
|
+
value?: CategoryInfoContextValue;
|
|
3521
|
+
categoryId?: string;
|
|
3522
|
+
}
|
|
3523
|
+
/** Supplies category details from an explicit value or a configured category ID. */
|
|
3524
|
+
declare function CategoryInfoContextProvider({
|
|
3525
|
+
children,
|
|
3526
|
+
value,
|
|
3527
|
+
categoryId
|
|
3528
|
+
}: CategoryInfoContextProviderProps): React.ReactNode;
|
|
3529
|
+
|
|
3530
|
+
export { type CategoryInfoContextImplementation, CategoryInfoContextProvider, type CategoryInfoContextProviderProps, type CategoryInfoContextValue, CategoryInfoContextProvider as default, useCategoryInfoContext };
|