@wix/blog 1.0.690 → 1.0.692
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-blog-feed-context-provider/runtime.d.ts +483 -0
- package/_sdk-exports/context-blog-feed-context-provider/runtime.js +5 -0
- package/_sdk-exports/context-category-item-context-provider/runtime.d.ts +189 -0
- package/_sdk-exports/context-category-item-context-provider/runtime.js +2 -0
- package/_sdk-exports/context-post-by-id-context-provider/runtime.d.ts +31 -0
- package/_sdk-exports/context-post-by-id-context-provider/runtime.js +5 -0
- package/_sdk-exports/context-post-context-provider/runtime.d.ts +3213 -0
- package/_sdk-exports/context-post-context-provider/runtime.js +5 -0
- package/_sdk-exports/context-post-item-context-provider/runtime.d.ts +386 -0
- package/_sdk-exports/context-post-item-context-provider/runtime.js +5 -0
- package/_sdk-exports/context-related-posts-context-provider/runtime.d.ts +341 -0
- package/_sdk-exports/context-related-posts-context-provider/runtime.js +5 -0
- package/_sdk-exports/context-tag-item-context-provider/runtime.d.ts +185 -0
- package/_sdk-exports/context-tag-item-context-provider/runtime.js +2 -0
- package/blog-feed-context-provider/package.json +3 -0
- package/build/cjs/context-blog-feed-context-provider.d.ts +483 -0
- package/build/cjs/context-blog-feed-context-provider.js +4601 -0
- package/build/cjs/context-blog-feed-context-provider.js.map +1 -0
- package/build/cjs/context-category-item-context-provider.d.ts +189 -0
- package/build/cjs/context-category-item-context-provider.js +578 -0
- package/build/cjs/context-category-item-context-provider.js.map +1 -0
- package/build/cjs/context-post-by-id-context-provider.d.ts +31 -0
- package/build/cjs/context-post-by-id-context-provider.js +4531 -0
- package/build/cjs/context-post-by-id-context-provider.js.map +1 -0
- package/build/cjs/context-post-context-provider.d.ts +3213 -0
- package/build/cjs/context-post-context-provider.js +5404 -0
- package/build/cjs/context-post-context-provider.js.map +1 -0
- package/build/cjs/context-post-item-context-provider.d.ts +386 -0
- package/build/cjs/context-post-item-context-provider.js +3682 -0
- package/build/cjs/context-post-item-context-provider.js.map +1 -0
- package/build/cjs/context-related-posts-context-provider.d.ts +341 -0
- package/build/cjs/context-related-posts-context-provider.js +4355 -0
- package/build/cjs/context-related-posts-context-provider.js.map +1 -0
- package/build/cjs/context-tag-item-context-provider.d.ts +185 -0
- package/build/cjs/context-tag-item-context-provider.js +578 -0
- package/build/cjs/context-tag-item-context-provider.js.map +1 -0
- package/build/es/context-blog-feed-context-provider.d.mts +483 -0
- package/build/es/context-blog-feed-context-provider.mjs +4571 -0
- package/build/es/context-blog-feed-context-provider.mjs.map +1 -0
- package/build/es/context-category-item-context-provider.d.mts +189 -0
- package/build/es/context-category-item-context-provider.mjs +549 -0
- package/build/es/context-category-item-context-provider.mjs.map +1 -0
- package/build/es/context-post-by-id-context-provider.d.mts +31 -0
- package/build/es/context-post-by-id-context-provider.mjs +4491 -0
- package/build/es/context-post-by-id-context-provider.mjs.map +1 -0
- package/build/es/context-post-context-provider.d.mts +3213 -0
- package/build/es/context-post-context-provider.mjs +5374 -0
- package/build/es/context-post-context-provider.mjs.map +1 -0
- package/build/es/context-post-item-context-provider.d.mts +386 -0
- package/build/es/context-post-item-context-provider.mjs +3652 -0
- package/build/es/context-post-item-context-provider.mjs.map +1 -0
- package/build/es/context-related-posts-context-provider.d.mts +341 -0
- package/build/es/context-related-posts-context-provider.mjs +4325 -0
- package/build/es/context-related-posts-context-provider.mjs.map +1 -0
- package/build/es/context-tag-item-context-provider.d.mts +185 -0
- package/build/es/context-tag-item-context-provider.mjs +549 -0
- package/build/es/context-tag-item-context-provider.mjs.map +1 -0
- package/build/internal/cjs/context-blog-feed-context-provider.d.ts +483 -0
- package/build/internal/cjs/context-category-item-context-provider.d.ts +189 -0
- package/build/internal/cjs/context-post-by-id-context-provider.d.ts +31 -0
- package/build/internal/cjs/context-post-context-provider.d.ts +3213 -0
- package/build/internal/cjs/context-post-item-context-provider.d.ts +386 -0
- package/build/internal/cjs/context-related-posts-context-provider.d.ts +341 -0
- package/build/internal/cjs/context-tag-item-context-provider.d.ts +185 -0
- package/build/internal/es/context-blog-feed-context-provider.d.mts +483 -0
- package/build/internal/es/context-category-item-context-provider.d.mts +189 -0
- package/build/internal/es/context-post-by-id-context-provider.d.mts +31 -0
- package/build/internal/es/context-post-context-provider.d.mts +3213 -0
- package/build/internal/es/context-post-item-context-provider.d.mts +386 -0
- package/build/internal/es/context-related-posts-context-provider.d.mts +341 -0
- package/build/internal/es/context-tag-item-context-provider.d.mts +185 -0
- package/category-item-context-provider/package.json +3 -0
- package/context/blog-feed-context-provider/package.json +3 -0
- package/context/category-item-context-provider/package.json +3 -0
- package/context/post-by-id-context-provider/package.json +3 -0
- package/context/post-context-provider/package.json +3 -0
- package/context/post-item-context-provider/package.json +3 -0
- package/context/related-posts-context-provider/package.json +3 -0
- package/context/tag-item-context-provider/package.json +3 -0
- package/package.json +104 -5
- package/post-by-id-context-provider/package.json +3 -0
- package/post-context-provider/package.json +3 -0
- package/post-item-context-provider/package.json +3 -0
- package/related-posts-context-provider/package.json +3 -0
- package/tag-item-context-provider/package.json +3 -0
|
@@ -0,0 +1,3213 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
|
|
3
|
+
//#region src/hooks/post-likes.types.d.ts
|
|
4
|
+
interface PostLikes {
|
|
5
|
+
isLiked: boolean;
|
|
6
|
+
/** Server count adjusted by the viewer's optimistic toggle delta. */
|
|
7
|
+
likeCount: number;
|
|
8
|
+
/**
|
|
9
|
+
* False while the fresh like-count read is in flight (always false on SSR) — the
|
|
10
|
+
* Counters widget renders a skeleton instead of a possibly-stale number until it flips.
|
|
11
|
+
* A skipped read (editor, preview, no post id) and a failed read both settle to true
|
|
12
|
+
* with the baked count, so the skeleton never outlives its fetch.
|
|
13
|
+
*/
|
|
14
|
+
isLikeCountLoaded: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* View and comment totals off the same metrics read, `undefined` until it lands (and for
|
|
17
|
+
* good on the editor/preview paths that skip it). Nothing bakes these into SSR HTML, so a
|
|
18
|
+
* consumer must render nothing rather than a zero while they are `undefined`.
|
|
19
|
+
*/
|
|
20
|
+
viewCount: number | undefined;
|
|
21
|
+
commentCount: number | undefined;
|
|
22
|
+
toggleLike: (pointerEvent?: PointerEvent) => Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* The same like state, live: updated synchronously, while the fields above update in a
|
|
25
|
+
* transition. Stable identity — publish it on the context value as is.
|
|
26
|
+
*/
|
|
27
|
+
liveLikes: LiveLikes;
|
|
28
|
+
}
|
|
29
|
+
/** What `LiveLikes` reports — the `PostLikes` fields a widget renders. */
|
|
30
|
+
type LiveLikeSnapshot = Pick<PostLikes, 'isLiked' | 'likeCount' | 'isLikeCountLoaded' | 'viewCount' | 'commentCount'>;
|
|
31
|
+
/**
|
|
32
|
+
* Why the like state exists twice: on a hydrating post page, a provider state update that is
|
|
33
|
+
* NOT a transition makes React discard the server HTML of every child boundary still waiting
|
|
34
|
+
* on its module load or the viewport gate (React #421 — thunderbolt logs "SSR HTML discard").
|
|
35
|
+
* So the provider's own state updates only in transitions — but a transition is held until
|
|
36
|
+
* every boundary below has hydrated, which for a viewport-gated one means until the visitor
|
|
37
|
+
* scrolls to it. The Counters and Actions widgets subscribe here instead, after their own
|
|
38
|
+
* mount, and show the fresh numbers right away (`usePostWidgetContext`).
|
|
39
|
+
*/
|
|
40
|
+
interface LiveLikes {
|
|
41
|
+
get(): LiveLikeSnapshot;
|
|
42
|
+
subscribe(listener: () => void): () => void;
|
|
43
|
+
}
|
|
44
|
+
//#endregion
|
|
45
|
+
//#region ../../node_modules/type-fest/source/observable-like.d.ts
|
|
46
|
+
declare global {
|
|
47
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
48
|
+
interface SymbolConstructor {
|
|
49
|
+
readonly observable: symbol;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
@remarks
|
|
54
|
+
The TC39 observable proposal defines a `closed` property, but some implementations (such as xstream) do not as of 10/08/2021.
|
|
55
|
+
As well, some guidance on making an `Observable` to not include `closed` property.
|
|
56
|
+
@see https://github.com/tc39/proposal-observable/blob/master/src/Observable.js#L129-L130
|
|
57
|
+
@see https://github.com/staltz/xstream/blob/6c22580c1d84d69773ee4b0905df44ad464955b3/src/index.ts#L79-L85
|
|
58
|
+
@see https://github.com/benlesh/symbol-observable#making-an-object-observable
|
|
59
|
+
|
|
60
|
+
@category Observable
|
|
61
|
+
*/
|
|
62
|
+
//#endregion
|
|
63
|
+
//#region ../../node_modules/@wix/sdk-types/build/index.d.ts
|
|
64
|
+
declare global {
|
|
65
|
+
interface ContextualClient {}
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Creates concrete types from SDK descriptors when a contextual client is
|
|
69
|
+
* available.
|
|
70
|
+
*
|
|
71
|
+
* For a REST descriptor the built (bound) API is intersected with the original
|
|
72
|
+
* descriptor, matching what `contextualizeRESTModuleV2` returns at runtime — a
|
|
73
|
+
* value callable as the bound API and still usable as a descriptor. Keeping the
|
|
74
|
+
* descriptor half lets contextual modules be passed to descriptor-constrained
|
|
75
|
+
* helpers such as `elevate` from `@wix/sdk/context` (FEDINF-14092).
|
|
76
|
+
*
|
|
77
|
+
* The `& T` is scoped to REST descriptors — the only shape codegen wraps in
|
|
78
|
+
* `MaybeContext` — so `BuildDescriptors` (used by `createClient().use`) is left
|
|
79
|
+
* unchanged and stays bound-only. The fix lives here rather than in `elevate`,
|
|
80
|
+
* which is kept strict on purpose (see #941) so it still rejects bound-only
|
|
81
|
+
* functions that are unsafe through `createRESTModule`.
|
|
82
|
+
*/
|
|
83
|
+
declare global {
|
|
84
|
+
/**
|
|
85
|
+
* A global interface to set the exposure toggle for the SDK.
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* declare global {
|
|
89
|
+
* interface SDKExposureToggle {
|
|
90
|
+
* alpha: true;
|
|
91
|
+
* }
|
|
92
|
+
* }
|
|
93
|
+
*/
|
|
94
|
+
interface SDKExposureToggle {}
|
|
95
|
+
}
|
|
96
|
+
declare global {
|
|
97
|
+
/**
|
|
98
|
+
* A global interface to set the type mode for the SDK.
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* declare global {
|
|
102
|
+
* interface SDKTypeMode {
|
|
103
|
+
* strict: true;
|
|
104
|
+
* }
|
|
105
|
+
* }
|
|
106
|
+
*/
|
|
107
|
+
interface SDKTypeMode {}
|
|
108
|
+
}
|
|
109
|
+
//#endregion
|
|
110
|
+
//#region ../../node_modules/@wix/auto_sdk_blog_posts/build/es/index.typings.d.mts
|
|
111
|
+
interface RichContent {
|
|
112
|
+
/** Node objects representing a rich content document. */
|
|
113
|
+
nodes?: Node[];
|
|
114
|
+
/** Object metadata. */
|
|
115
|
+
metadata?: Metadata;
|
|
116
|
+
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
117
|
+
documentStyle?: DocumentStyle;
|
|
118
|
+
}
|
|
119
|
+
interface Node extends NodeDataOneOf {
|
|
120
|
+
/** Data for a button node. */
|
|
121
|
+
buttonData?: ButtonData;
|
|
122
|
+
/** Data for a code block node. */
|
|
123
|
+
codeBlockData?: CodeBlockData;
|
|
124
|
+
/** Data for a divider node. */
|
|
125
|
+
dividerData?: DividerData;
|
|
126
|
+
/** Data for a file node. */
|
|
127
|
+
fileData?: FileData;
|
|
128
|
+
/** Data for a gallery node. */
|
|
129
|
+
galleryData?: GalleryData;
|
|
130
|
+
/** Data for a GIF node. */
|
|
131
|
+
gifData?: GIFData;
|
|
132
|
+
/** Data for a heading node. */
|
|
133
|
+
headingData?: HeadingData;
|
|
134
|
+
/** Data for an embedded HTML node. */
|
|
135
|
+
htmlData?: HTMLData;
|
|
136
|
+
/** Data for an image node. */
|
|
137
|
+
imageData?: ImageData;
|
|
138
|
+
/** Data for a link preview node. */
|
|
139
|
+
linkPreviewData?: LinkPreviewData;
|
|
140
|
+
/** @deprecated */
|
|
141
|
+
mapData?: MapData;
|
|
142
|
+
/** Data for a paragraph node. */
|
|
143
|
+
paragraphData?: ParagraphData;
|
|
144
|
+
/** Data for a poll node. */
|
|
145
|
+
pollData?: PollData;
|
|
146
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
147
|
+
textData?: TextData;
|
|
148
|
+
/** Data for an app embed node. */
|
|
149
|
+
appEmbedData?: AppEmbedData;
|
|
150
|
+
/** Data for a video node. */
|
|
151
|
+
videoData?: VideoData;
|
|
152
|
+
/** Data for an oEmbed node. */
|
|
153
|
+
embedData?: EmbedData;
|
|
154
|
+
/** Data for a collapsible list node. */
|
|
155
|
+
collapsibleListData?: CollapsibleListData;
|
|
156
|
+
/** Data for a table node. */
|
|
157
|
+
tableData?: TableData;
|
|
158
|
+
/** Data for a table cell node. */
|
|
159
|
+
tableCellData?: TableCellData;
|
|
160
|
+
/** Data for a custom external node. */
|
|
161
|
+
externalData?: Record<string, any> | null;
|
|
162
|
+
/** Data for an audio node. */
|
|
163
|
+
audioData?: AudioData;
|
|
164
|
+
/** Data for an ordered list node. */
|
|
165
|
+
orderedListData?: OrderedListData;
|
|
166
|
+
/** Data for a bulleted list node. */
|
|
167
|
+
bulletedListData?: BulletedListData;
|
|
168
|
+
/** Data for a block quote node. */
|
|
169
|
+
blockquoteData?: BlockquoteData;
|
|
170
|
+
/** Data for a caption node. */
|
|
171
|
+
captionData?: CaptionData;
|
|
172
|
+
/** Data for a layout node. Reserved for future use. */
|
|
173
|
+
layoutData?: LayoutData;
|
|
174
|
+
/** Data for a cell node. */
|
|
175
|
+
layoutCellData?: LayoutCellData;
|
|
176
|
+
/** Data for a shape node. */
|
|
177
|
+
shapeData?: ShapeData;
|
|
178
|
+
/** Data for a card node. */
|
|
179
|
+
cardData?: CardData;
|
|
180
|
+
/** Data for a table of contents node. */
|
|
181
|
+
tocData?: TocData;
|
|
182
|
+
/** Data for a smart block node. */
|
|
183
|
+
smartBlockData?: SmartBlockData;
|
|
184
|
+
/** Data for a smart block cell node. */
|
|
185
|
+
smartBlockCellData?: SmartBlockCellData;
|
|
186
|
+
/** Data for a checkbox list node. */
|
|
187
|
+
checkboxListData?: CheckboxListData;
|
|
188
|
+
/** Data for a list item node. */
|
|
189
|
+
listItemData?: ListItemNodeData;
|
|
190
|
+
/** Data for a slot node. */
|
|
191
|
+
slotData?: SlotData;
|
|
192
|
+
/** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
|
|
193
|
+
type?: NodeTypeWithLiterals;
|
|
194
|
+
/** Node ID. */
|
|
195
|
+
id?: string;
|
|
196
|
+
/** A list of child nodes. */
|
|
197
|
+
nodes?: Node[];
|
|
198
|
+
/** Padding and background color styling for the node. */
|
|
199
|
+
style?: NodeStyle;
|
|
200
|
+
}
|
|
201
|
+
/** @oneof */
|
|
202
|
+
interface NodeDataOneOf {
|
|
203
|
+
/** Data for a button node. */
|
|
204
|
+
buttonData?: ButtonData;
|
|
205
|
+
/** Data for a code block node. */
|
|
206
|
+
codeBlockData?: CodeBlockData;
|
|
207
|
+
/** Data for a divider node. */
|
|
208
|
+
dividerData?: DividerData;
|
|
209
|
+
/** Data for a file node. */
|
|
210
|
+
fileData?: FileData;
|
|
211
|
+
/** Data for a gallery node. */
|
|
212
|
+
galleryData?: GalleryData;
|
|
213
|
+
/** Data for a GIF node. */
|
|
214
|
+
gifData?: GIFData;
|
|
215
|
+
/** Data for a heading node. */
|
|
216
|
+
headingData?: HeadingData;
|
|
217
|
+
/** Data for an embedded HTML node. */
|
|
218
|
+
htmlData?: HTMLData;
|
|
219
|
+
/** Data for an image node. */
|
|
220
|
+
imageData?: ImageData;
|
|
221
|
+
/** Data for a link preview node. */
|
|
222
|
+
linkPreviewData?: LinkPreviewData;
|
|
223
|
+
/** @deprecated */
|
|
224
|
+
mapData?: MapData;
|
|
225
|
+
/** Data for a paragraph node. */
|
|
226
|
+
paragraphData?: ParagraphData;
|
|
227
|
+
/** Data for a poll node. */
|
|
228
|
+
pollData?: PollData;
|
|
229
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
230
|
+
textData?: TextData;
|
|
231
|
+
/** Data for an app embed node. */
|
|
232
|
+
appEmbedData?: AppEmbedData;
|
|
233
|
+
/** Data for a video node. */
|
|
234
|
+
videoData?: VideoData;
|
|
235
|
+
/** Data for an oEmbed node. */
|
|
236
|
+
embedData?: EmbedData;
|
|
237
|
+
/** Data for a collapsible list node. */
|
|
238
|
+
collapsibleListData?: CollapsibleListData;
|
|
239
|
+
/** Data for a table node. */
|
|
240
|
+
tableData?: TableData;
|
|
241
|
+
/** Data for a table cell node. */
|
|
242
|
+
tableCellData?: TableCellData;
|
|
243
|
+
/** Data for a custom external node. */
|
|
244
|
+
externalData?: Record<string, any> | null;
|
|
245
|
+
/** Data for an audio node. */
|
|
246
|
+
audioData?: AudioData;
|
|
247
|
+
/** Data for an ordered list node. */
|
|
248
|
+
orderedListData?: OrderedListData;
|
|
249
|
+
/** Data for a bulleted list node. */
|
|
250
|
+
bulletedListData?: BulletedListData;
|
|
251
|
+
/** Data for a block quote node. */
|
|
252
|
+
blockquoteData?: BlockquoteData;
|
|
253
|
+
/** Data for a caption node. */
|
|
254
|
+
captionData?: CaptionData;
|
|
255
|
+
/** Data for a layout node. Reserved for future use. */
|
|
256
|
+
layoutData?: LayoutData;
|
|
257
|
+
/** Data for a cell node. */
|
|
258
|
+
layoutCellData?: LayoutCellData;
|
|
259
|
+
/** Data for a shape node. */
|
|
260
|
+
shapeData?: ShapeData;
|
|
261
|
+
/** Data for a card node. */
|
|
262
|
+
cardData?: CardData;
|
|
263
|
+
/** Data for a table of contents node. */
|
|
264
|
+
tocData?: TocData;
|
|
265
|
+
/** Data for a smart block node. */
|
|
266
|
+
smartBlockData?: SmartBlockData;
|
|
267
|
+
/** Data for a smart block cell node. */
|
|
268
|
+
smartBlockCellData?: SmartBlockCellData;
|
|
269
|
+
/** Data for a checkbox list node. */
|
|
270
|
+
checkboxListData?: CheckboxListData;
|
|
271
|
+
/** Data for a list item node. */
|
|
272
|
+
listItemData?: ListItemNodeData;
|
|
273
|
+
/** Data for a slot node. */
|
|
274
|
+
slotData?: SlotData;
|
|
275
|
+
}
|
|
276
|
+
declare enum NodeType {
|
|
277
|
+
PARAGRAPH = "PARAGRAPH",
|
|
278
|
+
TEXT = "TEXT",
|
|
279
|
+
HEADING = "HEADING",
|
|
280
|
+
BULLETED_LIST = "BULLETED_LIST",
|
|
281
|
+
ORDERED_LIST = "ORDERED_LIST",
|
|
282
|
+
LIST_ITEM = "LIST_ITEM",
|
|
283
|
+
BLOCKQUOTE = "BLOCKQUOTE",
|
|
284
|
+
CODE_BLOCK = "CODE_BLOCK",
|
|
285
|
+
VIDEO = "VIDEO",
|
|
286
|
+
DIVIDER = "DIVIDER",
|
|
287
|
+
FILE = "FILE",
|
|
288
|
+
GALLERY = "GALLERY",
|
|
289
|
+
GIF = "GIF",
|
|
290
|
+
HTML = "HTML",
|
|
291
|
+
IMAGE = "IMAGE",
|
|
292
|
+
LINK_PREVIEW = "LINK_PREVIEW",
|
|
293
|
+
/** @deprecated */
|
|
294
|
+
MAP = "MAP",
|
|
295
|
+
POLL = "POLL",
|
|
296
|
+
APP_EMBED = "APP_EMBED",
|
|
297
|
+
BUTTON = "BUTTON",
|
|
298
|
+
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
299
|
+
TABLE = "TABLE",
|
|
300
|
+
EMBED = "EMBED",
|
|
301
|
+
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
302
|
+
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
303
|
+
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
304
|
+
TABLE_CELL = "TABLE_CELL",
|
|
305
|
+
TABLE_ROW = "TABLE_ROW",
|
|
306
|
+
EXTERNAL = "EXTERNAL",
|
|
307
|
+
AUDIO = "AUDIO",
|
|
308
|
+
CAPTION = "CAPTION",
|
|
309
|
+
LAYOUT = "LAYOUT",
|
|
310
|
+
LAYOUT_CELL = "LAYOUT_CELL",
|
|
311
|
+
SHAPE = "SHAPE",
|
|
312
|
+
CARD = "CARD",
|
|
313
|
+
TOC = "TOC",
|
|
314
|
+
SMART_BLOCK = "SMART_BLOCK",
|
|
315
|
+
SMART_BLOCK_CELL = "SMART_BLOCK_CELL",
|
|
316
|
+
CHECKBOX_LIST = "CHECKBOX_LIST",
|
|
317
|
+
SLOT = "SLOT"
|
|
318
|
+
}
|
|
319
|
+
/** @enumType */
|
|
320
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL' | 'SHAPE' | 'CARD' | 'TOC' | 'SMART_BLOCK' | 'SMART_BLOCK_CELL' | 'CHECKBOX_LIST' | 'SLOT';
|
|
321
|
+
interface NodeStyle {
|
|
322
|
+
/** The top padding value in pixels. */
|
|
323
|
+
paddingTop?: string | null;
|
|
324
|
+
/** The bottom padding value in pixels. */
|
|
325
|
+
paddingBottom?: string | null;
|
|
326
|
+
/** The background color as a hexadecimal value. */
|
|
327
|
+
backgroundColor?: string | null;
|
|
328
|
+
}
|
|
329
|
+
interface ButtonData {
|
|
330
|
+
/** Styling for the button's container. */
|
|
331
|
+
containerData?: PluginContainerData;
|
|
332
|
+
/** The button type. */
|
|
333
|
+
type?: ButtonDataTypeWithLiterals;
|
|
334
|
+
/** Styling for the button. */
|
|
335
|
+
styles?: Styles;
|
|
336
|
+
/** The text to display on the button. */
|
|
337
|
+
text?: string | null;
|
|
338
|
+
/** Button link details. */
|
|
339
|
+
link?: Link$1;
|
|
340
|
+
/** Node animation. */
|
|
341
|
+
animation?: Animation;
|
|
342
|
+
}
|
|
343
|
+
/** Background type */
|
|
344
|
+
declare enum BackgroundType {
|
|
345
|
+
/** Solid color background */
|
|
346
|
+
COLOR = "COLOR",
|
|
347
|
+
/** Gradient background */
|
|
348
|
+
GRADIENT = "GRADIENT"
|
|
349
|
+
}
|
|
350
|
+
/** @enumType */
|
|
351
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'GRADIENT';
|
|
352
|
+
interface Gradient {
|
|
353
|
+
/** Gradient type. */
|
|
354
|
+
type?: GradientTypeWithLiterals;
|
|
355
|
+
/**
|
|
356
|
+
* Color stops for the gradient.
|
|
357
|
+
* @maxSize 1000
|
|
358
|
+
*/
|
|
359
|
+
stops?: Stop[];
|
|
360
|
+
/** Angle in degrees for linear gradient (0-360). */
|
|
361
|
+
angle?: number | null;
|
|
362
|
+
/**
|
|
363
|
+
* Horizontal center position for radial gradient (0-100).
|
|
364
|
+
* @max 100
|
|
365
|
+
*/
|
|
366
|
+
centerX?: number | null;
|
|
367
|
+
/**
|
|
368
|
+
* Vertical center position for radial gradient (0-100).
|
|
369
|
+
* @max 100
|
|
370
|
+
*/
|
|
371
|
+
centerY?: number | null;
|
|
372
|
+
}
|
|
373
|
+
/** Gradient type. */
|
|
374
|
+
declare enum GradientType {
|
|
375
|
+
/** Linear gradient. */
|
|
376
|
+
LINEAR = "LINEAR",
|
|
377
|
+
/** Radial gradient. */
|
|
378
|
+
RADIAL = "RADIAL"
|
|
379
|
+
}
|
|
380
|
+
/** @enumType */
|
|
381
|
+
type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
|
|
382
|
+
/** A single color stop in the gradient. */
|
|
383
|
+
interface Stop {
|
|
384
|
+
/**
|
|
385
|
+
* Stop color as hex value.
|
|
386
|
+
* @maxLength 19
|
|
387
|
+
*/
|
|
388
|
+
color?: string | null;
|
|
389
|
+
/** Stop position (0-1). */
|
|
390
|
+
position?: number | null;
|
|
391
|
+
}
|
|
392
|
+
interface Border {
|
|
393
|
+
/**
|
|
394
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
395
|
+
* @deprecated
|
|
396
|
+
*/
|
|
397
|
+
width?: number | null;
|
|
398
|
+
/**
|
|
399
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
400
|
+
* @deprecated
|
|
401
|
+
*/
|
|
402
|
+
radius?: number | null;
|
|
403
|
+
}
|
|
404
|
+
interface Colors {
|
|
405
|
+
/**
|
|
406
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
407
|
+
* @deprecated
|
|
408
|
+
*/
|
|
409
|
+
text?: string | null;
|
|
410
|
+
/**
|
|
411
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
412
|
+
* @deprecated
|
|
413
|
+
*/
|
|
414
|
+
border?: string | null;
|
|
415
|
+
/**
|
|
416
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
417
|
+
* @deprecated
|
|
418
|
+
*/
|
|
419
|
+
background?: string | null;
|
|
420
|
+
}
|
|
421
|
+
/** Background styling (color or gradient) */
|
|
422
|
+
interface Background {
|
|
423
|
+
/** Background type. */
|
|
424
|
+
type?: BackgroundTypeWithLiterals;
|
|
425
|
+
/**
|
|
426
|
+
* Background color as a hexadecimal value.
|
|
427
|
+
* @maxLength 19
|
|
428
|
+
*/
|
|
429
|
+
color?: string | null;
|
|
430
|
+
/** Gradient configuration. */
|
|
431
|
+
gradient?: Gradient;
|
|
432
|
+
}
|
|
433
|
+
interface PluginContainerData {
|
|
434
|
+
/** The width of the node when it's displayed. */
|
|
435
|
+
width?: PluginContainerDataWidth;
|
|
436
|
+
/** The node's alignment within its container. */
|
|
437
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
438
|
+
/** Spoiler cover settings for the node. */
|
|
439
|
+
spoiler?: Spoiler;
|
|
440
|
+
/** The height of the node when it's displayed. */
|
|
441
|
+
height?: Height;
|
|
442
|
+
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
443
|
+
textWrap?: boolean | null;
|
|
444
|
+
}
|
|
445
|
+
declare enum WidthType {
|
|
446
|
+
/** Width matches the content width */
|
|
447
|
+
CONTENT = "CONTENT",
|
|
448
|
+
/** Small Width */
|
|
449
|
+
SMALL = "SMALL",
|
|
450
|
+
/** Width will match the original asset width */
|
|
451
|
+
ORIGINAL = "ORIGINAL",
|
|
452
|
+
/** coast-to-coast display */
|
|
453
|
+
FULL_WIDTH = "FULL_WIDTH"
|
|
454
|
+
}
|
|
455
|
+
/** @enumType */
|
|
456
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
457
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
458
|
+
/**
|
|
459
|
+
* One of the following predefined width options:
|
|
460
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
461
|
+
* `SMALL`: A small width.
|
|
462
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
463
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
464
|
+
*/
|
|
465
|
+
size?: WidthTypeWithLiterals;
|
|
466
|
+
/** A custom width value in pixels. */
|
|
467
|
+
custom?: string | null;
|
|
468
|
+
}
|
|
469
|
+
/** @oneof */
|
|
470
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
471
|
+
/**
|
|
472
|
+
* One of the following predefined width options:
|
|
473
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
474
|
+
* `SMALL`: A small width.
|
|
475
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
476
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
477
|
+
*/
|
|
478
|
+
size?: WidthTypeWithLiterals;
|
|
479
|
+
/** A custom width value in pixels. */
|
|
480
|
+
custom?: string | null;
|
|
481
|
+
}
|
|
482
|
+
declare enum PluginContainerDataAlignment {
|
|
483
|
+
/** Center Alignment */
|
|
484
|
+
CENTER = "CENTER",
|
|
485
|
+
/** Left Alignment */
|
|
486
|
+
LEFT = "LEFT",
|
|
487
|
+
/** Right Alignment */
|
|
488
|
+
RIGHT = "RIGHT"
|
|
489
|
+
}
|
|
490
|
+
/** @enumType */
|
|
491
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
492
|
+
interface Spoiler {
|
|
493
|
+
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
494
|
+
enabled?: boolean | null;
|
|
495
|
+
/** The description displayed on top of the spoiler cover. */
|
|
496
|
+
description?: string | null;
|
|
497
|
+
/** The text for the button used to remove the spoiler cover. */
|
|
498
|
+
buttonText?: string | null;
|
|
499
|
+
}
|
|
500
|
+
interface Height {
|
|
501
|
+
/** A custom height value in pixels. */
|
|
502
|
+
custom?: string | null;
|
|
503
|
+
}
|
|
504
|
+
declare enum ButtonDataType {
|
|
505
|
+
/** Regular link button */
|
|
506
|
+
LINK = "LINK",
|
|
507
|
+
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
508
|
+
ACTION = "ACTION"
|
|
509
|
+
}
|
|
510
|
+
/** @enumType */
|
|
511
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
512
|
+
interface Styles {
|
|
513
|
+
/**
|
|
514
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
515
|
+
* @deprecated
|
|
516
|
+
*/
|
|
517
|
+
border?: Border;
|
|
518
|
+
/**
|
|
519
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
520
|
+
* @deprecated
|
|
521
|
+
*/
|
|
522
|
+
colors?: Colors;
|
|
523
|
+
/** Border width in pixels. */
|
|
524
|
+
borderWidth?: number | null;
|
|
525
|
+
/**
|
|
526
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
527
|
+
* @deprecated
|
|
528
|
+
*/
|
|
529
|
+
borderWidthHover?: number | null;
|
|
530
|
+
/** Border radius in pixels. */
|
|
531
|
+
borderRadius?: number | null;
|
|
532
|
+
/**
|
|
533
|
+
* Border color as a hexadecimal value.
|
|
534
|
+
* @maxLength 19
|
|
535
|
+
*/
|
|
536
|
+
borderColor?: string | null;
|
|
537
|
+
/**
|
|
538
|
+
* Border color as a hexadecimal value (hover state).
|
|
539
|
+
* @maxLength 19
|
|
540
|
+
*/
|
|
541
|
+
borderColorHover?: string | null;
|
|
542
|
+
/**
|
|
543
|
+
* Text color as a hexadecimal value.
|
|
544
|
+
* @maxLength 19
|
|
545
|
+
*/
|
|
546
|
+
textColor?: string | null;
|
|
547
|
+
/**
|
|
548
|
+
* Text color as a hexadecimal value (hover state).
|
|
549
|
+
* @maxLength 19
|
|
550
|
+
*/
|
|
551
|
+
textColorHover?: string | null;
|
|
552
|
+
/**
|
|
553
|
+
* Deprecated: Use `background` instead.
|
|
554
|
+
* @maxLength 19
|
|
555
|
+
* @deprecated
|
|
556
|
+
*/
|
|
557
|
+
backgroundColor?: string | null;
|
|
558
|
+
/**
|
|
559
|
+
* Deprecated: Use `backgroundHover` instead.
|
|
560
|
+
* @maxLength 19
|
|
561
|
+
* @deprecated
|
|
562
|
+
*/
|
|
563
|
+
backgroundColorHover?: string | null;
|
|
564
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
565
|
+
buttonSize?: string | null;
|
|
566
|
+
/** Background styling (color or gradient). */
|
|
567
|
+
background?: Background;
|
|
568
|
+
/** Background styling for hover state (color or gradient). */
|
|
569
|
+
backgroundHover?: Background;
|
|
570
|
+
}
|
|
571
|
+
interface Link$1 extends LinkDataOneOf {
|
|
572
|
+
/** The absolute URL for the linked document. */
|
|
573
|
+
url?: string;
|
|
574
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
575
|
+
anchor?: string;
|
|
576
|
+
/**
|
|
577
|
+
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
578
|
+
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
579
|
+
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
580
|
+
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
581
|
+
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
582
|
+
*/
|
|
583
|
+
target?: TargetWithLiterals;
|
|
584
|
+
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
585
|
+
rel?: Rel;
|
|
586
|
+
/** A serialized object used for a custom or external link panel. */
|
|
587
|
+
customData?: string | null;
|
|
588
|
+
}
|
|
589
|
+
/** @oneof */
|
|
590
|
+
interface LinkDataOneOf {
|
|
591
|
+
/** The absolute URL for the linked document. */
|
|
592
|
+
url?: string;
|
|
593
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
594
|
+
anchor?: string;
|
|
595
|
+
}
|
|
596
|
+
declare enum Target {
|
|
597
|
+
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
598
|
+
SELF = "SELF",
|
|
599
|
+
/** Opens the linked document in a new window or tab */
|
|
600
|
+
BLANK = "BLANK",
|
|
601
|
+
/** Opens the linked document in the parent frame */
|
|
602
|
+
PARENT = "PARENT",
|
|
603
|
+
/** Opens the linked document in the full body of the window */
|
|
604
|
+
TOP = "TOP"
|
|
605
|
+
}
|
|
606
|
+
/** @enumType */
|
|
607
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
608
|
+
interface Rel {
|
|
609
|
+
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
610
|
+
nofollow?: boolean | null;
|
|
611
|
+
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
612
|
+
sponsored?: boolean | null;
|
|
613
|
+
/** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
|
|
614
|
+
ugc?: boolean | null;
|
|
615
|
+
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
616
|
+
noreferrer?: boolean | null;
|
|
617
|
+
}
|
|
618
|
+
interface Animation {
|
|
619
|
+
/** Animation kind. */
|
|
620
|
+
type?: TypeWithLiterals;
|
|
621
|
+
/** Entrance animation, played once when the node first enters the viewport (VIEW). */
|
|
622
|
+
entrance?: EntranceAnimation;
|
|
623
|
+
/** Looping animation, repeated indefinitely while the node is on the page. When combined with entrance, the loop starts after the entrance finishes (VIEW). */
|
|
624
|
+
loop?: LoopAnimation;
|
|
625
|
+
/**
|
|
626
|
+
* POINTER carries its fields directly on the union member in the JTD wall, hence
|
|
627
|
+
* flat fields here (ts-proto camelCase must equal the JTD property names). A future
|
|
628
|
+
* kind that also needs an `effect` field would contend for this JSON name.
|
|
629
|
+
*/
|
|
630
|
+
effect?: PointerEffect;
|
|
631
|
+
/** How quickly the node settles toward the pointer, in milliseconds (POINTER). */
|
|
632
|
+
transitionDuration?: number | null;
|
|
633
|
+
}
|
|
634
|
+
declare enum Type {
|
|
635
|
+
/** Animations that play while the node is in view. */
|
|
636
|
+
VIEW = "VIEW",
|
|
637
|
+
/** Animations driven by the visitor's mouse position. */
|
|
638
|
+
POINTER = "POINTER"
|
|
639
|
+
}
|
|
640
|
+
/** @enumType */
|
|
641
|
+
type TypeWithLiterals = Type | 'VIEW' | 'POINTER';
|
|
642
|
+
interface EntranceAnimation {
|
|
643
|
+
/** The entrance effect to play. */
|
|
644
|
+
effect?: EntranceEffect;
|
|
645
|
+
/** Effect duration in milliseconds. Each effect has its own default. */
|
|
646
|
+
duration?: number | null;
|
|
647
|
+
/** Delay before the effect starts, in milliseconds. */
|
|
648
|
+
delay?: number | null;
|
|
649
|
+
}
|
|
650
|
+
interface EntranceEffect {
|
|
651
|
+
/** The entrance effect type. */
|
|
652
|
+
type?: EntranceEffectTypeWithLiterals;
|
|
653
|
+
/**
|
|
654
|
+
* Direction the effect enters from. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, the diagonals with or without CENTER, corners, HORIZONTAL/VERTICAL, CLOCKWISE/COUNTER_CLOCKWISE).
|
|
655
|
+
* @maxLength 20
|
|
656
|
+
*/
|
|
657
|
+
direction?: string | null;
|
|
658
|
+
/**
|
|
659
|
+
* Clip-path shape: ELLIPSE, CIRCLE, RECTANGLE, or DIAMOND (SHAPE).
|
|
660
|
+
* @maxLength 12
|
|
661
|
+
*/
|
|
662
|
+
shape?: string | null;
|
|
663
|
+
/**
|
|
664
|
+
* Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
|
|
665
|
+
* @maxLength 100
|
|
666
|
+
*/
|
|
667
|
+
easing?: string | null;
|
|
668
|
+
}
|
|
669
|
+
declare enum EntranceEffectType {
|
|
670
|
+
/** Fades in from fully transparent to fully opaque. */
|
|
671
|
+
FADE = "FADE",
|
|
672
|
+
/** Enters along a 3D arc path. */
|
|
673
|
+
ARC = "ARC",
|
|
674
|
+
/** Transitions from blurred to sharp. */
|
|
675
|
+
BLUR = "BLUR",
|
|
676
|
+
/** Bounces into place with an elastic curve. */
|
|
677
|
+
BOUNCE = "BOUNCE",
|
|
678
|
+
/** Shrinks down from a larger size. */
|
|
679
|
+
DROP = "DROP",
|
|
680
|
+
/** Expands from a point, scaling to full size. */
|
|
681
|
+
EXPAND = "EXPAND",
|
|
682
|
+
/** Flips into view with a 3D rotation. */
|
|
683
|
+
FLIP = "FLIP",
|
|
684
|
+
/** Drifts gently into place. */
|
|
685
|
+
FLOAT = "FLOAT",
|
|
686
|
+
/** Unfolds from an edge as if hinged. */
|
|
687
|
+
FOLD = "FOLD",
|
|
688
|
+
/** Glides in smoothly from off-screen. */
|
|
689
|
+
GLIDE = "GLIDE",
|
|
690
|
+
/** Progressively revealed by an expanding clip-path. */
|
|
691
|
+
REVEAL = "REVEAL",
|
|
692
|
+
/** Appears through an expanding geometric clip-path shape. */
|
|
693
|
+
SHAPE = "SHAPE",
|
|
694
|
+
/** Revealed through shutter-like strips. */
|
|
695
|
+
SHUTTERS = "SHUTTERS",
|
|
696
|
+
/** Slides in from one side. */
|
|
697
|
+
SLIDE = "SLIDE",
|
|
698
|
+
/** Spins into view while scaling up. */
|
|
699
|
+
SPIN = "SPIN",
|
|
700
|
+
/** Tilts in from the side with 3D rotation. */
|
|
701
|
+
TILT = "TILT",
|
|
702
|
+
/** Rotates into view around a corner pivot. */
|
|
703
|
+
TURN = "TURN",
|
|
704
|
+
/** Expands from its horizontal or vertical center. */
|
|
705
|
+
WINK = "WINK"
|
|
706
|
+
}
|
|
707
|
+
/** @enumType */
|
|
708
|
+
type EntranceEffectTypeWithLiterals = EntranceEffectType | 'FADE' | 'ARC' | 'BLUR' | 'BOUNCE' | 'DROP' | 'EXPAND' | 'FLIP' | 'FLOAT' | 'FOLD' | 'GLIDE' | 'REVEAL' | 'SHAPE' | 'SHUTTERS' | 'SLIDE' | 'SPIN' | 'TILT' | 'TURN' | 'WINK';
|
|
709
|
+
interface LoopAnimation {
|
|
710
|
+
/** The looping effect to repeat. */
|
|
711
|
+
effect?: LoopEffect;
|
|
712
|
+
/** Duration of a single iteration in milliseconds. Each effect has its own default. */
|
|
713
|
+
duration?: number | null;
|
|
714
|
+
/** Pause between iterations in milliseconds. */
|
|
715
|
+
iterationDelay?: number | null;
|
|
716
|
+
}
|
|
717
|
+
interface LoopEffect {
|
|
718
|
+
/** The looping effect type. */
|
|
719
|
+
type?: LoopEffectTypeWithLiterals;
|
|
720
|
+
/**
|
|
721
|
+
* Direction of the effect. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, LEFT/RIGHT, HORIZONTAL/VERTICAL with or without CENTER, CLOCKWISE/COUNTER_CLOCKWISE).
|
|
722
|
+
* @maxLength 20
|
|
723
|
+
*/
|
|
724
|
+
direction?: string | null;
|
|
725
|
+
/**
|
|
726
|
+
* Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
|
|
727
|
+
* @maxLength 100
|
|
728
|
+
*/
|
|
729
|
+
easing?: string | null;
|
|
730
|
+
}
|
|
731
|
+
declare enum LoopEffectType {
|
|
732
|
+
/** Bounces up and down in place. */
|
|
733
|
+
BOUNCE = "BOUNCE",
|
|
734
|
+
/** Scales gently in and out along an axis. */
|
|
735
|
+
BREATHE = "BREATHE",
|
|
736
|
+
/** Drifts toward one side, then re-enters from the opposite side. */
|
|
737
|
+
CROSS = "CROSS",
|
|
738
|
+
/** Fades out to fully transparent and back in. */
|
|
739
|
+
FLASH = "FLASH",
|
|
740
|
+
/** Rotates a full turn around its horizontal or vertical axis. */
|
|
741
|
+
FLIP = "FLIP",
|
|
742
|
+
/** Folds back and forth around a hinged edge. */
|
|
743
|
+
FOLD = "FOLD",
|
|
744
|
+
/** Wobbles with a jelly-like skew. */
|
|
745
|
+
JELLO = "JELLO",
|
|
746
|
+
/** Nudges repeatedly toward a direction. */
|
|
747
|
+
POKE = "POKE",
|
|
748
|
+
/** Scales up and back down rhythmically. */
|
|
749
|
+
PULSE = "PULSE",
|
|
750
|
+
/** Stretches and squashes like a rubber band. */
|
|
751
|
+
RUBBER = "RUBBER",
|
|
752
|
+
/** Rotates continuously around its center. */
|
|
753
|
+
SPIN = "SPIN",
|
|
754
|
+
/** Swings back and forth around an edge pivot. */
|
|
755
|
+
SWING = "SWING",
|
|
756
|
+
/** Rocks side to side with an accumulating rotation. */
|
|
757
|
+
WIGGLE = "WIGGLE"
|
|
758
|
+
}
|
|
759
|
+
/** @enumType */
|
|
760
|
+
type LoopEffectTypeWithLiterals = LoopEffectType | 'BOUNCE' | 'BREATHE' | 'CROSS' | 'FLASH' | 'FLIP' | 'FOLD' | 'JELLO' | 'POKE' | 'PULSE' | 'RUBBER' | 'SPIN' | 'SWING' | 'WIGGLE';
|
|
761
|
+
interface PointerEffect {
|
|
762
|
+
/** The mouse effect type. */
|
|
763
|
+
type?: PointerEffectTypeWithLiterals;
|
|
764
|
+
/** Reacts away from the pointer instead of toward it. */
|
|
765
|
+
inverted?: boolean | null;
|
|
766
|
+
/**
|
|
767
|
+
* One field, two value spaces (the effect type says which): the axis the movement is constrained to — HORIZONTAL, VERTICAL, or BOTH (AIRY, SCALE, SKEW, TRACK, TRACK_3D) — or the edge/center axis the node swivels around — TOP, BOTTOM, LEFT, RIGHT, CENTER_HORIZONTAL, or CENTER_VERTICAL (SWIVEL). Only the effects that expose one accept it.
|
|
768
|
+
* @maxLength 20
|
|
769
|
+
*/
|
|
770
|
+
axis?: string | null;
|
|
771
|
+
/**
|
|
772
|
+
* Whether the node grows or shrinks as the pointer nears: UP or DOWN (SCALE).
|
|
773
|
+
* @maxLength 8
|
|
774
|
+
*/
|
|
775
|
+
direction?: string | null;
|
|
776
|
+
/**
|
|
777
|
+
* Motion style: GENTLE, MODERATE, or INTENSE.
|
|
778
|
+
* @maxLength 100
|
|
779
|
+
*/
|
|
780
|
+
easing?: string | null;
|
|
781
|
+
}
|
|
782
|
+
declare enum PointerEffectType {
|
|
783
|
+
/** Drifts loosely after the pointer with a light rotation. */
|
|
784
|
+
AIRY = "AIRY",
|
|
785
|
+
/** Squashes and stretches toward the pointer. */
|
|
786
|
+
BLOB = "BLOB",
|
|
787
|
+
/** Shifts after the pointer while blurring. */
|
|
788
|
+
BLUR = "BLUR",
|
|
789
|
+
/** Scales as the pointer approaches. */
|
|
790
|
+
SCALE = "SCALE",
|
|
791
|
+
/** Skews toward the pointer. */
|
|
792
|
+
SKEW = "SKEW",
|
|
793
|
+
/** Rotates around a pivot edge or axis, following the pointer. */
|
|
794
|
+
SWIVEL = "SWIVEL",
|
|
795
|
+
/** Tilts in 3D perspective toward the pointer. */
|
|
796
|
+
TILT_3D = "TILT_3D",
|
|
797
|
+
/** Follows the pointer's position. */
|
|
798
|
+
TRACK = "TRACK",
|
|
799
|
+
/** Follows the pointer with a 3D depth motion. */
|
|
800
|
+
TRACK_3D = "TRACK_3D"
|
|
801
|
+
}
|
|
802
|
+
/** @enumType */
|
|
803
|
+
type PointerEffectTypeWithLiterals = PointerEffectType | 'AIRY' | 'BLOB' | 'BLUR' | 'SCALE' | 'SKEW' | 'SWIVEL' | 'TILT_3D' | 'TRACK' | 'TRACK_3D';
|
|
804
|
+
interface CodeBlockData {
|
|
805
|
+
/** Styling for the code block's text. */
|
|
806
|
+
textStyle?: TextStyle;
|
|
807
|
+
/** Node animation. */
|
|
808
|
+
animation?: Animation;
|
|
809
|
+
}
|
|
810
|
+
interface TextStyle {
|
|
811
|
+
/** Text alignment. Defaults to `AUTO`. */
|
|
812
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
813
|
+
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
814
|
+
lineHeight?: string | null;
|
|
815
|
+
/** 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. */
|
|
816
|
+
fontSize?: FontSizeData;
|
|
817
|
+
}
|
|
818
|
+
declare enum TextAlignment {
|
|
819
|
+
/** browser default, eqivalent to `initial` */
|
|
820
|
+
AUTO = "AUTO",
|
|
821
|
+
/** Left align */
|
|
822
|
+
LEFT = "LEFT",
|
|
823
|
+
/** Right align */
|
|
824
|
+
RIGHT = "RIGHT",
|
|
825
|
+
/** Center align */
|
|
826
|
+
CENTER = "CENTER",
|
|
827
|
+
/** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
|
|
828
|
+
JUSTIFY = "JUSTIFY"
|
|
829
|
+
}
|
|
830
|
+
/** @enumType */
|
|
831
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
832
|
+
interface FontSizeData {
|
|
833
|
+
/** The units used for the font size. */
|
|
834
|
+
unit?: FontTypeWithLiterals;
|
|
835
|
+
/** Font size value. */
|
|
836
|
+
value?: number | null;
|
|
837
|
+
}
|
|
838
|
+
declare enum FontType {
|
|
839
|
+
PX = "PX",
|
|
840
|
+
EM = "EM"
|
|
841
|
+
}
|
|
842
|
+
/** @enumType */
|
|
843
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
844
|
+
interface DividerData {
|
|
845
|
+
/** Styling for the divider's container. */
|
|
846
|
+
containerData?: PluginContainerData;
|
|
847
|
+
/** Divider line style. */
|
|
848
|
+
lineStyle?: LineStyleWithLiterals;
|
|
849
|
+
/** Divider width. */
|
|
850
|
+
width?: WidthWithLiterals;
|
|
851
|
+
/** Divider alignment. */
|
|
852
|
+
alignment?: DividerDataAlignmentWithLiterals;
|
|
853
|
+
/** Visual styling for the divider lines. */
|
|
854
|
+
styles?: DividerDataStyles;
|
|
855
|
+
/** Node animation. */
|
|
856
|
+
animation?: Animation;
|
|
857
|
+
}
|
|
858
|
+
declare enum LineCap {
|
|
859
|
+
/** Square line endings. */
|
|
860
|
+
SQUARE = "SQUARE",
|
|
861
|
+
/** Rounded line endings. */
|
|
862
|
+
ROUND = "ROUND"
|
|
863
|
+
}
|
|
864
|
+
/** @enumType */
|
|
865
|
+
type LineCapWithLiterals = LineCap | 'SQUARE' | 'ROUND';
|
|
866
|
+
declare enum LineStyle {
|
|
867
|
+
/** Single Line */
|
|
868
|
+
SINGLE = "SINGLE",
|
|
869
|
+
/** Double Line */
|
|
870
|
+
DOUBLE = "DOUBLE",
|
|
871
|
+
/** Dashed Line */
|
|
872
|
+
DASHED = "DASHED",
|
|
873
|
+
/** Dotted Line */
|
|
874
|
+
DOTTED = "DOTTED"
|
|
875
|
+
}
|
|
876
|
+
/** @enumType */
|
|
877
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
878
|
+
declare enum Width {
|
|
879
|
+
/** Large line */
|
|
880
|
+
LARGE = "LARGE",
|
|
881
|
+
/** Medium line */
|
|
882
|
+
MEDIUM = "MEDIUM",
|
|
883
|
+
/** Small line */
|
|
884
|
+
SMALL = "SMALL"
|
|
885
|
+
}
|
|
886
|
+
/** @enumType */
|
|
887
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
888
|
+
declare enum DividerDataAlignment {
|
|
889
|
+
/** Center alignment */
|
|
890
|
+
CENTER = "CENTER",
|
|
891
|
+
/** Left alignment */
|
|
892
|
+
LEFT = "LEFT",
|
|
893
|
+
/** Right alignment */
|
|
894
|
+
RIGHT = "RIGHT"
|
|
895
|
+
}
|
|
896
|
+
/** @enumType */
|
|
897
|
+
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
898
|
+
interface DividerDataStyles {
|
|
899
|
+
/**
|
|
900
|
+
* Divider color as a hexadecimal value. An alpha channel controls opacity.
|
|
901
|
+
* @maxLength 19
|
|
902
|
+
*/
|
|
903
|
+
color?: string | null;
|
|
904
|
+
/** Divider line ending shape. */
|
|
905
|
+
lineCap?: LineCapWithLiterals;
|
|
906
|
+
/**
|
|
907
|
+
* Line thicknesses in pixels, ordered from first line to last line.
|
|
908
|
+
* @maxSize 10
|
|
909
|
+
*/
|
|
910
|
+
lineThickness?: number[];
|
|
911
|
+
/** 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. */
|
|
912
|
+
dashLength?: number | null;
|
|
913
|
+
/** Visible gap between dashes or dots, in pixels. */
|
|
914
|
+
dashGap?: number | null;
|
|
915
|
+
/** Gap between divider lines in pixels. */
|
|
916
|
+
lineGap?: number | null;
|
|
917
|
+
}
|
|
918
|
+
interface FileData {
|
|
919
|
+
/** Styling for the file's container. */
|
|
920
|
+
containerData?: PluginContainerData;
|
|
921
|
+
/** The source for the file's data. */
|
|
922
|
+
src?: FileSource;
|
|
923
|
+
/** File name. */
|
|
924
|
+
name?: string | null;
|
|
925
|
+
/** File type. */
|
|
926
|
+
type?: string | null;
|
|
927
|
+
/**
|
|
928
|
+
* Use `sizeInKb` instead.
|
|
929
|
+
* @deprecated
|
|
930
|
+
*/
|
|
931
|
+
size?: number | null;
|
|
932
|
+
/** Settings for PDF files. */
|
|
933
|
+
pdfSettings?: PDFSettings;
|
|
934
|
+
/** File MIME type. */
|
|
935
|
+
mimeType?: string | null;
|
|
936
|
+
/** File path. */
|
|
937
|
+
path?: string | null;
|
|
938
|
+
/** File size in KB. */
|
|
939
|
+
sizeInKb?: string | null;
|
|
940
|
+
/** Node animation. */
|
|
941
|
+
animation?: Animation;
|
|
942
|
+
}
|
|
943
|
+
declare enum ViewMode {
|
|
944
|
+
/** No PDF view */
|
|
945
|
+
NONE = "NONE",
|
|
946
|
+
/** Full PDF view */
|
|
947
|
+
FULL = "FULL",
|
|
948
|
+
/** Mini PDF view */
|
|
949
|
+
MINI = "MINI"
|
|
950
|
+
}
|
|
951
|
+
/** @enumType */
|
|
952
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
953
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
954
|
+
/** The absolute URL for the file's source. */
|
|
955
|
+
url?: string | null;
|
|
956
|
+
/**
|
|
957
|
+
* Custom ID. Use `id` instead.
|
|
958
|
+
* @deprecated
|
|
959
|
+
*/
|
|
960
|
+
custom?: string | null;
|
|
961
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
962
|
+
id?: string | null;
|
|
963
|
+
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
964
|
+
private?: boolean | null;
|
|
965
|
+
}
|
|
966
|
+
/** @oneof */
|
|
967
|
+
interface FileSourceDataOneOf {
|
|
968
|
+
/** The absolute URL for the file's source. */
|
|
969
|
+
url?: string | null;
|
|
970
|
+
/**
|
|
971
|
+
* Custom ID. Use `id` instead.
|
|
972
|
+
* @deprecated
|
|
973
|
+
*/
|
|
974
|
+
custom?: string | null;
|
|
975
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
976
|
+
id?: string | null;
|
|
977
|
+
}
|
|
978
|
+
interface PDFSettings {
|
|
979
|
+
/**
|
|
980
|
+
* PDF view mode. One of the following:
|
|
981
|
+
* `NONE` : The PDF isn't displayed.
|
|
982
|
+
* `FULL` : A full page view of the PDF is displayed.
|
|
983
|
+
* `MINI` : A mini view of the PDF is displayed.
|
|
984
|
+
*/
|
|
985
|
+
viewMode?: ViewModeWithLiterals;
|
|
986
|
+
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
987
|
+
disableDownload?: boolean | null;
|
|
988
|
+
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
989
|
+
disablePrint?: boolean | null;
|
|
990
|
+
}
|
|
991
|
+
interface GalleryData {
|
|
992
|
+
/** Styling for the gallery's container. */
|
|
993
|
+
containerData?: PluginContainerData;
|
|
994
|
+
/** The items in the gallery. */
|
|
995
|
+
items?: Item[];
|
|
996
|
+
/** Options for defining the gallery's appearance. */
|
|
997
|
+
options?: GalleryOptions;
|
|
998
|
+
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
999
|
+
disableExpand?: boolean | null;
|
|
1000
|
+
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1001
|
+
disableDownload?: boolean | null;
|
|
1002
|
+
/** Node animation. */
|
|
1003
|
+
animation?: Animation;
|
|
1004
|
+
}
|
|
1005
|
+
interface V1Media {
|
|
1006
|
+
/** The source for the media's data. */
|
|
1007
|
+
src?: FileSource;
|
|
1008
|
+
/** Media width in pixels. */
|
|
1009
|
+
width?: number | null;
|
|
1010
|
+
/** Media height in pixels. */
|
|
1011
|
+
height?: number | null;
|
|
1012
|
+
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1013
|
+
duration?: number | null;
|
|
1014
|
+
}
|
|
1015
|
+
interface Image$1 {
|
|
1016
|
+
/** Image file details. */
|
|
1017
|
+
media?: V1Media;
|
|
1018
|
+
/** Link details for images that are links. */
|
|
1019
|
+
link?: Link$1;
|
|
1020
|
+
}
|
|
1021
|
+
interface Video {
|
|
1022
|
+
/** Video file details. */
|
|
1023
|
+
media?: V1Media;
|
|
1024
|
+
/** Video thumbnail file details. */
|
|
1025
|
+
thumbnail?: V1Media;
|
|
1026
|
+
}
|
|
1027
|
+
interface Item extends ItemDataOneOf {
|
|
1028
|
+
/** An image item. */
|
|
1029
|
+
image?: Image$1;
|
|
1030
|
+
/** A video item. */
|
|
1031
|
+
video?: Video;
|
|
1032
|
+
/** Item title. */
|
|
1033
|
+
title?: string | null;
|
|
1034
|
+
/** Item's alternative text. */
|
|
1035
|
+
altText?: string | null;
|
|
1036
|
+
}
|
|
1037
|
+
/** @oneof */
|
|
1038
|
+
interface ItemDataOneOf {
|
|
1039
|
+
/** An image item. */
|
|
1040
|
+
image?: Image$1;
|
|
1041
|
+
/** A video item. */
|
|
1042
|
+
video?: Video;
|
|
1043
|
+
}
|
|
1044
|
+
interface GalleryOptions {
|
|
1045
|
+
/** Gallery layout. */
|
|
1046
|
+
layout?: GalleryOptionsLayout;
|
|
1047
|
+
/** Styling for gallery items. */
|
|
1048
|
+
item?: ItemStyle;
|
|
1049
|
+
/** Styling for gallery thumbnail images. */
|
|
1050
|
+
thumbnails?: Thumbnails;
|
|
1051
|
+
}
|
|
1052
|
+
declare enum LayoutType {
|
|
1053
|
+
/** Collage type */
|
|
1054
|
+
COLLAGE = "COLLAGE",
|
|
1055
|
+
/** Masonry type */
|
|
1056
|
+
MASONRY = "MASONRY",
|
|
1057
|
+
/** Grid type */
|
|
1058
|
+
GRID = "GRID",
|
|
1059
|
+
/** Thumbnail type */
|
|
1060
|
+
THUMBNAIL = "THUMBNAIL",
|
|
1061
|
+
/** Slider type */
|
|
1062
|
+
SLIDER = "SLIDER",
|
|
1063
|
+
/** Slideshow type */
|
|
1064
|
+
SLIDESHOW = "SLIDESHOW",
|
|
1065
|
+
/** Panorama type */
|
|
1066
|
+
PANORAMA = "PANORAMA",
|
|
1067
|
+
/** Column type */
|
|
1068
|
+
COLUMN = "COLUMN",
|
|
1069
|
+
/** Magic type */
|
|
1070
|
+
MAGIC = "MAGIC",
|
|
1071
|
+
/** Fullsize images type */
|
|
1072
|
+
FULLSIZE = "FULLSIZE"
|
|
1073
|
+
}
|
|
1074
|
+
/** @enumType */
|
|
1075
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1076
|
+
declare enum Orientation {
|
|
1077
|
+
/** Rows Orientation */
|
|
1078
|
+
ROWS = "ROWS",
|
|
1079
|
+
/** Columns Orientation */
|
|
1080
|
+
COLUMNS = "COLUMNS"
|
|
1081
|
+
}
|
|
1082
|
+
/** @enumType */
|
|
1083
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1084
|
+
declare enum Crop$1 {
|
|
1085
|
+
/** Crop to fill */
|
|
1086
|
+
FILL = "FILL",
|
|
1087
|
+
/** Crop to fit */
|
|
1088
|
+
FIT = "FIT"
|
|
1089
|
+
}
|
|
1090
|
+
/** @enumType */
|
|
1091
|
+
type CropWithLiterals = Crop$1 | 'FILL' | 'FIT';
|
|
1092
|
+
declare enum ThumbnailsAlignment {
|
|
1093
|
+
/** Top alignment */
|
|
1094
|
+
TOP = "TOP",
|
|
1095
|
+
/** Right alignment */
|
|
1096
|
+
RIGHT = "RIGHT",
|
|
1097
|
+
/** Bottom alignment */
|
|
1098
|
+
BOTTOM = "BOTTOM",
|
|
1099
|
+
/** Left alignment */
|
|
1100
|
+
LEFT = "LEFT",
|
|
1101
|
+
/** No thumbnail */
|
|
1102
|
+
NONE = "NONE"
|
|
1103
|
+
}
|
|
1104
|
+
/** @enumType */
|
|
1105
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1106
|
+
interface GalleryOptionsLayout {
|
|
1107
|
+
/** Gallery layout type. */
|
|
1108
|
+
type?: LayoutTypeWithLiterals;
|
|
1109
|
+
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1110
|
+
horizontalScroll?: boolean | null;
|
|
1111
|
+
/** Gallery orientation. */
|
|
1112
|
+
orientation?: OrientationWithLiterals;
|
|
1113
|
+
/** The number of columns to display on full size screens. */
|
|
1114
|
+
numberOfColumns?: number | null;
|
|
1115
|
+
/** The number of columns to display on mobile screens. */
|
|
1116
|
+
mobileNumberOfColumns?: number | null;
|
|
1117
|
+
}
|
|
1118
|
+
interface ItemStyle {
|
|
1119
|
+
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1120
|
+
targetSize?: number | null;
|
|
1121
|
+
/** Item ratio */
|
|
1122
|
+
ratio?: number | null;
|
|
1123
|
+
/** Sets how item images are cropped. */
|
|
1124
|
+
crop?: CropWithLiterals;
|
|
1125
|
+
/** The spacing between items in pixels. */
|
|
1126
|
+
spacing?: number | null;
|
|
1127
|
+
}
|
|
1128
|
+
interface Thumbnails {
|
|
1129
|
+
/** Thumbnail alignment. */
|
|
1130
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1131
|
+
/** Spacing between thumbnails in pixels. */
|
|
1132
|
+
spacing?: number | null;
|
|
1133
|
+
}
|
|
1134
|
+
interface GIFData {
|
|
1135
|
+
/** Styling for the GIF's container. */
|
|
1136
|
+
containerData?: PluginContainerData;
|
|
1137
|
+
/** The source of the full size GIF. */
|
|
1138
|
+
original?: GIF;
|
|
1139
|
+
/** The source of the downsized GIF. */
|
|
1140
|
+
downsized?: GIF;
|
|
1141
|
+
/** Height in pixels. */
|
|
1142
|
+
height?: number;
|
|
1143
|
+
/** Width in pixels. */
|
|
1144
|
+
width?: number;
|
|
1145
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1146
|
+
gifType?: GIFTypeWithLiterals;
|
|
1147
|
+
/** Node animation. */
|
|
1148
|
+
animation?: Animation;
|
|
1149
|
+
}
|
|
1150
|
+
interface GIF {
|
|
1151
|
+
/**
|
|
1152
|
+
* GIF format URL.
|
|
1153
|
+
* @format WEB_URL
|
|
1154
|
+
*/
|
|
1155
|
+
gif?: string | null;
|
|
1156
|
+
/**
|
|
1157
|
+
* MP4 format URL.
|
|
1158
|
+
* @format WEB_URL
|
|
1159
|
+
*/
|
|
1160
|
+
mp4?: string | null;
|
|
1161
|
+
/**
|
|
1162
|
+
* Thumbnail URL.
|
|
1163
|
+
* @format WEB_URL
|
|
1164
|
+
*/
|
|
1165
|
+
still?: string | null;
|
|
1166
|
+
}
|
|
1167
|
+
declare enum GIFType {
|
|
1168
|
+
NORMAL = "NORMAL",
|
|
1169
|
+
STICKER = "STICKER"
|
|
1170
|
+
}
|
|
1171
|
+
/** @enumType */
|
|
1172
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1173
|
+
interface HeadingData {
|
|
1174
|
+
/** Heading level from 1-6. */
|
|
1175
|
+
level?: number;
|
|
1176
|
+
/** Styling for the heading text. */
|
|
1177
|
+
textStyle?: TextStyle;
|
|
1178
|
+
/** Indentation level from 1-4. */
|
|
1179
|
+
indentation?: number | null;
|
|
1180
|
+
/** Rendered heading level for SEO/accessibility, overrides the HTML tag when set. */
|
|
1181
|
+
renderedLevel?: number | null;
|
|
1182
|
+
/** Node animation. */
|
|
1183
|
+
animation?: Animation;
|
|
1184
|
+
}
|
|
1185
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1186
|
+
/** The URL for the HTML code for the node. */
|
|
1187
|
+
url?: string;
|
|
1188
|
+
/** The HTML code for the node. */
|
|
1189
|
+
html?: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1192
|
+
* @deprecated
|
|
1193
|
+
*/
|
|
1194
|
+
isAdsense?: boolean | null;
|
|
1195
|
+
/** The WixelWidget ID for AI_WIDGET source nodes. */
|
|
1196
|
+
widgetId?: string;
|
|
1197
|
+
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1198
|
+
containerData?: PluginContainerData;
|
|
1199
|
+
/** The type of HTML code. */
|
|
1200
|
+
source?: SourceWithLiterals;
|
|
1201
|
+
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1202
|
+
autoHeight?: boolean | null;
|
|
1203
|
+
/** Node animation. */
|
|
1204
|
+
animation?: Animation;
|
|
1205
|
+
}
|
|
1206
|
+
/** @oneof */
|
|
1207
|
+
interface HTMLDataDataOneOf {
|
|
1208
|
+
/** The URL for the HTML code for the node. */
|
|
1209
|
+
url?: string;
|
|
1210
|
+
/** The HTML code for the node. */
|
|
1211
|
+
html?: string;
|
|
1212
|
+
/**
|
|
1213
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1214
|
+
* @deprecated
|
|
1215
|
+
*/
|
|
1216
|
+
isAdsense?: boolean | null;
|
|
1217
|
+
/** The WixelWidget ID for AI_WIDGET source nodes. */
|
|
1218
|
+
widgetId?: string;
|
|
1219
|
+
}
|
|
1220
|
+
declare enum Source {
|
|
1221
|
+
HTML = "HTML",
|
|
1222
|
+
ADSENSE = "ADSENSE",
|
|
1223
|
+
AI = "AI",
|
|
1224
|
+
AI_WIDGET = "AI_WIDGET"
|
|
1225
|
+
}
|
|
1226
|
+
/** @enumType */
|
|
1227
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI' | 'AI_WIDGET';
|
|
1228
|
+
interface ImageData {
|
|
1229
|
+
/** Styling for the image's container. */
|
|
1230
|
+
containerData?: PluginContainerData;
|
|
1231
|
+
/** Image file details. */
|
|
1232
|
+
image?: V1Media;
|
|
1233
|
+
/** Link details for images that are links. */
|
|
1234
|
+
link?: Link$1;
|
|
1235
|
+
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
1236
|
+
disableExpand?: boolean | null;
|
|
1237
|
+
/** Image's alternative text. */
|
|
1238
|
+
altText?: string | null;
|
|
1239
|
+
/**
|
|
1240
|
+
* Deprecated: use Caption node instead.
|
|
1241
|
+
* @deprecated
|
|
1242
|
+
*/
|
|
1243
|
+
caption?: string | null;
|
|
1244
|
+
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1245
|
+
disableDownload?: boolean | null;
|
|
1246
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1247
|
+
decorative?: boolean | null;
|
|
1248
|
+
/** Styling for the image. */
|
|
1249
|
+
styles?: ImageDataStyles;
|
|
1250
|
+
/** Non-destructive crop rectangle, expressed as fractions (0-1) of the original image. When omitted, the full image is shown. */
|
|
1251
|
+
crop?: ImageDataCrop;
|
|
1252
|
+
/** Optional shape mask applied to the visible crop. Supported values: CIRCLE, OVAL, STAR, PENTAGON, HEXAGON, TRIANGLE, HEART, RHOMBUS, FLUID, WINDOW. */
|
|
1253
|
+
cropShape?: string | null;
|
|
1254
|
+
/** Node animation. */
|
|
1255
|
+
animation?: Animation;
|
|
1256
|
+
}
|
|
1257
|
+
interface StylesBorder {
|
|
1258
|
+
/** Border width in pixels. */
|
|
1259
|
+
width?: number | null;
|
|
1260
|
+
/**
|
|
1261
|
+
* Border color as a hexadecimal value.
|
|
1262
|
+
* @maxLength 19
|
|
1263
|
+
*/
|
|
1264
|
+
color?: string | null;
|
|
1265
|
+
/** Border radius in pixels. */
|
|
1266
|
+
radius?: number | null;
|
|
1267
|
+
}
|
|
1268
|
+
interface ImageDataStyles {
|
|
1269
|
+
/** Border attributes. */
|
|
1270
|
+
border?: StylesBorder;
|
|
1271
|
+
}
|
|
1272
|
+
interface ImageDataCrop {
|
|
1273
|
+
/** Left edge of the crop, as a fraction (0-1) of the original image width. */
|
|
1274
|
+
x?: number | null;
|
|
1275
|
+
/** Top edge of the crop, as a fraction (0-1) of the original image height. */
|
|
1276
|
+
y?: number | null;
|
|
1277
|
+
/** Visible width of the crop, as a fraction (0-1) of the original image width. */
|
|
1278
|
+
width?: number | null;
|
|
1279
|
+
/** Visible height of the crop, as a fraction (0-1) of the original image height. */
|
|
1280
|
+
height?: number | null;
|
|
1281
|
+
}
|
|
1282
|
+
interface LinkPreviewData {
|
|
1283
|
+
/** Styling for the link preview's container. */
|
|
1284
|
+
containerData?: PluginContainerData;
|
|
1285
|
+
/** Link details. */
|
|
1286
|
+
link?: Link$1;
|
|
1287
|
+
/** Preview title. */
|
|
1288
|
+
title?: string | null;
|
|
1289
|
+
/** Preview thumbnail URL. */
|
|
1290
|
+
thumbnailUrl?: string | null;
|
|
1291
|
+
/** Preview description. */
|
|
1292
|
+
description?: string | null;
|
|
1293
|
+
/** The preview content as HTML. */
|
|
1294
|
+
html?: string | null;
|
|
1295
|
+
/** Styling for the link preview. */
|
|
1296
|
+
styles?: LinkPreviewDataStyles;
|
|
1297
|
+
/** Node animation. */
|
|
1298
|
+
animation?: Animation;
|
|
1299
|
+
}
|
|
1300
|
+
declare enum StylesPosition {
|
|
1301
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1302
|
+
START = "START",
|
|
1303
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1304
|
+
END = "END",
|
|
1305
|
+
/** Thumbnail positioned at the top */
|
|
1306
|
+
TOP = "TOP",
|
|
1307
|
+
/** Thumbnail hidden and not displayed */
|
|
1308
|
+
HIDDEN = "HIDDEN"
|
|
1309
|
+
}
|
|
1310
|
+
/** @enumType */
|
|
1311
|
+
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1312
|
+
interface LinkPreviewDataStyles {
|
|
1313
|
+
/**
|
|
1314
|
+
* Background color as a hexadecimal value.
|
|
1315
|
+
* @maxLength 19
|
|
1316
|
+
*/
|
|
1317
|
+
backgroundColor?: string | null;
|
|
1318
|
+
/**
|
|
1319
|
+
* Title color as a hexadecimal value.
|
|
1320
|
+
* @maxLength 19
|
|
1321
|
+
*/
|
|
1322
|
+
titleColor?: string | null;
|
|
1323
|
+
/**
|
|
1324
|
+
* Subtitle color as a hexadecimal value.
|
|
1325
|
+
* @maxLength 19
|
|
1326
|
+
*/
|
|
1327
|
+
subtitleColor?: string | null;
|
|
1328
|
+
/**
|
|
1329
|
+
* Link color as a hexadecimal value.
|
|
1330
|
+
* @maxLength 19
|
|
1331
|
+
*/
|
|
1332
|
+
linkColor?: string | null;
|
|
1333
|
+
/** Border width in pixels. */
|
|
1334
|
+
borderWidth?: number | null;
|
|
1335
|
+
/** Border radius in pixels. */
|
|
1336
|
+
borderRadius?: number | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* Border color as a hexadecimal value.
|
|
1339
|
+
* @maxLength 19
|
|
1340
|
+
*/
|
|
1341
|
+
borderColor?: string | null;
|
|
1342
|
+
/** Position of thumbnail. Defaults to `START`. */
|
|
1343
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
1344
|
+
}
|
|
1345
|
+
interface MapData {
|
|
1346
|
+
/** Styling for the map's container. */
|
|
1347
|
+
containerData?: PluginContainerData;
|
|
1348
|
+
/** Map settings. */
|
|
1349
|
+
mapSettings?: MapSettings;
|
|
1350
|
+
}
|
|
1351
|
+
interface MapSettings {
|
|
1352
|
+
/** The address to display on the map. */
|
|
1353
|
+
address?: string | null;
|
|
1354
|
+
/** Sets whether the map is draggable. */
|
|
1355
|
+
draggable?: boolean | null;
|
|
1356
|
+
/** Sets whether the location marker is visible. */
|
|
1357
|
+
marker?: boolean | null;
|
|
1358
|
+
/** Sets whether street view control is enabled. */
|
|
1359
|
+
streetViewControl?: boolean | null;
|
|
1360
|
+
/** Sets whether zoom control is enabled. */
|
|
1361
|
+
zoomControl?: boolean | null;
|
|
1362
|
+
/** Location latitude. */
|
|
1363
|
+
lat?: number | null;
|
|
1364
|
+
/** Location longitude. */
|
|
1365
|
+
lng?: number | null;
|
|
1366
|
+
/** Location name. */
|
|
1367
|
+
locationName?: string | null;
|
|
1368
|
+
/** Sets whether view mode control is enabled. */
|
|
1369
|
+
viewModeControl?: boolean | null;
|
|
1370
|
+
/** Initial zoom value. */
|
|
1371
|
+
initialZoom?: number | null;
|
|
1372
|
+
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1373
|
+
mapType?: MapTypeWithLiterals;
|
|
1374
|
+
}
|
|
1375
|
+
declare enum MapType {
|
|
1376
|
+
/** Roadmap map type */
|
|
1377
|
+
ROADMAP = "ROADMAP",
|
|
1378
|
+
/** Satellite map type */
|
|
1379
|
+
SATELITE = "SATELITE",
|
|
1380
|
+
/** Hybrid map type */
|
|
1381
|
+
HYBRID = "HYBRID",
|
|
1382
|
+
/** Terrain map type */
|
|
1383
|
+
TERRAIN = "TERRAIN"
|
|
1384
|
+
}
|
|
1385
|
+
/** @enumType */
|
|
1386
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1387
|
+
interface ParagraphData {
|
|
1388
|
+
/** Styling for the paragraph text. */
|
|
1389
|
+
textStyle?: TextStyle;
|
|
1390
|
+
/** Indentation level from 1-4. */
|
|
1391
|
+
indentation?: number | null;
|
|
1392
|
+
/** Paragraph level */
|
|
1393
|
+
level?: number | null;
|
|
1394
|
+
/** Node animation. */
|
|
1395
|
+
animation?: Animation;
|
|
1396
|
+
}
|
|
1397
|
+
interface PollData {
|
|
1398
|
+
/** Styling for the poll's container. */
|
|
1399
|
+
containerData?: PluginContainerData;
|
|
1400
|
+
/** Poll data. */
|
|
1401
|
+
poll?: Poll;
|
|
1402
|
+
/** Layout settings for the poll and voting options. */
|
|
1403
|
+
layout?: PollDataLayout;
|
|
1404
|
+
/** Styling for the poll and voting options. */
|
|
1405
|
+
design?: Design;
|
|
1406
|
+
/** Node animation. */
|
|
1407
|
+
animation?: Animation;
|
|
1408
|
+
}
|
|
1409
|
+
declare enum ViewRole {
|
|
1410
|
+
/** Only Poll creator can view the results */
|
|
1411
|
+
CREATOR = "CREATOR",
|
|
1412
|
+
/** Anyone who voted can see the results */
|
|
1413
|
+
VOTERS = "VOTERS",
|
|
1414
|
+
/** Anyone can see the results, even if one didn't vote */
|
|
1415
|
+
EVERYONE = "EVERYONE"
|
|
1416
|
+
}
|
|
1417
|
+
/** @enumType */
|
|
1418
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1419
|
+
declare enum VoteRole {
|
|
1420
|
+
/** Logged in member */
|
|
1421
|
+
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1422
|
+
/** Anyone */
|
|
1423
|
+
ALL = "ALL"
|
|
1424
|
+
}
|
|
1425
|
+
/** @enumType */
|
|
1426
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1427
|
+
interface Permissions {
|
|
1428
|
+
/** Sets who can view the poll results. */
|
|
1429
|
+
view?: ViewRoleWithLiterals;
|
|
1430
|
+
/** Sets who can vote. */
|
|
1431
|
+
vote?: VoteRoleWithLiterals;
|
|
1432
|
+
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1433
|
+
allowMultipleVotes?: boolean | null;
|
|
1434
|
+
}
|
|
1435
|
+
interface Option {
|
|
1436
|
+
/** Option ID. */
|
|
1437
|
+
id?: string | null;
|
|
1438
|
+
/** Option title. */
|
|
1439
|
+
title?: string | null;
|
|
1440
|
+
/** The image displayed with the option. */
|
|
1441
|
+
image?: V1Media;
|
|
1442
|
+
}
|
|
1443
|
+
interface PollSettings {
|
|
1444
|
+
/** Permissions settings for voting. */
|
|
1445
|
+
permissions?: Permissions;
|
|
1446
|
+
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
1447
|
+
showVoters?: boolean | null;
|
|
1448
|
+
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1449
|
+
showVotesCount?: boolean | null;
|
|
1450
|
+
}
|
|
1451
|
+
declare enum PollLayoutType {
|
|
1452
|
+
/** List */
|
|
1453
|
+
LIST = "LIST",
|
|
1454
|
+
/** Grid */
|
|
1455
|
+
GRID = "GRID"
|
|
1456
|
+
}
|
|
1457
|
+
/** @enumType */
|
|
1458
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1459
|
+
declare enum PollLayoutDirection {
|
|
1460
|
+
/** Left-to-right */
|
|
1461
|
+
LTR = "LTR",
|
|
1462
|
+
/** Right-to-left */
|
|
1463
|
+
RTL = "RTL"
|
|
1464
|
+
}
|
|
1465
|
+
/** @enumType */
|
|
1466
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1467
|
+
interface PollLayout {
|
|
1468
|
+
/** The layout for displaying the voting options. */
|
|
1469
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1470
|
+
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1471
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1472
|
+
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1473
|
+
enableImage?: boolean | null;
|
|
1474
|
+
}
|
|
1475
|
+
interface OptionLayout {
|
|
1476
|
+
/** Sets whether to display option images. Defaults to `false`. */
|
|
1477
|
+
enableImage?: boolean | null;
|
|
1478
|
+
}
|
|
1479
|
+
declare enum PollDesignBackgroundType {
|
|
1480
|
+
/** Color background type */
|
|
1481
|
+
COLOR = "COLOR",
|
|
1482
|
+
/** Image background type */
|
|
1483
|
+
IMAGE = "IMAGE",
|
|
1484
|
+
/** Gradiant background type */
|
|
1485
|
+
GRADIENT = "GRADIENT"
|
|
1486
|
+
}
|
|
1487
|
+
/** @enumType */
|
|
1488
|
+
type PollDesignBackgroundTypeWithLiterals = PollDesignBackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1489
|
+
interface BackgroundGradient {
|
|
1490
|
+
/** The gradient angle in degrees. */
|
|
1491
|
+
angle?: number | null;
|
|
1492
|
+
/**
|
|
1493
|
+
* The start color as a hexademical value.
|
|
1494
|
+
* @maxLength 19
|
|
1495
|
+
*/
|
|
1496
|
+
startColor?: string | null;
|
|
1497
|
+
/**
|
|
1498
|
+
* The end color as a hexademical value.
|
|
1499
|
+
* @maxLength 19
|
|
1500
|
+
*/
|
|
1501
|
+
lastColor?: string | null;
|
|
1502
|
+
}
|
|
1503
|
+
interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
|
|
1504
|
+
/**
|
|
1505
|
+
* The background color as a hexademical value.
|
|
1506
|
+
* @maxLength 19
|
|
1507
|
+
*/
|
|
1508
|
+
color?: string | null;
|
|
1509
|
+
/** An image to use for the background. */
|
|
1510
|
+
image?: V1Media;
|
|
1511
|
+
/** Details for a gradient background. */
|
|
1512
|
+
gradient?: BackgroundGradient;
|
|
1513
|
+
/** Background type. For each option, include the relevant details. */
|
|
1514
|
+
type?: PollDesignBackgroundTypeWithLiterals;
|
|
1515
|
+
}
|
|
1516
|
+
/** @oneof */
|
|
1517
|
+
interface PollDesignBackgroundBackgroundOneOf {
|
|
1518
|
+
/**
|
|
1519
|
+
* The background color as a hexademical value.
|
|
1520
|
+
* @maxLength 19
|
|
1521
|
+
*/
|
|
1522
|
+
color?: string | null;
|
|
1523
|
+
/** An image to use for the background. */
|
|
1524
|
+
image?: V1Media;
|
|
1525
|
+
/** Details for a gradient background. */
|
|
1526
|
+
gradient?: BackgroundGradient;
|
|
1527
|
+
}
|
|
1528
|
+
interface PollDesign {
|
|
1529
|
+
/** Background styling. */
|
|
1530
|
+
background?: PollDesignBackground;
|
|
1531
|
+
/** Border radius in pixels. */
|
|
1532
|
+
borderRadius?: number | null;
|
|
1533
|
+
}
|
|
1534
|
+
interface OptionDesign {
|
|
1535
|
+
/** Border radius in pixels. */
|
|
1536
|
+
borderRadius?: number | null;
|
|
1537
|
+
}
|
|
1538
|
+
interface Poll {
|
|
1539
|
+
/** Poll ID. */
|
|
1540
|
+
id?: string | null;
|
|
1541
|
+
/** Poll title. */
|
|
1542
|
+
title?: string | null;
|
|
1543
|
+
/** Poll creator ID. */
|
|
1544
|
+
creatorId?: string | null;
|
|
1545
|
+
/** Main poll image. */
|
|
1546
|
+
image?: V1Media;
|
|
1547
|
+
/** Voting options. */
|
|
1548
|
+
options?: Option[];
|
|
1549
|
+
/** The poll's permissions and display settings. */
|
|
1550
|
+
settings?: PollSettings;
|
|
1551
|
+
}
|
|
1552
|
+
interface PollDataLayout {
|
|
1553
|
+
/** Poll layout settings. */
|
|
1554
|
+
poll?: PollLayout;
|
|
1555
|
+
/** Voting otpions layout settings. */
|
|
1556
|
+
options?: OptionLayout;
|
|
1557
|
+
}
|
|
1558
|
+
interface Design {
|
|
1559
|
+
/** Styling for the poll. */
|
|
1560
|
+
poll?: PollDesign;
|
|
1561
|
+
/** Styling for voting options. */
|
|
1562
|
+
options?: OptionDesign;
|
|
1563
|
+
}
|
|
1564
|
+
interface TextData {
|
|
1565
|
+
/** The text to apply decorations to. */
|
|
1566
|
+
text?: string;
|
|
1567
|
+
/** The decorations to apply. */
|
|
1568
|
+
decorations?: Decoration[];
|
|
1569
|
+
}
|
|
1570
|
+
/** Adds appearence changes to text */
|
|
1571
|
+
interface Decoration extends DecorationDataOneOf {
|
|
1572
|
+
/** Data for an anchor link decoration. */
|
|
1573
|
+
anchorData?: AnchorData;
|
|
1574
|
+
/** Data for a color decoration. */
|
|
1575
|
+
colorData?: ColorData;
|
|
1576
|
+
/** Data for an external link decoration. */
|
|
1577
|
+
linkData?: LinkData;
|
|
1578
|
+
/** Data for a mention decoration. */
|
|
1579
|
+
mentionData?: MentionData;
|
|
1580
|
+
/** Data for a font size decoration. */
|
|
1581
|
+
fontSizeData?: FontSizeData;
|
|
1582
|
+
/** Font weight for a bold decoration. */
|
|
1583
|
+
fontWeightValue?: number | null;
|
|
1584
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1585
|
+
italicData?: boolean | null;
|
|
1586
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1587
|
+
underlineData?: boolean | null;
|
|
1588
|
+
/** Data for a spoiler decoration. */
|
|
1589
|
+
spoilerData?: SpoilerData;
|
|
1590
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1591
|
+
strikethroughData?: boolean | null;
|
|
1592
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1593
|
+
superscriptData?: boolean | null;
|
|
1594
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1595
|
+
subscriptData?: boolean | null;
|
|
1596
|
+
/** Data for a font family decoration. */
|
|
1597
|
+
fontFamilyData?: FontFamilyData;
|
|
1598
|
+
/** Data for a hand-drawn sketch annotation decoration. */
|
|
1599
|
+
sketchData?: SketchData;
|
|
1600
|
+
/** The type of decoration to apply. */
|
|
1601
|
+
type?: DecorationTypeWithLiterals;
|
|
1602
|
+
}
|
|
1603
|
+
/** @oneof */
|
|
1604
|
+
interface DecorationDataOneOf {
|
|
1605
|
+
/** Data for an anchor link decoration. */
|
|
1606
|
+
anchorData?: AnchorData;
|
|
1607
|
+
/** Data for a color decoration. */
|
|
1608
|
+
colorData?: ColorData;
|
|
1609
|
+
/** Data for an external link decoration. */
|
|
1610
|
+
linkData?: LinkData;
|
|
1611
|
+
/** Data for a mention decoration. */
|
|
1612
|
+
mentionData?: MentionData;
|
|
1613
|
+
/** Data for a font size decoration. */
|
|
1614
|
+
fontSizeData?: FontSizeData;
|
|
1615
|
+
/** Font weight for a bold decoration. */
|
|
1616
|
+
fontWeightValue?: number | null;
|
|
1617
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1618
|
+
italicData?: boolean | null;
|
|
1619
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1620
|
+
underlineData?: boolean | null;
|
|
1621
|
+
/** Data for a spoiler decoration. */
|
|
1622
|
+
spoilerData?: SpoilerData;
|
|
1623
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1624
|
+
strikethroughData?: boolean | null;
|
|
1625
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1626
|
+
superscriptData?: boolean | null;
|
|
1627
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1628
|
+
subscriptData?: boolean | null;
|
|
1629
|
+
/** Data for a font family decoration. */
|
|
1630
|
+
fontFamilyData?: FontFamilyData;
|
|
1631
|
+
/** Data for a hand-drawn sketch annotation decoration. */
|
|
1632
|
+
sketchData?: SketchData;
|
|
1633
|
+
}
|
|
1634
|
+
declare enum DecorationType {
|
|
1635
|
+
BOLD = "BOLD",
|
|
1636
|
+
ITALIC = "ITALIC",
|
|
1637
|
+
UNDERLINE = "UNDERLINE",
|
|
1638
|
+
SPOILER = "SPOILER",
|
|
1639
|
+
ANCHOR = "ANCHOR",
|
|
1640
|
+
MENTION = "MENTION",
|
|
1641
|
+
LINK = "LINK",
|
|
1642
|
+
COLOR = "COLOR",
|
|
1643
|
+
FONT_SIZE = "FONT_SIZE",
|
|
1644
|
+
EXTERNAL = "EXTERNAL",
|
|
1645
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1646
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1647
|
+
SUBSCRIPT = "SUBSCRIPT",
|
|
1648
|
+
FONT_FAMILY = "FONT_FAMILY",
|
|
1649
|
+
SKETCH = "SKETCH"
|
|
1650
|
+
}
|
|
1651
|
+
/** @enumType */
|
|
1652
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY' | 'SKETCH';
|
|
1653
|
+
interface AnchorData {
|
|
1654
|
+
/** The target node's ID. */
|
|
1655
|
+
anchor?: string;
|
|
1656
|
+
}
|
|
1657
|
+
interface ColorData {
|
|
1658
|
+
/**
|
|
1659
|
+
* Deprecated: Use `backgroundStyle` instead. The text's background color as a hexadecimal value.
|
|
1660
|
+
* @deprecated
|
|
1661
|
+
*/
|
|
1662
|
+
background?: string | null;
|
|
1663
|
+
/**
|
|
1664
|
+
* Deprecated: Use `foregroundStyle` instead. The text's foreground color as a hexadecimal value.
|
|
1665
|
+
* @deprecated
|
|
1666
|
+
*/
|
|
1667
|
+
foreground?: string | null;
|
|
1668
|
+
/** Text fill styling (color or gradient). When present, takes precedence over `foreground`. */
|
|
1669
|
+
foregroundStyle?: ColorDataBackground;
|
|
1670
|
+
/** Text background (highlight) styling (color or gradient). When present, takes precedence over `background`. */
|
|
1671
|
+
backgroundStyle?: ColorDataBackground;
|
|
1672
|
+
}
|
|
1673
|
+
/** Background type */
|
|
1674
|
+
declare enum ColorDataBackgroundType {
|
|
1675
|
+
/** Solid color */
|
|
1676
|
+
COLOR = "COLOR",
|
|
1677
|
+
/** Gradient */
|
|
1678
|
+
GRADIENT = "GRADIENT"
|
|
1679
|
+
}
|
|
1680
|
+
/** @enumType */
|
|
1681
|
+
type ColorDataBackgroundTypeWithLiterals = ColorDataBackgroundType | 'COLOR' | 'GRADIENT';
|
|
1682
|
+
/** Fill styling (color or gradient) */
|
|
1683
|
+
interface ColorDataBackground {
|
|
1684
|
+
/** Background type. */
|
|
1685
|
+
type?: ColorDataBackgroundTypeWithLiterals;
|
|
1686
|
+
/**
|
|
1687
|
+
* Color as a hexadecimal value.
|
|
1688
|
+
* @maxLength 19
|
|
1689
|
+
*/
|
|
1690
|
+
color?: string | null;
|
|
1691
|
+
/** Gradient configuration. */
|
|
1692
|
+
gradient?: Gradient;
|
|
1693
|
+
}
|
|
1694
|
+
interface LinkData {
|
|
1695
|
+
/** Link details. */
|
|
1696
|
+
link?: Link$1;
|
|
1697
|
+
}
|
|
1698
|
+
interface MentionData {
|
|
1699
|
+
/** The mentioned user's name. */
|
|
1700
|
+
name?: string;
|
|
1701
|
+
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1702
|
+
slug?: string;
|
|
1703
|
+
/** Mentioned user's ID. */
|
|
1704
|
+
id?: string | null;
|
|
1705
|
+
/** 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. */
|
|
1706
|
+
type?: string | null;
|
|
1707
|
+
}
|
|
1708
|
+
interface SpoilerData {
|
|
1709
|
+
/** Spoiler ID. */
|
|
1710
|
+
id?: string | null;
|
|
1711
|
+
}
|
|
1712
|
+
interface FontFamilyData {
|
|
1713
|
+
/** @maxLength 1000 */
|
|
1714
|
+
value?: string | null;
|
|
1715
|
+
}
|
|
1716
|
+
interface SketchData {
|
|
1717
|
+
/** The sketch annotation variant to draw over the text. */
|
|
1718
|
+
variant?: VariantWithLiterals;
|
|
1719
|
+
/**
|
|
1720
|
+
* Annotation color. Defaults to the theme action color.
|
|
1721
|
+
* @maxLength 19
|
|
1722
|
+
*/
|
|
1723
|
+
color?: string | null;
|
|
1724
|
+
/** Whether the annotation animates on first paint. Defaults to `true`. */
|
|
1725
|
+
animate?: boolean | null;
|
|
1726
|
+
}
|
|
1727
|
+
declare enum Variant {
|
|
1728
|
+
UNDERLINE = "UNDERLINE",
|
|
1729
|
+
BOX = "BOX",
|
|
1730
|
+
CIRCLE = "CIRCLE",
|
|
1731
|
+
HIGHLIGHT = "HIGHLIGHT",
|
|
1732
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1733
|
+
CROSSED_OFF = "CROSSED_OFF"
|
|
1734
|
+
}
|
|
1735
|
+
/** @enumType */
|
|
1736
|
+
type VariantWithLiterals = Variant | 'UNDERLINE' | 'BOX' | 'CIRCLE' | 'HIGHLIGHT' | 'STRIKETHROUGH' | 'CROSSED_OFF';
|
|
1737
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1738
|
+
/** Data for embedded Wix Bookings content. */
|
|
1739
|
+
bookingData?: BookingData;
|
|
1740
|
+
/** Data for embedded Wix Events content. */
|
|
1741
|
+
eventData?: EventData;
|
|
1742
|
+
/** The type of Wix App content being embedded. */
|
|
1743
|
+
type?: AppTypeWithLiterals;
|
|
1744
|
+
/** The ID of the embedded content. */
|
|
1745
|
+
itemId?: string | null;
|
|
1746
|
+
/** The name of the embedded content. */
|
|
1747
|
+
name?: string | null;
|
|
1748
|
+
/**
|
|
1749
|
+
* Deprecated: Use `image` instead.
|
|
1750
|
+
* @deprecated
|
|
1751
|
+
*/
|
|
1752
|
+
imageSrc?: string | null;
|
|
1753
|
+
/** The URL for the embedded content. */
|
|
1754
|
+
url?: string | null;
|
|
1755
|
+
/** An image for the embedded content. */
|
|
1756
|
+
image?: V1Media;
|
|
1757
|
+
/** Whether to hide the image. */
|
|
1758
|
+
hideImage?: boolean | null;
|
|
1759
|
+
/** Whether to hide the title. */
|
|
1760
|
+
hideTitle?: boolean | null;
|
|
1761
|
+
/** Whether to hide the price. */
|
|
1762
|
+
hidePrice?: boolean | null;
|
|
1763
|
+
/** Whether to hide the description (Event and Booking). */
|
|
1764
|
+
hideDescription?: boolean | null;
|
|
1765
|
+
/** Whether to hide the date and time (Event). */
|
|
1766
|
+
hideDateTime?: boolean | null;
|
|
1767
|
+
/** Whether to hide the location (Event). */
|
|
1768
|
+
hideLocation?: boolean | null;
|
|
1769
|
+
/** Whether to hide the duration (Booking). */
|
|
1770
|
+
hideDuration?: boolean | null;
|
|
1771
|
+
/** Whether to hide the button. */
|
|
1772
|
+
hideButton?: boolean | null;
|
|
1773
|
+
/** Whether to hide the ribbon. */
|
|
1774
|
+
hideRibbon?: boolean | null;
|
|
1775
|
+
/** Button styling options. */
|
|
1776
|
+
buttonStyles?: ButtonStyles;
|
|
1777
|
+
/** Image styling options. */
|
|
1778
|
+
imageStyles?: ImageStyles;
|
|
1779
|
+
/** Ribbon styling options. */
|
|
1780
|
+
ribbonStyles?: RibbonStyles;
|
|
1781
|
+
/** Card styling options. */
|
|
1782
|
+
cardStyles?: CardStyles;
|
|
1783
|
+
/** Styling for the app embed's container. */
|
|
1784
|
+
containerData?: PluginContainerData;
|
|
1785
|
+
/** Pricing data for embedded Wix App content. */
|
|
1786
|
+
pricingData?: PricingData;
|
|
1787
|
+
/** Node animation. */
|
|
1788
|
+
animation?: Animation;
|
|
1789
|
+
}
|
|
1790
|
+
/** @oneof */
|
|
1791
|
+
interface AppEmbedDataAppDataOneOf {
|
|
1792
|
+
/** Data for embedded Wix Bookings content. */
|
|
1793
|
+
bookingData?: BookingData;
|
|
1794
|
+
/** Data for embedded Wix Events content. */
|
|
1795
|
+
eventData?: EventData;
|
|
1796
|
+
}
|
|
1797
|
+
declare enum Position {
|
|
1798
|
+
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1799
|
+
START = "START",
|
|
1800
|
+
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1801
|
+
END = "END",
|
|
1802
|
+
/** Image positioned at the top */
|
|
1803
|
+
TOP = "TOP"
|
|
1804
|
+
}
|
|
1805
|
+
/** @enumType */
|
|
1806
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
|
|
1807
|
+
declare enum AspectRatio {
|
|
1808
|
+
/** 1:1 aspect ratio */
|
|
1809
|
+
SQUARE = "SQUARE",
|
|
1810
|
+
/** 16:9 aspect ratio */
|
|
1811
|
+
RECTANGLE = "RECTANGLE"
|
|
1812
|
+
}
|
|
1813
|
+
/** @enumType */
|
|
1814
|
+
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
|
|
1815
|
+
declare enum Resizing {
|
|
1816
|
+
/** Fill the container, may crop the image */
|
|
1817
|
+
FILL = "FILL",
|
|
1818
|
+
/** Fit the image within the container */
|
|
1819
|
+
FIT = "FIT"
|
|
1820
|
+
}
|
|
1821
|
+
/** @enumType */
|
|
1822
|
+
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
|
|
1823
|
+
declare enum Placement {
|
|
1824
|
+
/** Ribbon placed on the image */
|
|
1825
|
+
IMAGE = "IMAGE",
|
|
1826
|
+
/** Ribbon placed on the product information */
|
|
1827
|
+
PRODUCT_INFO = "PRODUCT_INFO"
|
|
1828
|
+
}
|
|
1829
|
+
/** @enumType */
|
|
1830
|
+
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
|
|
1831
|
+
declare enum CardStylesType {
|
|
1832
|
+
/** Card with visible border and background */
|
|
1833
|
+
CONTAINED = "CONTAINED",
|
|
1834
|
+
/** Card without visible border */
|
|
1835
|
+
FRAMELESS = "FRAMELESS"
|
|
1836
|
+
}
|
|
1837
|
+
/** @enumType */
|
|
1838
|
+
type CardStylesTypeWithLiterals = CardStylesType | 'CONTAINED' | 'FRAMELESS';
|
|
1839
|
+
declare enum Alignment {
|
|
1840
|
+
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
|
|
1841
|
+
START = "START",
|
|
1842
|
+
/** Content centered */
|
|
1843
|
+
CENTER = "CENTER",
|
|
1844
|
+
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
|
|
1845
|
+
END = "END"
|
|
1846
|
+
}
|
|
1847
|
+
/** @enumType */
|
|
1848
|
+
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
|
|
1849
|
+
declare enum Layout {
|
|
1850
|
+
/** Elements stacked vertically */
|
|
1851
|
+
STACKED = "STACKED",
|
|
1852
|
+
/** Elements arranged horizontally */
|
|
1853
|
+
SIDE_BY_SIDE = "SIDE_BY_SIDE"
|
|
1854
|
+
}
|
|
1855
|
+
/** @enumType */
|
|
1856
|
+
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
|
|
1857
|
+
declare enum AppType {
|
|
1858
|
+
PRODUCT = "PRODUCT",
|
|
1859
|
+
EVENT = "EVENT",
|
|
1860
|
+
BOOKING = "BOOKING"
|
|
1861
|
+
}
|
|
1862
|
+
/** @enumType */
|
|
1863
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1864
|
+
interface BookingData {
|
|
1865
|
+
/** Booking duration in minutes. */
|
|
1866
|
+
durations?: string | null;
|
|
1867
|
+
}
|
|
1868
|
+
interface EventData {
|
|
1869
|
+
/** Event schedule. */
|
|
1870
|
+
scheduling?: string | null;
|
|
1871
|
+
/** Event location. */
|
|
1872
|
+
location?: string | null;
|
|
1873
|
+
}
|
|
1874
|
+
interface ButtonStyles {
|
|
1875
|
+
/** Text to display on the button. */
|
|
1876
|
+
buttonText?: string | null;
|
|
1877
|
+
/** Border width in pixels. */
|
|
1878
|
+
borderWidth?: number | null;
|
|
1879
|
+
/** Border radius in pixels. */
|
|
1880
|
+
borderRadius?: number | null;
|
|
1881
|
+
/**
|
|
1882
|
+
* Border color as a hexadecimal value.
|
|
1883
|
+
* @maxLength 19
|
|
1884
|
+
*/
|
|
1885
|
+
borderColor?: string | null;
|
|
1886
|
+
/**
|
|
1887
|
+
* Text color as a hexadecimal value.
|
|
1888
|
+
* @maxLength 19
|
|
1889
|
+
*/
|
|
1890
|
+
textColor?: string | null;
|
|
1891
|
+
/**
|
|
1892
|
+
* Background color as a hexadecimal value.
|
|
1893
|
+
* @maxLength 19
|
|
1894
|
+
*/
|
|
1895
|
+
backgroundColor?: string | null;
|
|
1896
|
+
/**
|
|
1897
|
+
* Border color as a hexadecimal value (hover state).
|
|
1898
|
+
* @maxLength 19
|
|
1899
|
+
*/
|
|
1900
|
+
borderColorHover?: string | null;
|
|
1901
|
+
/**
|
|
1902
|
+
* Text color as a hexadecimal value (hover state).
|
|
1903
|
+
* @maxLength 19
|
|
1904
|
+
*/
|
|
1905
|
+
textColorHover?: string | null;
|
|
1906
|
+
/**
|
|
1907
|
+
* Background color as a hexadecimal value (hover state).
|
|
1908
|
+
* @maxLength 19
|
|
1909
|
+
*/
|
|
1910
|
+
backgroundColorHover?: string | null;
|
|
1911
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1912
|
+
buttonSize?: string | null;
|
|
1913
|
+
}
|
|
1914
|
+
interface ImageStyles {
|
|
1915
|
+
/** Whether to hide the image. */
|
|
1916
|
+
hideImage?: boolean | null;
|
|
1917
|
+
/** Position of image. Defaults to `START`. */
|
|
1918
|
+
imagePosition?: PositionWithLiterals;
|
|
1919
|
+
/** Aspect ratio for the image. Defaults to `SQUARE`. */
|
|
1920
|
+
aspectRatio?: AspectRatioWithLiterals;
|
|
1921
|
+
/** How the image should be resized. Defaults to `FILL`. */
|
|
1922
|
+
resizing?: ResizingWithLiterals;
|
|
1923
|
+
/**
|
|
1924
|
+
* Image border color as a hexadecimal value.
|
|
1925
|
+
* @maxLength 19
|
|
1926
|
+
*/
|
|
1927
|
+
borderColor?: string | null;
|
|
1928
|
+
/** Image border width in pixels. */
|
|
1929
|
+
borderWidth?: number | null;
|
|
1930
|
+
/** Image border radius in pixels. */
|
|
1931
|
+
borderRadius?: number | null;
|
|
1932
|
+
}
|
|
1933
|
+
interface RibbonStyles {
|
|
1934
|
+
/** Text to display on the ribbon. */
|
|
1935
|
+
ribbonText?: string | null;
|
|
1936
|
+
/**
|
|
1937
|
+
* Ribbon background color as a hexadecimal value.
|
|
1938
|
+
* @maxLength 19
|
|
1939
|
+
*/
|
|
1940
|
+
backgroundColor?: string | null;
|
|
1941
|
+
/**
|
|
1942
|
+
* Ribbon text color as a hexadecimal value.
|
|
1943
|
+
* @maxLength 19
|
|
1944
|
+
*/
|
|
1945
|
+
textColor?: string | null;
|
|
1946
|
+
/**
|
|
1947
|
+
* Ribbon border color as a hexadecimal value.
|
|
1948
|
+
* @maxLength 19
|
|
1949
|
+
*/
|
|
1950
|
+
borderColor?: string | null;
|
|
1951
|
+
/** Ribbon border width in pixels. */
|
|
1952
|
+
borderWidth?: number | null;
|
|
1953
|
+
/** Ribbon border radius in pixels. */
|
|
1954
|
+
borderRadius?: number | null;
|
|
1955
|
+
/** Placement of the ribbon. Defaults to `IMAGE`. */
|
|
1956
|
+
ribbonPlacement?: PlacementWithLiterals;
|
|
1957
|
+
}
|
|
1958
|
+
interface CardStyles {
|
|
1959
|
+
/**
|
|
1960
|
+
* Card background color as a hexadecimal value.
|
|
1961
|
+
* @maxLength 19
|
|
1962
|
+
*/
|
|
1963
|
+
backgroundColor?: string | null;
|
|
1964
|
+
/**
|
|
1965
|
+
* Card border color as a hexadecimal value.
|
|
1966
|
+
* @maxLength 19
|
|
1967
|
+
*/
|
|
1968
|
+
borderColor?: string | null;
|
|
1969
|
+
/** Card border width in pixels. */
|
|
1970
|
+
borderWidth?: number | null;
|
|
1971
|
+
/** Card border radius in pixels. */
|
|
1972
|
+
borderRadius?: number | null;
|
|
1973
|
+
/** Card type. Defaults to `CONTAINED`. */
|
|
1974
|
+
type?: CardStylesTypeWithLiterals;
|
|
1975
|
+
/** Content alignment. Defaults to `START`. */
|
|
1976
|
+
alignment?: AlignmentWithLiterals;
|
|
1977
|
+
/** Layout for title and price. Defaults to `STACKED`. */
|
|
1978
|
+
titlePriceLayout?: LayoutWithLiterals;
|
|
1979
|
+
/**
|
|
1980
|
+
* Title text color as a hexadecimal value.
|
|
1981
|
+
* @maxLength 19
|
|
1982
|
+
*/
|
|
1983
|
+
titleColor?: string | null;
|
|
1984
|
+
/**
|
|
1985
|
+
* Text color as a hexadecimal value.
|
|
1986
|
+
* @maxLength 19
|
|
1987
|
+
*/
|
|
1988
|
+
textColor?: string | null;
|
|
1989
|
+
}
|
|
1990
|
+
interface PricingData {
|
|
1991
|
+
/**
|
|
1992
|
+
* Minimum numeric price value as string (e.g., "10.99").
|
|
1993
|
+
* @decimalValue options { maxScale:2 }
|
|
1994
|
+
*/
|
|
1995
|
+
valueFrom?: string | null;
|
|
1996
|
+
/**
|
|
1997
|
+
* Maximum numeric price value as string (e.g., "19.99").
|
|
1998
|
+
* @decimalValue options { maxScale:2 }
|
|
1999
|
+
*/
|
|
2000
|
+
valueTo?: string | null;
|
|
2001
|
+
/**
|
|
2002
|
+
* Numeric price value as string after discount application (e.g., "15.99").
|
|
2003
|
+
* @decimalValue options { maxScale:2 }
|
|
2004
|
+
*/
|
|
2005
|
+
discountedValue?: string | null;
|
|
2006
|
+
/**
|
|
2007
|
+
* Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
|
|
2008
|
+
* @format CURRENCY
|
|
2009
|
+
*/
|
|
2010
|
+
currency?: string | null;
|
|
2011
|
+
/**
|
|
2012
|
+
* Pricing plan ID.
|
|
2013
|
+
* @format GUID
|
|
2014
|
+
*/
|
|
2015
|
+
pricingPlanId?: string | null;
|
|
2016
|
+
}
|
|
2017
|
+
interface VideoData {
|
|
2018
|
+
/** Styling for the video's container. */
|
|
2019
|
+
containerData?: PluginContainerData;
|
|
2020
|
+
/** Video details. */
|
|
2021
|
+
video?: V1Media;
|
|
2022
|
+
/** Video thumbnail details. */
|
|
2023
|
+
thumbnail?: V1Media;
|
|
2024
|
+
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
2025
|
+
disableDownload?: boolean | null;
|
|
2026
|
+
/** Video title. */
|
|
2027
|
+
title?: string | null;
|
|
2028
|
+
/** Video options. */
|
|
2029
|
+
options?: PlaybackOptions;
|
|
2030
|
+
/** Node animation. */
|
|
2031
|
+
animation?: Animation;
|
|
2032
|
+
}
|
|
2033
|
+
interface PlaybackOptions {
|
|
2034
|
+
/** Sets whether the media will automatically start playing. */
|
|
2035
|
+
autoPlay?: boolean | null;
|
|
2036
|
+
/** Sets whether media's will be looped. */
|
|
2037
|
+
playInLoop?: boolean | null;
|
|
2038
|
+
/** Sets whether media's controls will be shown. */
|
|
2039
|
+
showControls?: boolean | null;
|
|
2040
|
+
}
|
|
2041
|
+
interface EmbedData {
|
|
2042
|
+
/** Styling for the oEmbed node's container. */
|
|
2043
|
+
containerData?: PluginContainerData;
|
|
2044
|
+
/** An [oEmbed](https://www.oembed.com) object. */
|
|
2045
|
+
oembed?: Oembed;
|
|
2046
|
+
/** Origin asset source. */
|
|
2047
|
+
src?: string | null;
|
|
2048
|
+
/** Node animation. */
|
|
2049
|
+
animation?: Animation;
|
|
2050
|
+
}
|
|
2051
|
+
interface Oembed {
|
|
2052
|
+
/** The resource type. */
|
|
2053
|
+
type?: string | null;
|
|
2054
|
+
/** The width of the resource specified in the `url` property in pixels. */
|
|
2055
|
+
width?: number | null;
|
|
2056
|
+
/** The height of the resource specified in the `url` property in pixels. */
|
|
2057
|
+
height?: number | null;
|
|
2058
|
+
/** Resource title. */
|
|
2059
|
+
title?: string | null;
|
|
2060
|
+
/** The source URL for the resource. */
|
|
2061
|
+
url?: string | null;
|
|
2062
|
+
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
2063
|
+
html?: string | null;
|
|
2064
|
+
/** The name of the author or owner of the resource. */
|
|
2065
|
+
authorName?: string | null;
|
|
2066
|
+
/** The URL for the author or owner of the resource. */
|
|
2067
|
+
authorUrl?: string | null;
|
|
2068
|
+
/** The name of the resource provider. */
|
|
2069
|
+
providerName?: string | null;
|
|
2070
|
+
/** The URL for the resource provider. */
|
|
2071
|
+
providerUrl?: string | null;
|
|
2072
|
+
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
2073
|
+
thumbnailUrl?: string | null;
|
|
2074
|
+
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
2075
|
+
thumbnailWidth?: string | null;
|
|
2076
|
+
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
2077
|
+
thumbnailHeight?: string | null;
|
|
2078
|
+
/** The URL for an embedded viedo. */
|
|
2079
|
+
videoUrl?: string | null;
|
|
2080
|
+
/** The oEmbed version number. This value must be `1.0`. */
|
|
2081
|
+
version?: string | null;
|
|
2082
|
+
}
|
|
2083
|
+
interface CollapsibleListData {
|
|
2084
|
+
/** Styling for the collapsible list's container. */
|
|
2085
|
+
containerData?: PluginContainerData;
|
|
2086
|
+
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2087
|
+
expandOnlyOne?: boolean | null;
|
|
2088
|
+
/** Sets which items are expanded when the page loads. */
|
|
2089
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2090
|
+
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2091
|
+
direction?: DirectionWithLiterals;
|
|
2092
|
+
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2093
|
+
isQapageData?: boolean | null;
|
|
2094
|
+
/** Node animation. */
|
|
2095
|
+
animation?: Animation;
|
|
2096
|
+
}
|
|
2097
|
+
declare enum InitialExpandedItems {
|
|
2098
|
+
/** First item will be expended initally */
|
|
2099
|
+
FIRST = "FIRST",
|
|
2100
|
+
/** All items will expended initally */
|
|
2101
|
+
ALL = "ALL",
|
|
2102
|
+
/** All items collapsed initally */
|
|
2103
|
+
NONE = "NONE"
|
|
2104
|
+
}
|
|
2105
|
+
/** @enumType */
|
|
2106
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2107
|
+
declare enum Direction {
|
|
2108
|
+
/** Left-to-right */
|
|
2109
|
+
LTR = "LTR",
|
|
2110
|
+
/** Right-to-left */
|
|
2111
|
+
RTL = "RTL"
|
|
2112
|
+
}
|
|
2113
|
+
/** @enumType */
|
|
2114
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2115
|
+
interface TableData {
|
|
2116
|
+
/** Styling for the table's container. */
|
|
2117
|
+
containerData?: PluginContainerData;
|
|
2118
|
+
/** The table's dimensions. */
|
|
2119
|
+
dimensions?: Dimensions;
|
|
2120
|
+
/**
|
|
2121
|
+
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
2122
|
+
* @deprecated
|
|
2123
|
+
*/
|
|
2124
|
+
header?: boolean | null;
|
|
2125
|
+
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
2126
|
+
rowHeader?: boolean | null;
|
|
2127
|
+
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2128
|
+
columnHeader?: boolean | null;
|
|
2129
|
+
/** The spacing between cells in pixels. Defaults to `0`. */
|
|
2130
|
+
cellSpacing?: number | null;
|
|
2131
|
+
/**
|
|
2132
|
+
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
|
|
2133
|
+
* @maxSize 4
|
|
2134
|
+
*/
|
|
2135
|
+
cellPadding?: number[];
|
|
2136
|
+
/** Table's alternative text. */
|
|
2137
|
+
altText?: string | null;
|
|
2138
|
+
/** Node animation. */
|
|
2139
|
+
animation?: Animation;
|
|
2140
|
+
}
|
|
2141
|
+
interface Dimensions {
|
|
2142
|
+
/** An array representing relative width of each column in relation to the other columns. */
|
|
2143
|
+
colsWidthRatio?: number[];
|
|
2144
|
+
/** An array representing the height of each row in pixels. */
|
|
2145
|
+
rowsHeight?: number[];
|
|
2146
|
+
/** An array representing the minimum width of each column in pixels. */
|
|
2147
|
+
colsMinWidth?: number[];
|
|
2148
|
+
}
|
|
2149
|
+
interface TableCellData {
|
|
2150
|
+
/** Styling for the cell's background color and text alignment. */
|
|
2151
|
+
cellStyle?: CellStyle;
|
|
2152
|
+
/** The cell's border colors. */
|
|
2153
|
+
borderColors?: BorderColors;
|
|
2154
|
+
/** Defines how many columns the cell spans. Default: 1. */
|
|
2155
|
+
colspan?: number | null;
|
|
2156
|
+
/** Defines how many rows the cell spans. Default: 1. */
|
|
2157
|
+
rowspan?: number | null;
|
|
2158
|
+
/** The cell's border widths. */
|
|
2159
|
+
borderWidths?: BorderWidths;
|
|
2160
|
+
}
|
|
2161
|
+
declare enum VerticalAlignment {
|
|
2162
|
+
/** Top alignment */
|
|
2163
|
+
TOP = "TOP",
|
|
2164
|
+
/** Middle alignment */
|
|
2165
|
+
MIDDLE = "MIDDLE",
|
|
2166
|
+
/** Bottom alignment */
|
|
2167
|
+
BOTTOM = "BOTTOM"
|
|
2168
|
+
}
|
|
2169
|
+
/** @enumType */
|
|
2170
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2171
|
+
interface CellStyle {
|
|
2172
|
+
/** Vertical alignment for the cell's text. */
|
|
2173
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2174
|
+
/**
|
|
2175
|
+
* Cell background color as a hexadecimal value.
|
|
2176
|
+
* @maxLength 19
|
|
2177
|
+
*/
|
|
2178
|
+
backgroundColor?: string | null;
|
|
2179
|
+
}
|
|
2180
|
+
interface BorderColors {
|
|
2181
|
+
/**
|
|
2182
|
+
* Left border color as a hexadecimal value.
|
|
2183
|
+
* @maxLength 19
|
|
2184
|
+
*/
|
|
2185
|
+
left?: string | null;
|
|
2186
|
+
/**
|
|
2187
|
+
* Right border color as a hexadecimal value.
|
|
2188
|
+
* @maxLength 19
|
|
2189
|
+
*/
|
|
2190
|
+
right?: string | null;
|
|
2191
|
+
/**
|
|
2192
|
+
* Top border color as a hexadecimal value.
|
|
2193
|
+
* @maxLength 19
|
|
2194
|
+
*/
|
|
2195
|
+
top?: string | null;
|
|
2196
|
+
/**
|
|
2197
|
+
* Bottom border color as a hexadecimal value.
|
|
2198
|
+
* @maxLength 19
|
|
2199
|
+
*/
|
|
2200
|
+
bottom?: string | null;
|
|
2201
|
+
}
|
|
2202
|
+
interface BorderWidths {
|
|
2203
|
+
/** Left border width in pixels. */
|
|
2204
|
+
left?: number | null;
|
|
2205
|
+
/** Right border width in pixels. */
|
|
2206
|
+
right?: number | null;
|
|
2207
|
+
/** Top border width in pixels. */
|
|
2208
|
+
top?: number | null;
|
|
2209
|
+
/** Bottom border width in pixels. */
|
|
2210
|
+
bottom?: number | null;
|
|
2211
|
+
}
|
|
2212
|
+
/**
|
|
2213
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
2214
|
+
* `Value` type union.
|
|
2215
|
+
*
|
|
2216
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
2217
|
+
*/
|
|
2218
|
+
interface AudioData {
|
|
2219
|
+
/** Styling for the audio node's container. */
|
|
2220
|
+
containerData?: PluginContainerData;
|
|
2221
|
+
/** Audio file details. */
|
|
2222
|
+
audio?: V1Media;
|
|
2223
|
+
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
2224
|
+
disableDownload?: boolean | null;
|
|
2225
|
+
/** Cover image. */
|
|
2226
|
+
coverImage?: V1Media;
|
|
2227
|
+
/** Track name. */
|
|
2228
|
+
name?: string | null;
|
|
2229
|
+
/** Author name. */
|
|
2230
|
+
authorName?: string | null;
|
|
2231
|
+
/** An HTML version of the audio node. */
|
|
2232
|
+
html?: string | null;
|
|
2233
|
+
/** Node animation. */
|
|
2234
|
+
animation?: Animation;
|
|
2235
|
+
}
|
|
2236
|
+
interface OrderedListData {
|
|
2237
|
+
/** Indentation level from 0-4. */
|
|
2238
|
+
indentation?: number;
|
|
2239
|
+
/** Offset level from 0-4. */
|
|
2240
|
+
offset?: number | null;
|
|
2241
|
+
/** List start number. */
|
|
2242
|
+
start?: number | null;
|
|
2243
|
+
/** Node animation. */
|
|
2244
|
+
animation?: Animation;
|
|
2245
|
+
}
|
|
2246
|
+
interface BulletedListData {
|
|
2247
|
+
/** Indentation level from 0-4. */
|
|
2248
|
+
indentation?: number;
|
|
2249
|
+
/** Offset level from 0-4. */
|
|
2250
|
+
offset?: number | null;
|
|
2251
|
+
/** Node animation. */
|
|
2252
|
+
animation?: Animation;
|
|
2253
|
+
}
|
|
2254
|
+
interface BlockquoteData {
|
|
2255
|
+
/** Indentation level from 1-4. */
|
|
2256
|
+
indentation?: number;
|
|
2257
|
+
/** Node animation. */
|
|
2258
|
+
animation?: Animation;
|
|
2259
|
+
}
|
|
2260
|
+
interface CaptionData {
|
|
2261
|
+
textStyle?: TextStyle;
|
|
2262
|
+
}
|
|
2263
|
+
interface LayoutData {
|
|
2264
|
+
/**
|
|
2265
|
+
* Deprecated: Use `background` instead.
|
|
2266
|
+
* @maxLength 19
|
|
2267
|
+
* @deprecated
|
|
2268
|
+
*/
|
|
2269
|
+
backgroundColor?: string | null;
|
|
2270
|
+
/** Background image. */
|
|
2271
|
+
backgroundImage?: LayoutDataBackgroundImage;
|
|
2272
|
+
/**
|
|
2273
|
+
* Border color as a hexadecimal value.
|
|
2274
|
+
* @maxLength 19
|
|
2275
|
+
*/
|
|
2276
|
+
borderColor?: string | null;
|
|
2277
|
+
/** Border width in pixels. */
|
|
2278
|
+
borderWidth?: number | null;
|
|
2279
|
+
/** Border radius in pixels. */
|
|
2280
|
+
borderRadius?: number | null;
|
|
2281
|
+
/**
|
|
2282
|
+
* Deprecated: Use `backdrop` instead.
|
|
2283
|
+
* @maxLength 19
|
|
2284
|
+
* @deprecated
|
|
2285
|
+
*/
|
|
2286
|
+
backdropColor?: string | null;
|
|
2287
|
+
/** Backdrop image. */
|
|
2288
|
+
backdropImage?: LayoutDataBackgroundImage;
|
|
2289
|
+
/** Backdrop top padding. */
|
|
2290
|
+
backdropPaddingTop?: number | null;
|
|
2291
|
+
/** Backdrop bottom padding */
|
|
2292
|
+
backdropPaddingBottom?: number | null;
|
|
2293
|
+
/** Horizontal and vertical gap between columns */
|
|
2294
|
+
gap?: number | null;
|
|
2295
|
+
/**
|
|
2296
|
+
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left
|
|
2297
|
+
* @maxSize 4
|
|
2298
|
+
*/
|
|
2299
|
+
cellPadding?: number[];
|
|
2300
|
+
/** Vertical alignment for the cell's items. */
|
|
2301
|
+
cellVerticalAlignment?: VerticalAlignmentAlignmentWithLiterals;
|
|
2302
|
+
/** Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers. */
|
|
2303
|
+
responsivenessBehaviour?: ResponsivenessBehaviourWithLiterals;
|
|
2304
|
+
/** Size in pixels when responsiveness_behaviour applies */
|
|
2305
|
+
responsivenessBreakpoint?: number | null;
|
|
2306
|
+
/** Styling for the layout's container. */
|
|
2307
|
+
containerData?: PluginContainerData;
|
|
2308
|
+
/** Defines where selected design propertied applies to */
|
|
2309
|
+
designTarget?: DesignTargetWithLiterals;
|
|
2310
|
+
/** Where this layout sits: an edge banner, or the paywall cut. One field, so the two can never be combined. */
|
|
2311
|
+
banner?: Banner;
|
|
2312
|
+
/** Background styling (color or gradient). */
|
|
2313
|
+
background?: LayoutDataBackground;
|
|
2314
|
+
/** Backdrop styling (color or gradient). */
|
|
2315
|
+
backdrop?: Backdrop;
|
|
2316
|
+
/** Node animation. */
|
|
2317
|
+
animation?: Animation;
|
|
2318
|
+
/** Shape divider at the top edge of the layout. */
|
|
2319
|
+
topDivider?: SectionDivider;
|
|
2320
|
+
/** Shape divider at the bottom edge of the layout. */
|
|
2321
|
+
bottomDivider?: SectionDivider;
|
|
2322
|
+
}
|
|
2323
|
+
declare enum ImageScalingScaling {
|
|
2324
|
+
/** Auto image scaling */
|
|
2325
|
+
AUTO = "AUTO",
|
|
2326
|
+
/** Contain image scaling */
|
|
2327
|
+
CONTAIN = "CONTAIN",
|
|
2328
|
+
/** Cover image scaling */
|
|
2329
|
+
COVER = "COVER"
|
|
2330
|
+
}
|
|
2331
|
+
/** @enumType */
|
|
2332
|
+
type ImageScalingScalingWithLiterals = ImageScalingScaling | 'AUTO' | 'CONTAIN' | 'COVER';
|
|
2333
|
+
declare enum ImagePosition {
|
|
2334
|
+
/** Image positioned at the center */
|
|
2335
|
+
CENTER = "CENTER",
|
|
2336
|
+
/** Image positioned on the left */
|
|
2337
|
+
CENTER_LEFT = "CENTER_LEFT",
|
|
2338
|
+
/** Image positioned on the right */
|
|
2339
|
+
CENTER_RIGHT = "CENTER_RIGHT",
|
|
2340
|
+
/** Image positioned at the center top */
|
|
2341
|
+
TOP = "TOP",
|
|
2342
|
+
/** Image positioned at the top left */
|
|
2343
|
+
TOP_LEFT = "TOP_LEFT",
|
|
2344
|
+
/** Image positioned at the top right */
|
|
2345
|
+
TOP_RIGHT = "TOP_RIGHT",
|
|
2346
|
+
/** Image positioned at the center bottom */
|
|
2347
|
+
BOTTOM = "BOTTOM",
|
|
2348
|
+
/** Image positioned at the bottom left */
|
|
2349
|
+
BOTTOM_LEFT = "BOTTOM_LEFT",
|
|
2350
|
+
/** Image positioned at the bottom right */
|
|
2351
|
+
BOTTOM_RIGHT = "BOTTOM_RIGHT"
|
|
2352
|
+
}
|
|
2353
|
+
/** @enumType */
|
|
2354
|
+
type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
2355
|
+
/** Background styling (color or gradient) */
|
|
2356
|
+
interface LayoutDataBackground {
|
|
2357
|
+
/** Background type. */
|
|
2358
|
+
type?: LayoutDataBackgroundTypeWithLiterals;
|
|
2359
|
+
/**
|
|
2360
|
+
* Background color as a hexadecimal value.
|
|
2361
|
+
* @maxLength 19
|
|
2362
|
+
*/
|
|
2363
|
+
color?: string | null;
|
|
2364
|
+
/** Gradient configuration. */
|
|
2365
|
+
gradient?: Gradient;
|
|
2366
|
+
}
|
|
2367
|
+
/** Background type */
|
|
2368
|
+
declare enum LayoutDataBackgroundType {
|
|
2369
|
+
/** Solid color background */
|
|
2370
|
+
COLOR = "COLOR",
|
|
2371
|
+
/** Gradient background */
|
|
2372
|
+
GRADIENT = "GRADIENT"
|
|
2373
|
+
}
|
|
2374
|
+
/** @enumType */
|
|
2375
|
+
type LayoutDataBackgroundTypeWithLiterals = LayoutDataBackgroundType | 'COLOR' | 'GRADIENT';
|
|
2376
|
+
declare enum Origin {
|
|
2377
|
+
/** Banner originated from an image */
|
|
2378
|
+
IMAGE = "IMAGE",
|
|
2379
|
+
/** Banner originated from a layout */
|
|
2380
|
+
LAYOUT = "LAYOUT"
|
|
2381
|
+
}
|
|
2382
|
+
/** @enumType */
|
|
2383
|
+
type OriginWithLiterals = Origin | 'IMAGE' | 'LAYOUT';
|
|
2384
|
+
declare enum BannerPosition {
|
|
2385
|
+
/** Attached to the top edge (banner). The default, so a banner written before this field existed decodes as TOP. */
|
|
2386
|
+
TOP = "TOP",
|
|
2387
|
+
/** Attached to the bottom edge (footer). */
|
|
2388
|
+
BOTTOM = "BOTTOM",
|
|
2389
|
+
/** The cut between free and paid content, not an edge banner. `origin` carries no meaning for it. */
|
|
2390
|
+
PAYWALL = "PAYWALL"
|
|
2391
|
+
}
|
|
2392
|
+
/** @enumType */
|
|
2393
|
+
type BannerPositionWithLiterals = BannerPosition | 'TOP' | 'BOTTOM' | 'PAYWALL';
|
|
2394
|
+
/** How the stacked layers fade relative to the base shape. Named for a bottom divider; top dividers render mirrored, so the visual fade flips. */
|
|
2395
|
+
declare enum LayerEffect {
|
|
2396
|
+
/** Shape keeps its height, a solid filler bar pushes it away from the edge */
|
|
2397
|
+
CENTER = "CENTER",
|
|
2398
|
+
/** Deeper (more transparent) layers shrink toward the edge inside the original band while a solid filler bar keeps its full height, so the faded copies hug the top of the band */
|
|
2399
|
+
FADE_TO_TOP = "FADE_TO_TOP",
|
|
2400
|
+
/** Deeper (more transparent) layers stretch taller into the section, so the faded copies fan out above the base shape and descend to the layout edge */
|
|
2401
|
+
FADE_TO_BOTTOM = "FADE_TO_BOTTOM"
|
|
2402
|
+
}
|
|
2403
|
+
/** @enumType */
|
|
2404
|
+
type LayerEffectWithLiterals = LayerEffect | 'CENTER' | 'FADE_TO_TOP' | 'FADE_TO_BOTTOM';
|
|
2405
|
+
/** Divider shape preset */
|
|
2406
|
+
declare enum Shape {
|
|
2407
|
+
/** Ellipse shape */
|
|
2408
|
+
ELLIPSE = "ELLIPSE",
|
|
2409
|
+
/** Tilt shape */
|
|
2410
|
+
TILT = "TILT",
|
|
2411
|
+
/** Liquid shape */
|
|
2412
|
+
LIQUID = "LIQUID",
|
|
2413
|
+
/** Left wave shape */
|
|
2414
|
+
LEFT_WAVE = "LEFT_WAVE",
|
|
2415
|
+
/** Paint scribble shape */
|
|
2416
|
+
PAINT_SCRIBBLE = "PAINT_SCRIBBLE",
|
|
2417
|
+
/** Inverted ellipse shape */
|
|
2418
|
+
INVERTED_ELLIPSE = "INVERTED_ELLIPSE",
|
|
2419
|
+
/** Right wave shape */
|
|
2420
|
+
RIGHT_WAVE = "RIGHT_WAVE",
|
|
2421
|
+
/** Dunes shape */
|
|
2422
|
+
DUNES = "DUNES",
|
|
2423
|
+
/** Waves shape */
|
|
2424
|
+
WAVES = "WAVES",
|
|
2425
|
+
/** Triangle shape */
|
|
2426
|
+
TRIANGLE = "TRIANGLE",
|
|
2427
|
+
/** Semi-ellipse shape */
|
|
2428
|
+
SEMI_ELLIPSE = "SEMI_ELLIPSE",
|
|
2429
|
+
/** Plants shape */
|
|
2430
|
+
PLANTS = "PLANTS",
|
|
2431
|
+
/** Layered ellipse shape */
|
|
2432
|
+
LAYERED_ELLIPSE = "LAYERED_ELLIPSE",
|
|
2433
|
+
/** Pixels shape */
|
|
2434
|
+
PIXELS = "PIXELS",
|
|
2435
|
+
/** Paint shape */
|
|
2436
|
+
PAINT = "PAINT",
|
|
2437
|
+
/** Clouds shape */
|
|
2438
|
+
CLOUDS = "CLOUDS",
|
|
2439
|
+
/** Optical illusion shape */
|
|
2440
|
+
OPTICAL_ILLUSION = "OPTICAL_ILLUSION",
|
|
2441
|
+
/** Stripes shape */
|
|
2442
|
+
STRIPES = "STRIPES",
|
|
2443
|
+
/** Blobs shape */
|
|
2444
|
+
BLOBS = "BLOBS",
|
|
2445
|
+
/** Semi-circles shape */
|
|
2446
|
+
SEMI_CIRCLES = "SEMI_CIRCLES",
|
|
2447
|
+
/** Hill shape */
|
|
2448
|
+
HILL = "HILL",
|
|
2449
|
+
/** Brush shape */
|
|
2450
|
+
BRUSH = "BRUSH",
|
|
2451
|
+
/** Peaks shape */
|
|
2452
|
+
PEAKS = "PEAKS",
|
|
2453
|
+
/** Angled triangle shape */
|
|
2454
|
+
ANGLED_TRIANGLE = "ANGLED_TRIANGLE"
|
|
2455
|
+
}
|
|
2456
|
+
/** @enumType */
|
|
2457
|
+
type ShapeWithLiterals = Shape | 'ELLIPSE' | 'TILT' | 'LIQUID' | 'LEFT_WAVE' | 'PAINT_SCRIBBLE' | 'INVERTED_ELLIPSE' | 'RIGHT_WAVE' | 'DUNES' | 'WAVES' | 'TRIANGLE' | 'SEMI_ELLIPSE' | 'PLANTS' | 'LAYERED_ELLIPSE' | 'PIXELS' | 'PAINT' | 'CLOUDS' | 'OPTICAL_ILLUSION' | 'STRIPES' | 'BLOBS' | 'SEMI_CIRCLES' | 'HILL' | 'BRUSH' | 'PEAKS' | 'ANGLED_TRIANGLE';
|
|
2458
|
+
/** Layers effect - stacked semi-transparent copies of the divider shape */
|
|
2459
|
+
interface Layers {
|
|
2460
|
+
/** Total number of layers including the base shape (1-4). Absent or 1 disables the effect. */
|
|
2461
|
+
count?: number | null;
|
|
2462
|
+
/** 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. */
|
|
2463
|
+
offsetY?: number | null;
|
|
2464
|
+
/** How the stacked layers fade relative to the base shape. */
|
|
2465
|
+
layerEffect?: LayerEffectWithLiterals;
|
|
2466
|
+
/** Horizontal distance between consecutive layers in pixels. Defaults to 0. Only applies to shapes that support horizontal offset. */
|
|
2467
|
+
offsetX?: number | null;
|
|
2468
|
+
}
|
|
2469
|
+
/** Backdrop type */
|
|
2470
|
+
declare enum BackdropType {
|
|
2471
|
+
/** Solid color backdrop */
|
|
2472
|
+
COLOR = "COLOR",
|
|
2473
|
+
/** Gradient backdrop */
|
|
2474
|
+
GRADIENT = "GRADIENT"
|
|
2475
|
+
}
|
|
2476
|
+
/** @enumType */
|
|
2477
|
+
type BackdropTypeWithLiterals = BackdropType | 'COLOR' | 'GRADIENT';
|
|
2478
|
+
interface LayoutDataBackgroundImage {
|
|
2479
|
+
/** Background image. */
|
|
2480
|
+
media?: V1Media;
|
|
2481
|
+
/**
|
|
2482
|
+
* Deprecated: use `overlay` instead. Legacy image opacity (0–100) that dimmed the image to reveal the `background`/`backdrop` color behind it.
|
|
2483
|
+
* @deprecated
|
|
2484
|
+
*/
|
|
2485
|
+
opacity?: number | null;
|
|
2486
|
+
/** Background image scaling. */
|
|
2487
|
+
scaling?: ImageScalingScalingWithLiterals;
|
|
2488
|
+
/** Position of background. Defaults to `CENTER`. */
|
|
2489
|
+
position?: ImagePositionWithLiterals;
|
|
2490
|
+
/** 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. */
|
|
2491
|
+
blur?: number | null;
|
|
2492
|
+
/** 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`). */
|
|
2493
|
+
overlay?: LayoutDataBackground;
|
|
2494
|
+
}
|
|
2495
|
+
declare enum VerticalAlignmentAlignment {
|
|
2496
|
+
/** Top alignment */
|
|
2497
|
+
TOP = "TOP",
|
|
2498
|
+
/** Middle alignment */
|
|
2499
|
+
MIDDLE = "MIDDLE",
|
|
2500
|
+
/** Bottom alignment */
|
|
2501
|
+
BOTTOM = "BOTTOM"
|
|
2502
|
+
}
|
|
2503
|
+
/** @enumType */
|
|
2504
|
+
type VerticalAlignmentAlignmentWithLiterals = VerticalAlignmentAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2505
|
+
declare enum ResponsivenessBehaviour {
|
|
2506
|
+
/** Stacking of columns */
|
|
2507
|
+
STACK = "STACK",
|
|
2508
|
+
/** Wrapping of columns */
|
|
2509
|
+
WRAP = "WRAP"
|
|
2510
|
+
}
|
|
2511
|
+
/** @enumType */
|
|
2512
|
+
type ResponsivenessBehaviourWithLiterals = ResponsivenessBehaviour | 'STACK' | 'WRAP';
|
|
2513
|
+
declare enum DesignTarget {
|
|
2514
|
+
/** Design applied to layout */
|
|
2515
|
+
LAYOUT = "LAYOUT",
|
|
2516
|
+
/** Design applied to cells */
|
|
2517
|
+
CELL = "CELL"
|
|
2518
|
+
}
|
|
2519
|
+
/** @enumType */
|
|
2520
|
+
type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
|
|
2521
|
+
interface Banner extends BannerOriginPresenceOneOf {
|
|
2522
|
+
/** Origin of the banner. Edge positions only. */
|
|
2523
|
+
origin?: OriginWithLiterals;
|
|
2524
|
+
/** Where the layout sits: an edge, or the paywall cut. */
|
|
2525
|
+
position?: BannerPositionWithLiterals;
|
|
2526
|
+
}
|
|
2527
|
+
/** @oneof */
|
|
2528
|
+
interface BannerOriginPresenceOneOf {
|
|
2529
|
+
/** Origin of the banner. Edge positions only. */
|
|
2530
|
+
origin?: OriginWithLiterals;
|
|
2531
|
+
}
|
|
2532
|
+
/** Backdrop styling (color or gradient) */
|
|
2533
|
+
interface Backdrop {
|
|
2534
|
+
/** Backdrop type. */
|
|
2535
|
+
type?: BackdropTypeWithLiterals;
|
|
2536
|
+
/**
|
|
2537
|
+
* Backdrop color as a hexadecimal value.
|
|
2538
|
+
* @maxLength 19
|
|
2539
|
+
*/
|
|
2540
|
+
color?: string | null;
|
|
2541
|
+
/** Gradient configuration. */
|
|
2542
|
+
gradient?: Gradient;
|
|
2543
|
+
}
|
|
2544
|
+
/** Decorative shape divider at a layout edge */
|
|
2545
|
+
interface SectionDivider {
|
|
2546
|
+
/** Divider shape preset. Determines which customization properties apply. */
|
|
2547
|
+
type?: ShapeWithLiterals;
|
|
2548
|
+
/**
|
|
2549
|
+
* Divider fill color as a hexadecimal value (may include alpha).
|
|
2550
|
+
* @maxLength 19
|
|
2551
|
+
*/
|
|
2552
|
+
color?: string | null;
|
|
2553
|
+
/** Divider height in pixels. */
|
|
2554
|
+
height?: number | null;
|
|
2555
|
+
/** Horizontal offset in pixels. */
|
|
2556
|
+
offsetX?: number | null;
|
|
2557
|
+
/** Whether the shape is flipped horizontally. */
|
|
2558
|
+
flipped?: boolean | null;
|
|
2559
|
+
/** Layers effect - stacked semi-transparent copies of the divider shape. */
|
|
2560
|
+
layers?: Layers;
|
|
2561
|
+
}
|
|
2562
|
+
interface LayoutCellData {
|
|
2563
|
+
/** Size of the cell in 12 columns grid. */
|
|
2564
|
+
colSpan?: number | null;
|
|
2565
|
+
}
|
|
2566
|
+
interface ShapeData {
|
|
2567
|
+
/** Styling for the shape's container. */
|
|
2568
|
+
containerData?: PluginContainerData;
|
|
2569
|
+
/** Shape file details. */
|
|
2570
|
+
shape?: V1Media;
|
|
2571
|
+
/** Styling for the shape. */
|
|
2572
|
+
styles?: ShapeDataStyles;
|
|
2573
|
+
/** Node animation. */
|
|
2574
|
+
animation?: Animation;
|
|
2575
|
+
/** Link details for shapes that are links. */
|
|
2576
|
+
link?: Link$1;
|
|
2577
|
+
/**
|
|
2578
|
+
* Alternate text describing the link's purpose for accessibility. Applies only when `link` is set.
|
|
2579
|
+
* @maxLength 1000
|
|
2580
|
+
*/
|
|
2581
|
+
altText?: string | null;
|
|
2582
|
+
}
|
|
2583
|
+
interface ShapeDataStyles {
|
|
2584
|
+
/**
|
|
2585
|
+
* Shape fill color as a hexadecimal value.
|
|
2586
|
+
* @maxLength 19
|
|
2587
|
+
*/
|
|
2588
|
+
color?: string | null;
|
|
2589
|
+
/** Map of original color keys to their new color values. */
|
|
2590
|
+
colors?: Record<string, string>;
|
|
2591
|
+
}
|
|
2592
|
+
interface CardData {
|
|
2593
|
+
/** Background styling (color or gradient). */
|
|
2594
|
+
background?: CardDataBackground;
|
|
2595
|
+
/** Background image. */
|
|
2596
|
+
backgroundImage?: BackgroundImage;
|
|
2597
|
+
}
|
|
2598
|
+
declare enum Scaling {
|
|
2599
|
+
/** Auto image scaling */
|
|
2600
|
+
AUTO = "AUTO",
|
|
2601
|
+
/** Contain image scaling */
|
|
2602
|
+
CONTAIN = "CONTAIN",
|
|
2603
|
+
/** Cover image scaling */
|
|
2604
|
+
COVER = "COVER"
|
|
2605
|
+
}
|
|
2606
|
+
/** @enumType */
|
|
2607
|
+
type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
|
|
2608
|
+
declare enum ImagePositionPosition {
|
|
2609
|
+
/** Image positioned at the center */
|
|
2610
|
+
CENTER = "CENTER",
|
|
2611
|
+
/** Image positioned on the left */
|
|
2612
|
+
CENTER_LEFT = "CENTER_LEFT",
|
|
2613
|
+
/** Image positioned on the right */
|
|
2614
|
+
CENTER_RIGHT = "CENTER_RIGHT",
|
|
2615
|
+
/** Image positioned at the center top */
|
|
2616
|
+
TOP = "TOP",
|
|
2617
|
+
/** Image positioned at the top left */
|
|
2618
|
+
TOP_LEFT = "TOP_LEFT",
|
|
2619
|
+
/** Image positioned at the top right */
|
|
2620
|
+
TOP_RIGHT = "TOP_RIGHT",
|
|
2621
|
+
/** Image positioned at the center bottom */
|
|
2622
|
+
BOTTOM = "BOTTOM",
|
|
2623
|
+
/** Image positioned at the bottom left */
|
|
2624
|
+
BOTTOM_LEFT = "BOTTOM_LEFT",
|
|
2625
|
+
/** Image positioned at the bottom right */
|
|
2626
|
+
BOTTOM_RIGHT = "BOTTOM_RIGHT"
|
|
2627
|
+
}
|
|
2628
|
+
/** @enumType */
|
|
2629
|
+
type ImagePositionPositionWithLiterals = ImagePositionPosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
|
|
2630
|
+
/** Background styling (color or gradient) */
|
|
2631
|
+
interface CardDataBackground {
|
|
2632
|
+
/** Background type. */
|
|
2633
|
+
type?: CardDataBackgroundTypeWithLiterals;
|
|
2634
|
+
/**
|
|
2635
|
+
* Background color as a hexadecimal value.
|
|
2636
|
+
* @maxLength 19
|
|
2637
|
+
*/
|
|
2638
|
+
color?: string | null;
|
|
2639
|
+
/** Gradient configuration. */
|
|
2640
|
+
gradient?: Gradient;
|
|
2641
|
+
}
|
|
2642
|
+
/** Background type */
|
|
2643
|
+
declare enum CardDataBackgroundType {
|
|
2644
|
+
/** Solid color background */
|
|
2645
|
+
COLOR = "COLOR",
|
|
2646
|
+
/** Gradient background */
|
|
2647
|
+
GRADIENT = "GRADIENT"
|
|
2648
|
+
}
|
|
2649
|
+
/** @enumType */
|
|
2650
|
+
type CardDataBackgroundTypeWithLiterals = CardDataBackgroundType | 'COLOR' | 'GRADIENT';
|
|
2651
|
+
interface BackgroundImage {
|
|
2652
|
+
/** Background image. */
|
|
2653
|
+
media?: V1Media;
|
|
2654
|
+
/**
|
|
2655
|
+
* Deprecated: use `overlay` instead. Legacy image opacity (0–100) that dimmed the image to reveal the `background` color behind it.
|
|
2656
|
+
* @deprecated
|
|
2657
|
+
*/
|
|
2658
|
+
opacity?: number | null;
|
|
2659
|
+
/** Background image scaling. */
|
|
2660
|
+
scaling?: ScalingWithLiterals;
|
|
2661
|
+
/** Position of background. Defaults to `CENTER`. */
|
|
2662
|
+
position?: ImagePositionPositionWithLiterals;
|
|
2663
|
+
/** 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`). */
|
|
2664
|
+
overlay?: CardDataBackground;
|
|
2665
|
+
/** 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. */
|
|
2666
|
+
blur?: number | null;
|
|
2667
|
+
}
|
|
2668
|
+
interface TocData {
|
|
2669
|
+
/** Heading levels included in the table of contents. Default: [1, 2, 3, 4, 5, 6]. */
|
|
2670
|
+
includedHeadings?: number[];
|
|
2671
|
+
/** List style. Default: PLAIN. */
|
|
2672
|
+
listStyle?: ListStyleWithLiterals;
|
|
2673
|
+
/** Optional override for the font size in pixels. */
|
|
2674
|
+
fontSize?: number | null;
|
|
2675
|
+
/** Optional override for the vertical spacing between items in pixels. */
|
|
2676
|
+
itemSpacing?: number | null;
|
|
2677
|
+
/**
|
|
2678
|
+
* Optional override for the text color.
|
|
2679
|
+
* @maxLength 19
|
|
2680
|
+
*/
|
|
2681
|
+
color?: string | null;
|
|
2682
|
+
/** Indentation style. Default: NESTED. */
|
|
2683
|
+
indentation?: IndentationWithLiterals;
|
|
2684
|
+
/** Node animation. */
|
|
2685
|
+
animation?: Animation;
|
|
2686
|
+
}
|
|
2687
|
+
/** List style. */
|
|
2688
|
+
declare enum ListStyle {
|
|
2689
|
+
/** No markers (default) */
|
|
2690
|
+
PLAIN = "PLAIN",
|
|
2691
|
+
/** Numbered list */
|
|
2692
|
+
NUMBERED = "NUMBERED",
|
|
2693
|
+
/** Alphabetic letters */
|
|
2694
|
+
LETTERS = "LETTERS",
|
|
2695
|
+
/** Roman numerals */
|
|
2696
|
+
ROMAN = "ROMAN",
|
|
2697
|
+
/** Bulleted list */
|
|
2698
|
+
BULLETED = "BULLETED",
|
|
2699
|
+
/** Alphabetical index */
|
|
2700
|
+
ALPHABETICAL_INDEX = "ALPHABETICAL_INDEX",
|
|
2701
|
+
/** Alphabetical index (compact top-row only) */
|
|
2702
|
+
ALPHABETICAL_INDEX_COMPACT = "ALPHABETICAL_INDEX_COMPACT"
|
|
2703
|
+
}
|
|
2704
|
+
/** @enumType */
|
|
2705
|
+
type ListStyleWithLiterals = ListStyle | 'PLAIN' | 'NUMBERED' | 'LETTERS' | 'ROMAN' | 'BULLETED' | 'ALPHABETICAL_INDEX' | 'ALPHABETICAL_INDEX_COMPACT';
|
|
2706
|
+
/** Indentation style. */
|
|
2707
|
+
declare enum Indentation {
|
|
2708
|
+
/** Sub-headings indented under parents (default) */
|
|
2709
|
+
NESTED = "NESTED",
|
|
2710
|
+
/** All items at the same level */
|
|
2711
|
+
FLAT = "FLAT"
|
|
2712
|
+
}
|
|
2713
|
+
/** @enumType */
|
|
2714
|
+
type IndentationWithLiterals = Indentation | 'NESTED' | 'FLAT';
|
|
2715
|
+
/** Data for a smart block node. */
|
|
2716
|
+
interface SmartBlockData {
|
|
2717
|
+
/** The type of the smart block. */
|
|
2718
|
+
type?: SmartBlockDataTypeWithLiterals;
|
|
2719
|
+
/** Layout orientation. HORIZONTAL or VERTICAL. Optional for variants with fixed orientation. */
|
|
2720
|
+
orientation?: string | null;
|
|
2721
|
+
/** Column size controlling cells per row. */
|
|
2722
|
+
columnSize?: ColumnSizeWithLiterals;
|
|
2723
|
+
/**
|
|
2724
|
+
* Border color (for SOLID_JOINED_BOXES variant).
|
|
2725
|
+
* @maxLength 19
|
|
2726
|
+
*/
|
|
2727
|
+
borderColor?: string | null;
|
|
2728
|
+
/** Border width in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2729
|
+
borderWidth?: number | null;
|
|
2730
|
+
/** Border radius in pixels (for SOLID_JOINED_BOXES variant). */
|
|
2731
|
+
borderRadius?: number | null;
|
|
2732
|
+
/** Node animation. */
|
|
2733
|
+
animation?: Animation;
|
|
2734
|
+
}
|
|
2735
|
+
/** Layout type of the smart block */
|
|
2736
|
+
declare enum SmartBlockDataType {
|
|
2737
|
+
/** Grid-based layouts with solid box items containing title, body, and icon/image. */
|
|
2738
|
+
SOLID_BOXES = "SOLID_BOXES",
|
|
2739
|
+
/** Numbered boxes. */
|
|
2740
|
+
NUMBERED_BOXES = "NUMBERED_BOXES",
|
|
2741
|
+
/** Statistics display with large numbers/values. */
|
|
2742
|
+
STATS = "STATS",
|
|
2743
|
+
/** Statistics with circular visual elements. */
|
|
2744
|
+
CIRCLE_STATS = "CIRCLE_STATS",
|
|
2745
|
+
/** Staggered/zigzag grid layout with alternating box positions. */
|
|
2746
|
+
SOLID_BOXES_ALTERNATING = "SOLID_BOXES_ALTERNATING",
|
|
2747
|
+
/** Grid layout with boxes visually joined (no gaps, shared container border). */
|
|
2748
|
+
SOLID_JOINED_BOXES = "SOLID_JOINED_BOXES",
|
|
2749
|
+
/** Transparent cells with only a left side line. */
|
|
2750
|
+
SIDE_LINE_TEXT = "SIDE_LINE_TEXT",
|
|
2751
|
+
/** Transparent cells with only a top line. */
|
|
2752
|
+
TOP_LINE_TEXT = "TOP_LINE_TEXT",
|
|
2753
|
+
/** Outlined boxes with a numbered/icon circle at the top. */
|
|
2754
|
+
OUTLINE_BOXES_WITH_TOP_CIRCLE = "OUTLINE_BOXES_WITH_TOP_CIRCLE",
|
|
2755
|
+
/** Large icon bullets with text content. */
|
|
2756
|
+
BIG_BULLETS = "BIG_BULLETS",
|
|
2757
|
+
/** Small dot bullets with text content. */
|
|
2758
|
+
SMALL_BULLETS = "SMALL_BULLETS",
|
|
2759
|
+
/** Arrow icon bullets with text content. */
|
|
2760
|
+
ARROW_BULLETS = "ARROW_BULLETS",
|
|
2761
|
+
/** Process steps with numbered/icon labels above a horizontal line. */
|
|
2762
|
+
PROCESS_STEPS = "PROCESS_STEPS",
|
|
2763
|
+
/** Statistics with bar visual elements. */
|
|
2764
|
+
BAR_STATS = "BAR_STATS",
|
|
2765
|
+
/** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
|
|
2766
|
+
TIMELINE = "TIMELINE",
|
|
2767
|
+
/** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
|
|
2768
|
+
MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
|
|
2769
|
+
/** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
|
|
2770
|
+
PILLS = "PILLS",
|
|
2771
|
+
/** Star rating display with stars and a numeric value per cell. */
|
|
2772
|
+
STAR_RATING = "STAR_RATING",
|
|
2773
|
+
/** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
|
|
2774
|
+
QUOTE_BOXES = "QUOTE_BOXES",
|
|
2775
|
+
/** Donut/ring with numbered annular-sector segments; cell text labels sit outside the ring. */
|
|
2776
|
+
CIRCLE = "CIRCLE",
|
|
2777
|
+
/** Hierarchical pyramid where each cell renders as a horizontal slice (apex at top, base at bottom) with the cell number or shape centered inside; text content sits beside (desktop) or below (mobile) the pyramid. */
|
|
2778
|
+
PYRAMID = "PYRAMID",
|
|
2779
|
+
/** Cells render a horizontal bar whose width scales with cell index, creating a staircase pattern; bar carries the cell number or a custom shape. */
|
|
2780
|
+
STAIRCASE = "STAIRCASE",
|
|
2781
|
+
/** Hierarchical funnel where each cell renders as a horizontal slice (wide at top, narrowing toward the bottom) with the cell number or shape centered inside; text content sits beside (desktop) or below (mobile) the funnel. */
|
|
2782
|
+
VERTICAL_FUNNEL = "VERTICAL_FUNNEL"
|
|
2783
|
+
}
|
|
2784
|
+
/** @enumType */
|
|
2785
|
+
type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS' | 'TIMELINE' | 'MINIMAL_TIMELINE' | 'PILLS' | 'STAR_RATING' | 'QUOTE_BOXES' | 'CIRCLE' | 'PYRAMID' | 'STAIRCASE' | 'VERTICAL_FUNNEL';
|
|
2786
|
+
/** Column size controlling how many cells appear per row. */
|
|
2787
|
+
declare enum ColumnSize {
|
|
2788
|
+
/** Up to 4 cells in a row. */
|
|
2789
|
+
SMALL = "SMALL",
|
|
2790
|
+
/** Up to 3 cells in a row (default). */
|
|
2791
|
+
MEDIUM = "MEDIUM",
|
|
2792
|
+
/** Up to 2 cells in a row. */
|
|
2793
|
+
LARGE = "LARGE",
|
|
2794
|
+
/** 1 cell in a row. */
|
|
2795
|
+
EXTRA_LARGE = "EXTRA_LARGE"
|
|
2796
|
+
}
|
|
2797
|
+
/** @enumType */
|
|
2798
|
+
type ColumnSizeWithLiterals = ColumnSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
|
|
2799
|
+
/** Data for a smart block cell node. */
|
|
2800
|
+
interface SmartBlockCellData {
|
|
2801
|
+
/** Optional label text for the cell (e.g., for stats variants). */
|
|
2802
|
+
label?: string | null;
|
|
2803
|
+
/** Shape file details. */
|
|
2804
|
+
shape?: V1Media;
|
|
2805
|
+
/**
|
|
2806
|
+
* Border color of the cell.
|
|
2807
|
+
* @maxLength 19
|
|
2808
|
+
*/
|
|
2809
|
+
borderColor?: string | null;
|
|
2810
|
+
/** Border width in pixels. */
|
|
2811
|
+
borderWidth?: number | null;
|
|
2812
|
+
/** Border radius in pixels. */
|
|
2813
|
+
borderRadius?: number | null;
|
|
2814
|
+
/** The type of the parent smart block (must match parent). */
|
|
2815
|
+
type?: SmartBlockDataTypeWithLiterals;
|
|
2816
|
+
/**
|
|
2817
|
+
* Accent color for non-background variants (e.g., line, bullet, label color).
|
|
2818
|
+
* @maxLength 19
|
|
2819
|
+
*/
|
|
2820
|
+
accentColor?: string | null;
|
|
2821
|
+
/**
|
|
2822
|
+
* Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
|
|
2823
|
+
* @maxLength 19
|
|
2824
|
+
*/
|
|
2825
|
+
backgroundColor?: string | null;
|
|
2826
|
+
/**
|
|
2827
|
+
* Shape fill color as a hexadecimal value.
|
|
2828
|
+
* @maxLength 19
|
|
2829
|
+
*/
|
|
2830
|
+
shapeColor?: string | null;
|
|
2831
|
+
}
|
|
2832
|
+
interface CheckboxListData {
|
|
2833
|
+
/** Indentation level from 0-4. */
|
|
2834
|
+
indentation?: number;
|
|
2835
|
+
/** Offset level from 0-4. */
|
|
2836
|
+
offset?: number | null;
|
|
2837
|
+
/** Node animation. */
|
|
2838
|
+
animation?: Animation;
|
|
2839
|
+
}
|
|
2840
|
+
interface ListItemNodeData {
|
|
2841
|
+
/** Checkbox list item state. Defaults to `false`. */
|
|
2842
|
+
checked?: boolean | null;
|
|
2843
|
+
/** Node animation. */
|
|
2844
|
+
animation?: Animation;
|
|
2845
|
+
}
|
|
2846
|
+
interface SlotData {
|
|
2847
|
+
/** Integration type, for example `wix.forms.form`. Used to render the slot in the editor and viewer. */
|
|
2848
|
+
integrationType?: string | null;
|
|
2849
|
+
/** ID of the resource the slot renders, for example a form ID. Passed as-is to the integration. */
|
|
2850
|
+
resourceId?: string | null;
|
|
2851
|
+
/** Node animation. */
|
|
2852
|
+
animation?: Animation;
|
|
2853
|
+
/** Design overrides for this slot. Unset colours use the Ricos theme; unset sizes default to 0. */
|
|
2854
|
+
design?: SlotDesign;
|
|
2855
|
+
}
|
|
2856
|
+
interface SlotDesign {
|
|
2857
|
+
/** Text colour: CSS colour or `$theme-color-N[-opacity]` token. */
|
|
2858
|
+
textColor?: string | null;
|
|
2859
|
+
/** Accent colour. */
|
|
2860
|
+
accentColor?: string | null;
|
|
2861
|
+
/** Button background colour. */
|
|
2862
|
+
buttonColor?: string | null;
|
|
2863
|
+
/** Button text colour. */
|
|
2864
|
+
buttonTextColor?: string | null;
|
|
2865
|
+
/** Block background colour. */
|
|
2866
|
+
backgroundColor?: string | null;
|
|
2867
|
+
/** Block border colour. */
|
|
2868
|
+
borderColor?: string | null;
|
|
2869
|
+
/** Block border width, px. */
|
|
2870
|
+
borderWidth?: number | null;
|
|
2871
|
+
/** Block corner radius, px. */
|
|
2872
|
+
borderRadius?: number | null;
|
|
2873
|
+
/** Horizontal inner padding, px. */
|
|
2874
|
+
paddingHorizontal?: number | null;
|
|
2875
|
+
/** Vertical inner padding, px. */
|
|
2876
|
+
paddingVertical?: number | null;
|
|
2877
|
+
/** Vertical gap between rows, px. */
|
|
2878
|
+
rowGap?: number | null;
|
|
2879
|
+
/** Horizontal gap between columns, px. */
|
|
2880
|
+
columnGap?: number | null;
|
|
2881
|
+
}
|
|
2882
|
+
interface Metadata {
|
|
2883
|
+
/** Schema version. */
|
|
2884
|
+
version?: number;
|
|
2885
|
+
/**
|
|
2886
|
+
* When the object was created.
|
|
2887
|
+
* @readonly
|
|
2888
|
+
* @deprecated
|
|
2889
|
+
*/
|
|
2890
|
+
createdTimestamp?: Date | null;
|
|
2891
|
+
/**
|
|
2892
|
+
* When the object was most recently updated.
|
|
2893
|
+
* @deprecated
|
|
2894
|
+
*/
|
|
2895
|
+
updatedTimestamp?: Date | null;
|
|
2896
|
+
/** Object ID. */
|
|
2897
|
+
_id?: string | null;
|
|
2898
|
+
}
|
|
2899
|
+
interface DocumentStyle {
|
|
2900
|
+
/** Styling for H1 nodes. */
|
|
2901
|
+
headerOne?: TextNodeStyle;
|
|
2902
|
+
/** Styling for H2 nodes. */
|
|
2903
|
+
headerTwo?: TextNodeStyle;
|
|
2904
|
+
/** Styling for H3 nodes. */
|
|
2905
|
+
headerThree?: TextNodeStyle;
|
|
2906
|
+
/** Styling for H4 nodes. */
|
|
2907
|
+
headerFour?: TextNodeStyle;
|
|
2908
|
+
/** Styling for H5 nodes. */
|
|
2909
|
+
headerFive?: TextNodeStyle;
|
|
2910
|
+
/** Styling for H6 nodes. */
|
|
2911
|
+
headerSix?: TextNodeStyle;
|
|
2912
|
+
/** Styling for paragraph nodes. */
|
|
2913
|
+
paragraph?: TextNodeStyle;
|
|
2914
|
+
/** Styling for block quote nodes. */
|
|
2915
|
+
blockquote?: TextNodeStyle;
|
|
2916
|
+
/** Styling for code block nodes. */
|
|
2917
|
+
codeBlock?: TextNodeStyle;
|
|
2918
|
+
}
|
|
2919
|
+
interface TextNodeStyle {
|
|
2920
|
+
/** The decorations to apply to the node. */
|
|
2921
|
+
decorations?: Decoration[];
|
|
2922
|
+
/** Padding and background color for the node. */
|
|
2923
|
+
nodeStyle?: NodeStyle;
|
|
2924
|
+
/** Line height for text in the node. */
|
|
2925
|
+
lineHeight?: string | null;
|
|
2926
|
+
}
|
|
2927
|
+
//#endregion
|
|
2928
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/links.d.ts
|
|
2929
|
+
type LinkTarget = '_self' | '_blank';
|
|
2930
|
+
/**
|
|
2931
|
+
* A link to a URL, used for navigation within components.
|
|
2932
|
+
*
|
|
2933
|
+
* @example
|
|
2934
|
+
* ```tsx
|
|
2935
|
+
* import type { Link } from '@wix/editor-react-types';
|
|
2936
|
+
*
|
|
2937
|
+
* interface MyComponentProps {
|
|
2938
|
+
* link?: Link;
|
|
2939
|
+
* }
|
|
2940
|
+
* ```
|
|
2941
|
+
*/
|
|
2942
|
+
type Link = {
|
|
2943
|
+
/**
|
|
2944
|
+
* The link URL. For partial links (see `pageRole`), this is the router prefix
|
|
2945
|
+
* (e.g. `https://www.my-site.com/prefix`) rather than a fully resolved URL.
|
|
2946
|
+
*/
|
|
2947
|
+
href?: string;
|
|
2948
|
+
/**
|
|
2949
|
+
* Where this link should open.
|
|
2950
|
+
* - `'_self'` — opens in the same page.
|
|
2951
|
+
* - `'_blank'` — opens in a new tab.
|
|
2952
|
+
*/
|
|
2953
|
+
target?: LinkTarget; /** The `rel` attribute of the link. Accepts LinkRel values separated by a space. */
|
|
2954
|
+
rel?: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* Page role identifier. Present only on partial links, where only the router prefix is
|
|
2957
|
+
* known and the full URL format is owned by the Router/App. Applications can use such
|
|
2958
|
+
* links in functions to resolve the complete URL at runtime (e.g. for binding links).
|
|
2959
|
+
* Resolved links will not have this field.
|
|
2960
|
+
*/
|
|
2961
|
+
pageRole?: string;
|
|
2962
|
+
};
|
|
2963
|
+
//#endregion
|
|
2964
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/image.d.ts
|
|
2965
|
+
type Point = {
|
|
2966
|
+
x: number;
|
|
2967
|
+
y: number;
|
|
2968
|
+
};
|
|
2969
|
+
type Crop = Point & {
|
|
2970
|
+
width: number;
|
|
2971
|
+
height: number;
|
|
2972
|
+
};
|
|
2973
|
+
/**
|
|
2974
|
+
* An image from Wix Media.
|
|
2975
|
+
*
|
|
2976
|
+
* @example
|
|
2977
|
+
* ```tsx
|
|
2978
|
+
* import type { Image } from '@wix/editor-react-types';
|
|
2979
|
+
*
|
|
2980
|
+
* interface MyComponentProps {
|
|
2981
|
+
* image?: Image;
|
|
2982
|
+
* }
|
|
2983
|
+
*
|
|
2984
|
+
* const MyComponent = ({ image }: MyComponentProps) => (
|
|
2985
|
+
* <img src={image?.url} alt={image?.alt} />
|
|
2986
|
+
* );
|
|
2987
|
+
* ```
|
|
2988
|
+
*/
|
|
2989
|
+
type Image = {
|
|
2990
|
+
/** The image URI. */uri?: string; /** The image URL. */
|
|
2991
|
+
url: string; /** The image file name. */
|
|
2992
|
+
name?: string; /** The image height in pixels. */
|
|
2993
|
+
height?: number; /** The image width in pixels. */
|
|
2994
|
+
width?: number; /** Whether the image is animated (e.g. GIF). */
|
|
2995
|
+
animated?: boolean; /** The crop region applied to the image. */
|
|
2996
|
+
crop?: Crop; /** The image quality, as a percentage from 0 to 100. */
|
|
2997
|
+
quality?: number; /** The image alt text for accessibility. */
|
|
2998
|
+
alt?: string;
|
|
2999
|
+
};
|
|
3000
|
+
//#endregion
|
|
3001
|
+
//#region ../../node_modules/@wix/editor-react-types/dist/base.d.ts
|
|
3002
|
+
/**
|
|
3003
|
+
* Rich text content with resolved links.
|
|
3004
|
+
*
|
|
3005
|
+
* @example
|
|
3006
|
+
* ```tsx
|
|
3007
|
+
* import type { RichText } from '@wix/editor-react-types';
|
|
3008
|
+
*
|
|
3009
|
+
* interface MyComponentProps {
|
|
3010
|
+
* description?: RichText;
|
|
3011
|
+
* }
|
|
3012
|
+
*
|
|
3013
|
+
* const MyComponent = ({ description }: MyComponentProps) => (
|
|
3014
|
+
* <div>
|
|
3015
|
+
* {description?.html}
|
|
3016
|
+
* {description?.linkList.map((link) => (
|
|
3017
|
+
* <a key={link.href} href={link.href}>{link.href}</a>
|
|
3018
|
+
* ))}
|
|
3019
|
+
* </div>
|
|
3020
|
+
* );
|
|
3021
|
+
* ```
|
|
3022
|
+
*/
|
|
3023
|
+
type RichText = {
|
|
3024
|
+
/** The original rich text content. */text: string; /** The HTML content with all links resolved. */
|
|
3025
|
+
html: string; /** All links present in the rich text content. */
|
|
3026
|
+
linkList: Array<Link>;
|
|
3027
|
+
};
|
|
3028
|
+
//#endregion
|
|
3029
|
+
//#region src/lib/blog-api.d.ts
|
|
3030
|
+
/** The fields the related-posts branch decision needs from the current post. */
|
|
3031
|
+
interface RelatedPostsSource {
|
|
3032
|
+
currentPostId: string | undefined;
|
|
3033
|
+
categoryIds: string[] | undefined;
|
|
3034
|
+
/** Writer-curated related posts (max 3, ordered as set in the Blog dashboard). */
|
|
3035
|
+
relatedPostIds: string[] | undefined;
|
|
3036
|
+
}
|
|
3037
|
+
//#endregion
|
|
3038
|
+
//#region src/extensions/post-context-provider/utils.d.ts
|
|
3039
|
+
/**
|
|
3040
|
+
* One item of the `postCategories` array — the object the platform hands the Category Item
|
|
3041
|
+
* context provider as its `categoryData` prop (via the manifest's `contextImplementor`).
|
|
3042
|
+
*
|
|
3043
|
+
* `_id`/`label` are the manifest contract (`CATEGORY_ITEM_CONTRACT_ITEMS`, plain text and
|
|
3044
|
+
* non-bindable); the remaining keys must match the Category Item context manifest's
|
|
3045
|
+
* `context.items` keys, because the runtime resolves an element's binding by looking the
|
|
3046
|
+
* key up on that provider's hook return value.
|
|
3047
|
+
*/
|
|
3048
|
+
interface PostCategoryItem {
|
|
3049
|
+
/** Repeater item identity; also the manifest contract's `_id`. */
|
|
3050
|
+
_id: string;
|
|
3051
|
+
/** The manifest contract's `label` (plain text, non-bindable — see the richText label below). */
|
|
3052
|
+
label: string;
|
|
3053
|
+
itemCategoryLabel: RichText;
|
|
3054
|
+
/** The category's feed view; `undefined` (unlinked) without a resolvable base or slug. */
|
|
3055
|
+
itemCategoryLink: Link | undefined;
|
|
3056
|
+
/** Mirrors the Category Item manifest's nested (non-bindable) `categoryItem` data item. */
|
|
3057
|
+
categoryItem: {
|
|
3058
|
+
label: string;
|
|
3059
|
+
slug: string;
|
|
3060
|
+
};
|
|
3061
|
+
}
|
|
3062
|
+
/**
|
|
3063
|
+
* One item of the `postTags` array — the object the platform hands the Tag Item context
|
|
3064
|
+
* provider as its `tagData` prop. The `PostCategoryItem` twin, same contract rules:
|
|
3065
|
+
* `_id`/`label` are the manifest contract (`TAG_ITEM_CONTRACT_ITEMS`, plain text and
|
|
3066
|
+
* non-bindable), the remaining keys must match the Tag Item context manifest's `context.items`.
|
|
3067
|
+
*/
|
|
3068
|
+
interface PostTagItem {
|
|
3069
|
+
/** Repeater item identity; also the manifest contract's `_id`. */
|
|
3070
|
+
_id: string;
|
|
3071
|
+
/** The manifest contract's `label` (plain text, non-bindable — see the richText label below). */
|
|
3072
|
+
label: string;
|
|
3073
|
+
itemTagLabel: RichText;
|
|
3074
|
+
/** The tag's feed view; `undefined` (unlinked) without a resolvable base or slug. */
|
|
3075
|
+
itemTagLink: Link | undefined;
|
|
3076
|
+
/** Mirrors the Tag Item manifest's nested (non-bindable) `tagItem` data item. */
|
|
3077
|
+
tagItem: {
|
|
3078
|
+
label: string;
|
|
3079
|
+
slug: string;
|
|
3080
|
+
};
|
|
3081
|
+
}
|
|
3082
|
+
/** Keys must match the manifest's `context.items` keys. */
|
|
3083
|
+
interface PostDerivedData {
|
|
3084
|
+
title: RichText;
|
|
3085
|
+
excerpt: RichText;
|
|
3086
|
+
coverImage: Image | undefined;
|
|
3087
|
+
/**
|
|
3088
|
+
* The Ricos document straight off the post — `@wix/editor-react-types` has no matching type
|
|
3089
|
+
* for the manifest's `ricosDocument` dataType, so the SDK's own is the accurate one.
|
|
3090
|
+
*/
|
|
3091
|
+
richContent: RichContent;
|
|
3092
|
+
authorName: RichText;
|
|
3093
|
+
authorImage: Image | undefined;
|
|
3094
|
+
timeToRead: RichText;
|
|
3095
|
+
publishedDate: RichText;
|
|
3096
|
+
viewCount: RichText;
|
|
3097
|
+
commentCount: RichText;
|
|
3098
|
+
likeCount: RichText;
|
|
3099
|
+
postCategories: PostCategoryItem[];
|
|
3100
|
+
postTags: PostTagItem[];
|
|
3101
|
+
/**
|
|
3102
|
+
* Visibility conditions (bookings' `hasCoverImage`, lite-events' `hasImage`): an element can
|
|
3103
|
+
* collapse when the post has nothing for it. Off the real post wherever there is one — the
|
|
3104
|
+
* editor canvas included, so the stage previews what the live page will hide — and `true`
|
|
3105
|
+
* on a post-less canvas, whose stand-ins should stay visible.
|
|
3106
|
+
*/
|
|
3107
|
+
hasCoverImage: boolean;
|
|
3108
|
+
hasExcerpt: boolean;
|
|
3109
|
+
hasTags: boolean;
|
|
3110
|
+
/**
|
|
3111
|
+
* Raw values for the compact widgets (Metadata, Counters), which format for themselves.
|
|
3112
|
+
* On the context VALUE only — never bindable items (the same line `isLiked`/`toggleLike`
|
|
3113
|
+
* draw). `undefined` means "nothing to show": a widget renders no piece, never a 0.
|
|
3114
|
+
*/
|
|
3115
|
+
/** ISO 8601 `firstPublishedDate`. */
|
|
3116
|
+
publishedDateValue: string | undefined;
|
|
3117
|
+
/** Positive estimate only — the API's 0 is an artifact (see `timeToRead`). */
|
|
3118
|
+
minutesToReadValue: number | undefined;
|
|
3119
|
+
/** Off the GetPostMetrics read; the provider overrides with the fresher client read. */
|
|
3120
|
+
viewCountValue: number | undefined;
|
|
3121
|
+
commentCountValue: number | undefined;
|
|
3122
|
+
}
|
|
3123
|
+
//#endregion
|
|
3124
|
+
//#region src/extensions/post-context-provider/post-context-provider.d.ts
|
|
3125
|
+
/** Fields and like state of the current blog post, as read through {@link usePostContext}. */
|
|
3126
|
+
type PostContextType = PostDerivedData & {
|
|
3127
|
+
isLiked: boolean;
|
|
3128
|
+
/**
|
|
3129
|
+
* Server count adjusted by the viewer's optimistic toggle (see usePostLikes). A raw number
|
|
3130
|
+
* for widgets; the bindable "Like Count" label is the richText `likeCount` item.
|
|
3131
|
+
*/
|
|
3132
|
+
likeCountValue: number;
|
|
3133
|
+
/**
|
|
3134
|
+
* False while the fresh like-count read is pending (always false on SSR) — the
|
|
3135
|
+
* Counters widget renders a skeleton instead of a possibly-stale number until it
|
|
3136
|
+
* flips. Text bindings stay on the SSR-baked metrics and ignore this flag.
|
|
3137
|
+
*/
|
|
3138
|
+
isLikeCountLoaded: boolean;
|
|
3139
|
+
toggleLike: (pointerEvent?: PointerEvent) => Promise<void>;
|
|
3140
|
+
/**
|
|
3141
|
+
* The like state ahead of the fields above, which only change in transitions — the Counters
|
|
3142
|
+
* and Actions widgets read this (see `LiveLikes`). `undefined` on the placeholder values.
|
|
3143
|
+
*/
|
|
3144
|
+
liveLikes: LiveLikes | undefined;
|
|
3145
|
+
/**
|
|
3146
|
+
* The clock the provider formatted its relative date from (`useHydrationClock`) — the
|
|
3147
|
+
* compact widgets format the raw `publishedDateValue` for themselves and must use the same
|
|
3148
|
+
* one, or their label would hydrate against a different "now" than the bound text did.
|
|
3149
|
+
* `0` on the placeholder, which publishes no date.
|
|
3150
|
+
*/
|
|
3151
|
+
clockValue: number;
|
|
3152
|
+
/**
|
|
3153
|
+
* Absolute URL of the current post on THIS app's post page, for the Actions widget's
|
|
3154
|
+
* Share button. Resolved here, not in the widget, so the "our page, never the first-party
|
|
3155
|
+
* `post.url` first, never the BM preview URL" knowledge stays in one place (`postLink`).
|
|
3156
|
+
* `undefined` in BM draft preview (the current URL carries the instance JWT) and until the
|
|
3157
|
+
* post resolves — the widget disables Share on `undefined`.
|
|
3158
|
+
*/
|
|
3159
|
+
postUrl: string | undefined;
|
|
3160
|
+
/**
|
|
3161
|
+
* The current post's ids, resolved — saves a consumer a redundant `getPostBySlug` of the
|
|
3162
|
+
* post this provider already fetched. Referentially stable across like toggles (own memo
|
|
3163
|
+
* keyed on the post fetch), so it is safe as a promise dependency.
|
|
3164
|
+
*
|
|
3165
|
+
* Note the Related Posts provider does NOT read this: it needs to start its queries
|
|
3166
|
+
* before the post resolves, so it takes the same ids as a promise from
|
|
3167
|
+
* `useOptionalPostSourcePromise`, which is published above the Suspense boundary.
|
|
3168
|
+
*/
|
|
3169
|
+
relatedPostsSource: RelatedPostsSource;
|
|
3170
|
+
/**
|
|
3171
|
+
* True only in the Suspense fallback provider, while the post fetch is pending.
|
|
3172
|
+
* Internal (not a manifest item — builders bound booleans to text elements before), for
|
|
3173
|
+
* consumers that want to render a placeholder rather than blank while the post loads.
|
|
3174
|
+
*/
|
|
3175
|
+
isLoadingPost: boolean;
|
|
3176
|
+
/**
|
|
3177
|
+
* The post read failed and nothing below is showing fetched content. Runtime-only for the
|
|
3178
|
+
* same reason as `isLoadingPost`: builders bound booleans to text elements before, so the
|
|
3179
|
+
* post context deliberately publishes none. The feed and Related Posts providers, which
|
|
3180
|
+
* already publish booleans, expose their `hasError` as a bindable item.
|
|
3181
|
+
*/
|
|
3182
|
+
hasError: boolean;
|
|
3183
|
+
/**
|
|
3184
|
+
* No post to show on the live site: Selected Post with nothing picked, or a failed read.
|
|
3185
|
+
* The compact widgets render nothing for it rather than a "0 likes" and a like button with
|
|
3186
|
+
* no post behind them. False on the editor stage, whose stand-ins stay visible, and while
|
|
3187
|
+
* loading. Runtime-only, like `hasError`.
|
|
3188
|
+
*/
|
|
3189
|
+
isEmpty: boolean;
|
|
3190
|
+
};
|
|
3191
|
+
/** Reads the current post from the nearest Post context provider; throws outside one. */
|
|
3192
|
+
declare function usePostContext(): PostContextType;
|
|
3193
|
+
/** Props accepted by {@link PostProvider}. */
|
|
3194
|
+
interface PostProviderProps {
|
|
3195
|
+
children?: React.ReactNode;
|
|
3196
|
+
/**
|
|
3197
|
+
* A post resolved by another provider that lists this one in its manifest `refContexts` —
|
|
3198
|
+
* published as-is, with no fetch, SEO, view count or translation redirect: those belong to
|
|
3199
|
+
* the post page. Without it this provider is the post page's own (`PostBySlugProvider`).
|
|
3200
|
+
* The same hybrid as wixstores' `category-info-context-provider`: a value-only base would
|
|
3201
|
+
* blank every live post page, which has this provider attached and relies on it fetching.
|
|
3202
|
+
* A caller with nothing to show must still pass a value (an empty one), or this falls back
|
|
3203
|
+
* to fetching the page's slug.
|
|
3204
|
+
*/
|
|
3205
|
+
value?: PostContextType;
|
|
3206
|
+
}
|
|
3207
|
+
/** Supplies the current blog post: the one a parent context hands down, or the post page's own. */
|
|
3208
|
+
declare function PostProvider({
|
|
3209
|
+
children,
|
|
3210
|
+
value
|
|
3211
|
+
}: PostProviderProps): React.ReactNode;
|
|
3212
|
+
|
|
3213
|
+
export { type PostCategoryItem, type PostContextType, type PostDerivedData, PostProvider, type PostProviderProps, type PostTagItem, PostProvider as default, usePostContext };
|