@progress/kendo-vue-editor 8.0.3-develop.2 → 8.0.3-develop.3
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/Editor.d.ts +587 -0
- package/Editor.mjs +2 -2
- package/EditorProps.d.ts +201 -0
- package/config/defaultStyles.d.ts +19 -0
- package/config/pasteSettings.d.ts +13 -0
- package/config/schema.d.ts +15 -0
- package/config/schema.mjs +3 -3
- package/config/shortcuts.d.ts +31 -0
- package/config/shortcuts.mjs +4 -4
- package/config/toolsSettings.d.ts +496 -0
- package/dialogs/EditorDialogProps.d.ts +30 -0
- package/dialogs/FindReplace.d.ts +83 -0
- package/dialogs/insertImage.d.ts +46 -0
- package/dialogs/insertLink.d.ts +42 -0
- package/dialogs/main.d.ts +7 -0
- package/dist/cdn/js/kendo-vue-editor.js +1 -1
- package/index.d.mts +192 -1920
- package/index.d.ts +192 -1920
- package/messages/main.d.ts +181 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +20 -14
- package/tools/ToolProps.d.ts +42 -0
- package/tools/align.d.ts +17 -0
- package/tools/cleanFormatting.d.ts +25 -0
- package/tools/findReplace.d.ts +24 -0
- package/tools/fontStyle.d.ts +31 -0
- package/tools/formatBlock.d.ts +21 -0
- package/tools/history.d.ts +25 -0
- package/tools/indent.d.ts +20 -0
- package/tools/inlineFormat.d.ts +50 -0
- package/tools/insertImage.d.ts +23 -0
- package/tools/insertLink.d.ts +23 -0
- package/tools/insertTable/popup.d.ts +112 -0
- package/tools/insertTable/popupGrid.d.ts +43 -0
- package/tools/insertTable/tool.d.ts +26 -0
- package/tools/lists.d.ts +24 -0
- package/tools/main.d.ts +102 -0
- package/tools/outdent.d.ts +20 -0
- package/tools/pdf.d.ts +34 -0
- package/tools/print.d.ts +25 -0
- package/tools/proseMirrorTool.d.ts +23 -0
- package/tools/selectAll.d.ts +25 -0
- package/tools/tableEdit.d.ts +58 -0
- package/tools/unlink.d.ts +22 -0
- package/tools/utils.d.ts +25 -0
- package/tools/viewHtml.d.ts +26 -0
- package/utils/browser-detection.d.ts +11 -0
- package/utils/cleanup.d.ts +38 -0
- package/utils/controlled-value.d.ts +12 -0
- package/utils/main.d.ts +364 -0
- package/utils/props-key.d.ts +12 -0
package/index.d.mts
CHANGED
|
@@ -5,1923 +5,195 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import { AllSelection } from '@progress/kendo-editor-common';
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
import
|
|
77
|
-
import
|
|
78
|
-
import
|
|
79
|
-
import
|
|
80
|
-
import
|
|
81
|
-
import
|
|
82
|
-
import
|
|
83
|
-
import
|
|
84
|
-
import
|
|
85
|
-
import
|
|
86
|
-
import
|
|
87
|
-
import
|
|
88
|
-
import
|
|
89
|
-
import
|
|
90
|
-
import
|
|
91
|
-
import
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
import
|
|
108
|
-
import
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
import
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
* ["Bold", "Italic", "Underline", "Strikethrough"],
|
|
201
|
-
* ["Subscript", "Superscript"],
|
|
202
|
-
* ["AlignLeft", "AlignCenter", "AlignRight", "AlignJustify"],
|
|
203
|
-
* ["Indent", "Outdent"],
|
|
204
|
-
* ["OrderedList", "UnorderedList"],
|
|
205
|
-
* "FontSize",
|
|
206
|
-
* "FontName",
|
|
207
|
-
* "FormatBlock",
|
|
208
|
-
* ["Undo", "Redo"],
|
|
209
|
-
* ["Link", "Unlink", "InsertImage", "ViewHtml"],
|
|
210
|
-
* ["InsertTable"],
|
|
211
|
-
* ["AddRowBefore", "AddRowAfter", "AddColumnBefore", "AddColumnAfter"],
|
|
212
|
-
* ["DeleteRow", "DeleteColumn", "DeleteTable"],
|
|
213
|
-
* ["MergeCells", "SplitCell"],
|
|
214
|
-
* ],
|
|
215
|
-
* content: content,
|
|
216
|
-
* };
|
|
217
|
-
* },
|
|
218
|
-
* };
|
|
219
|
-
* </script>
|
|
220
|
-
* ```
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
* ### props <span class='code'>Readonly<[EditorProps]({% slug api_editor_editorprops %})</span>
|
|
225
|
-
* The props of the Editor component.
|
|
226
|
-
*
|
|
227
|
-
* ### contentElement <span class='code'>HTMLDivElement</span>
|
|
228
|
-
* Returns the content-editable DOM element of the Editor.
|
|
229
|
-
*
|
|
230
|
-
* ### element <span class='code'>HTMLElement</span>
|
|
231
|
-
* Returns the DOM element of the Editor.
|
|
232
|
-
*
|
|
233
|
-
* ### value <span class='code'>Node | string</span>
|
|
234
|
-
* The value of the Editor.
|
|
235
|
-
*
|
|
236
|
-
* ### view <span class='code'>EditorView<any></span>
|
|
237
|
-
* Returns the `view` object of the Editor.
|
|
238
|
-
*/
|
|
239
|
-
export declare const Editor: DefineComponent<ExtractPropTypes< {
|
|
240
|
-
defaultContent: PropType<string>;
|
|
241
|
-
value: PropType<string | Node_2>;
|
|
242
|
-
defaultEditMode: {
|
|
243
|
-
type: PropType<string>;
|
|
244
|
-
default: string;
|
|
245
|
-
validator: (value: string) => any;
|
|
246
|
-
};
|
|
247
|
-
contentStyle: PropType<object>;
|
|
248
|
-
dir: PropType<string>;
|
|
249
|
-
tools: PropType<any[]>;
|
|
250
|
-
keyboardNavigation: {
|
|
251
|
-
type: PropType<boolean>;
|
|
252
|
-
default: boolean;
|
|
253
|
-
};
|
|
254
|
-
resizable: PropType<boolean>;
|
|
255
|
-
preserveWhitespace: {
|
|
256
|
-
type: PropType<string | boolean>;
|
|
257
|
-
default: string;
|
|
258
|
-
validator: (value: any) => any;
|
|
259
|
-
};
|
|
260
|
-
pasteHtml: PropType<(event: EditorPasteEvent) => string | void>;
|
|
261
|
-
extendView: PropType<(event: EditorMountEvent) => void | EditorView>;
|
|
262
|
-
ariaDescribedBy: PropType<string>;
|
|
263
|
-
ariaLabelledBy: PropType<string>;
|
|
264
|
-
ariaLabel: PropType<string>;
|
|
265
|
-
}>, {}, {
|
|
266
|
-
updateGuid: any;
|
|
267
|
-
view: any;
|
|
268
|
-
linkDialog: boolean;
|
|
269
|
-
showLicenseWatermark: boolean;
|
|
270
|
-
licenseMessage: any;
|
|
271
|
-
}, {}, {
|
|
272
|
-
getView(): any;
|
|
273
|
-
getHTML(): string;
|
|
274
|
-
setHTML(value: string): void;
|
|
275
|
-
focus(): void;
|
|
276
|
-
updateTools(view: any): void;
|
|
277
|
-
initialize(): void;
|
|
278
|
-
filterTransaction(transaction: Transaction, state: EditorState): true;
|
|
279
|
-
onPasteHtml(html: string): string;
|
|
280
|
-
dispatchTransaction(transaction: Transaction): void;
|
|
281
|
-
onFocus(_view: any, e: FocusEvent): false;
|
|
282
|
-
onBlur(_view: any, e: FocusEvent): false;
|
|
283
|
-
onPaste(_view: any, nativeEvent: any): false;
|
|
284
|
-
handleClose(): void;
|
|
285
|
-
computedValue(): any;
|
|
286
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {
|
|
287
|
-
focus: any;
|
|
288
|
-
blur: any;
|
|
289
|
-
change: any;
|
|
290
|
-
loaded: any;
|
|
291
|
-
execute: any;
|
|
292
|
-
}, string, PublicProps, Readonly<ExtractPropTypes< {
|
|
293
|
-
defaultContent: PropType<string>;
|
|
294
|
-
value: PropType<string | Node_2>;
|
|
295
|
-
defaultEditMode: {
|
|
296
|
-
type: PropType<string>;
|
|
297
|
-
default: string;
|
|
298
|
-
validator: (value: string) => any;
|
|
299
|
-
};
|
|
300
|
-
contentStyle: PropType<object>;
|
|
301
|
-
dir: PropType<string>;
|
|
302
|
-
tools: PropType<any[]>;
|
|
303
|
-
keyboardNavigation: {
|
|
304
|
-
type: PropType<boolean>;
|
|
305
|
-
default: boolean;
|
|
306
|
-
};
|
|
307
|
-
resizable: PropType<boolean>;
|
|
308
|
-
preserveWhitespace: {
|
|
309
|
-
type: PropType<string | boolean>;
|
|
310
|
-
default: string;
|
|
311
|
-
validator: (value: any) => any;
|
|
312
|
-
};
|
|
313
|
-
pasteHtml: PropType<(event: EditorPasteEvent) => string | void>;
|
|
314
|
-
extendView: PropType<(event: EditorMountEvent) => void | EditorView>;
|
|
315
|
-
ariaDescribedBy: PropType<string>;
|
|
316
|
-
ariaLabelledBy: PropType<string>;
|
|
317
|
-
ariaLabel: PropType<string>;
|
|
318
|
-
}>> & Readonly<{
|
|
319
|
-
onBlur?: (...args: any[] | unknown[]) => any;
|
|
320
|
-
onChange?: (...args: any[] | unknown[]) => any;
|
|
321
|
-
onFocus?: (...args: any[] | unknown[]) => any;
|
|
322
|
-
onLoaded?: (...args: any[] | unknown[]) => any;
|
|
323
|
-
onExecute?: (...args: any[] | unknown[]) => any;
|
|
324
|
-
}>, {
|
|
325
|
-
keyboardNavigation: boolean;
|
|
326
|
-
preserveWhitespace: string | boolean;
|
|
327
|
-
defaultEditMode: string;
|
|
328
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
329
|
-
|
|
330
|
-
/**
|
|
331
|
-
* Represents the object of the `onBlur` Editor event.
|
|
332
|
-
*/
|
|
333
|
-
export declare interface EditorBlurEvent extends EditorEvent {
|
|
334
|
-
/**
|
|
335
|
-
* The native blur event.
|
|
336
|
-
*/
|
|
337
|
-
event: FocusEvent;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
/**
|
|
341
|
-
* Represents the object of the `onChange` Editor event.
|
|
342
|
-
*/
|
|
343
|
-
export declare interface EditorChangeEvent extends EditorEvent {
|
|
344
|
-
/**
|
|
345
|
-
* Represents the [Editor document](https://prosemirror.net/docs/guide/#doc).
|
|
346
|
-
*/
|
|
347
|
-
value: Node_2;
|
|
348
|
-
/**
|
|
349
|
-
* A getter of the Editor HTML content.
|
|
350
|
-
* Once called, it will convert the Editor document into HTML string.
|
|
351
|
-
* Note that, since onChange event is triggered on every key while typing,
|
|
352
|
-
* this conversion may not be suitable if the Editor is dealing with large amount of content.
|
|
353
|
-
*/
|
|
354
|
-
html: string;
|
|
355
|
-
/**
|
|
356
|
-
* The Editor Schema object.
|
|
357
|
-
*/
|
|
358
|
-
schema: Schema;
|
|
359
|
-
/**
|
|
360
|
-
* The Transaction which causes the change.
|
|
361
|
-
*/
|
|
362
|
-
transaction: Transaction;
|
|
363
|
-
}
|
|
364
|
-
|
|
365
|
-
declare interface EditorEvent {
|
|
366
|
-
/**
|
|
367
|
-
* An event target.
|
|
368
|
-
*/
|
|
369
|
-
target: any;
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* Represents the object of the `onExecute` Editor event.
|
|
374
|
-
*/
|
|
375
|
-
export declare interface EditorExecuteEvent extends EditorEvent {
|
|
376
|
-
/**
|
|
377
|
-
* The transaction that will be executed.
|
|
378
|
-
*/
|
|
379
|
-
transaction: Transaction;
|
|
380
|
-
/**
|
|
381
|
-
* The state of the Editor.
|
|
382
|
-
*/
|
|
383
|
-
state: EditorState;
|
|
384
|
-
}
|
|
385
|
-
|
|
386
|
-
/**
|
|
387
|
-
* Represents the object of the `onFocus` Editor event.
|
|
388
|
-
*/
|
|
389
|
-
export declare interface EditorFocusEvent extends EditorEvent {
|
|
390
|
-
/**
|
|
391
|
-
* The native focus event.
|
|
392
|
-
*/
|
|
393
|
-
event: FocusEvent;
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
* Represents the object of the `onMount` Editor event.
|
|
398
|
-
*/
|
|
399
|
-
export declare interface EditorMountEvent extends EditorEvent {
|
|
400
|
-
/**
|
|
401
|
-
* The content-editable DOM element of the Editor.
|
|
402
|
-
*/
|
|
403
|
-
dom: HTMLDivElement;
|
|
404
|
-
/**
|
|
405
|
-
* The default plugins collection of the Editor.
|
|
406
|
-
*/
|
|
407
|
-
plugins: Array<Plugin_2>;
|
|
408
|
-
/**
|
|
409
|
-
* The default key bindings of the Editor.
|
|
410
|
-
*/
|
|
411
|
-
shortcuts: EditorUtils.Shortcuts;
|
|
412
|
-
/**
|
|
413
|
-
* The default [viewProps](https://prosemirror.net/docs/ref/#view.DirectEditorProps) object of the Editor.
|
|
414
|
-
*/
|
|
415
|
-
viewProps: {
|
|
416
|
-
state: EditorState;
|
|
417
|
-
[key: string]: any;
|
|
418
|
-
};
|
|
419
|
-
}
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* Represents the object of the `onPaste` Editor event.
|
|
423
|
-
*/
|
|
424
|
-
export declare interface EditorPasteEvent extends EditorEvent {
|
|
425
|
-
/**
|
|
426
|
-
* The HTML that will be pasted in the Editor.
|
|
427
|
-
*/
|
|
428
|
-
pastedHtml: string;
|
|
429
|
-
/**
|
|
430
|
-
* The native paste event.
|
|
431
|
-
*/
|
|
432
|
-
event: ClipboardEvent;
|
|
433
|
-
}
|
|
434
|
-
|
|
435
|
-
/**
|
|
436
|
-
* Represents the props of the [Kendo UI for Vue Editor component]({% slug overview_editor %}).
|
|
437
|
-
*/
|
|
438
|
-
export declare interface EditorProps {
|
|
439
|
-
/**
|
|
440
|
-
* Sets the default HTML content of the Editor.
|
|
441
|
-
*/
|
|
442
|
-
defaultContent?: string;
|
|
443
|
-
/**
|
|
444
|
-
* Sets the initial edit mode of the Editor. Defaults to `iframe`.
|
|
445
|
-
*/
|
|
446
|
-
defaultEditMode?: 'iframe' | 'div' | string;
|
|
447
|
-
/**
|
|
448
|
-
* Sets styles to the content element wrapper of the Editor.
|
|
449
|
-
*/
|
|
450
|
-
contentStyle?: object;
|
|
451
|
-
/**
|
|
452
|
-
* Represents the `dir` HTML attribute.
|
|
453
|
-
*/
|
|
454
|
-
dir?: string;
|
|
455
|
-
/**
|
|
456
|
-
* Specifies if the Editor will be resizable.
|
|
457
|
-
*/
|
|
458
|
-
resizable?: boolean;
|
|
459
|
-
/**
|
|
460
|
-
* Sets the tools of the Editor. By default, the Editor renders no tools.
|
|
461
|
-
*/
|
|
462
|
-
tools?: Array<any>;
|
|
463
|
-
/**
|
|
464
|
-
* A funciton that fires each time the Editor is about to insert pasted content.
|
|
465
|
-
* Useful for modifying pasted content.
|
|
466
|
-
*/
|
|
467
|
-
pasteHtml?: (event: EditorPasteEvent) => string | void;
|
|
468
|
-
/**
|
|
469
|
-
* Fires each time the Editor is about to mount.
|
|
470
|
-
* Useful for configuring the `EditorView` object.
|
|
471
|
-
* To initialize `EditorView`, use the properties of the `event` object.
|
|
472
|
-
*/
|
|
473
|
-
extendView?: (event: EditorMountEvent) => EditorView | void;
|
|
474
|
-
/**
|
|
475
|
-
* Fires each time the Editor is about to mount.
|
|
476
|
-
* Useful for configuring the `EditorView` object.
|
|
477
|
-
* To initialize `EditorView`, use the properties of the `event` object.
|
|
478
|
-
*/
|
|
479
|
-
onLoaded?: (event: EditorMountEvent) => EditorView | void;
|
|
480
|
-
/**
|
|
481
|
-
* Fires each time the Editor is about to apply a transaction.
|
|
482
|
-
* To prevent the transaction, return `false`.
|
|
483
|
-
*/
|
|
484
|
-
onExecute?: (event: EditorExecuteEvent) => boolean | void;
|
|
485
|
-
/**
|
|
486
|
-
* Fires when the Editor's content element has received focus.
|
|
487
|
-
*/
|
|
488
|
-
onFocus?: (event: EditorFocusEvent) => void;
|
|
489
|
-
/**
|
|
490
|
-
* Fires when the Editor's content element has lost focus.
|
|
491
|
-
*/
|
|
492
|
-
onBlur?: (event: EditorBlurEvent) => void;
|
|
493
|
-
/**
|
|
494
|
-
* Fires each time the value of the Editor is about to change.
|
|
495
|
-
*/
|
|
496
|
-
onChange?: (event: EditorChangeEvent) => void;
|
|
497
|
-
/**
|
|
498
|
-
* The value of the Editor.
|
|
499
|
-
*/
|
|
500
|
-
value?: Node_2 | string;
|
|
501
|
-
/**
|
|
502
|
-
* If set to `false`, it will turn off the built-in keyboard navigation of the Editor's Toolbar.
|
|
503
|
-
*/
|
|
504
|
-
keyboardNavigation?: boolean;
|
|
505
|
-
/**
|
|
506
|
-
* Defines the options that will be used for parsing the HTML.
|
|
507
|
-
* If `false` is set, the whitespace is collapsed as per HTML's rules.
|
|
508
|
-
* Pass `true` to preserve whitespace, but normalize newlines to spaces.
|
|
509
|
-
* `full` will preserve whitespace entirely.
|
|
510
|
-
*
|
|
511
|
-
* Defaults to `full`.
|
|
512
|
-
*/
|
|
513
|
-
preserveWhitespace?: boolean | 'full' | string;
|
|
514
|
-
/**
|
|
515
|
-
* Identifies the element(s) which will describe the component, similar
|
|
516
|
-
* to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
|
|
517
|
-
*/
|
|
518
|
-
ariaDescribedBy?: string;
|
|
519
|
-
/**
|
|
520
|
-
* Identifies the element(s) which will label the component.
|
|
521
|
-
*/
|
|
522
|
-
ariaLabelledBy?: string;
|
|
523
|
-
/**
|
|
524
|
-
* The accessible label of the component.
|
|
525
|
-
*/
|
|
526
|
-
ariaLabel?: string;
|
|
527
|
-
}
|
|
528
|
-
|
|
529
|
-
/**
|
|
530
|
-
* Represents a wrapping namespace for the tool components, props, and functions of the Editor.
|
|
531
|
-
*/
|
|
532
|
-
export declare namespace EditorTools {
|
|
533
|
-
/**
|
|
534
|
-
* The props for the Align tool component of the Editor.
|
|
535
|
-
*/
|
|
536
|
-
export interface AlignToolProps extends ToolProps {
|
|
537
|
-
}
|
|
538
|
-
/**
|
|
539
|
-
* The props for the AlignLeft tool component of the Editor.
|
|
540
|
-
*/
|
|
541
|
-
export interface AlignLeftProps extends AlignToolProps {
|
|
542
|
-
}
|
|
543
|
-
/**
|
|
544
|
-
* The props for the AlignRight tool component of the Editor.
|
|
545
|
-
*/
|
|
546
|
-
export interface AlignRightProps extends AlignToolProps {
|
|
547
|
-
}
|
|
548
|
-
/**
|
|
549
|
-
* The props for the AlignCenter tool component of the Editor.
|
|
550
|
-
*/
|
|
551
|
-
export interface AlignCenterProps extends AlignToolProps {
|
|
552
|
-
}
|
|
553
|
-
/**
|
|
554
|
-
* The props for the AlignJustify tool component of the Editor.
|
|
555
|
-
*/
|
|
556
|
-
export interface AlignJustifyProps extends AlignToolProps {
|
|
557
|
-
}
|
|
558
|
-
/**
|
|
559
|
-
* The props for the Print tool component of the Editor.
|
|
560
|
-
*/
|
|
561
|
-
export interface PrintProps extends PrintProps {
|
|
562
|
-
}
|
|
563
|
-
/**
|
|
564
|
-
* The props for the Export to PDF tool component of the Editor.
|
|
565
|
-
*/
|
|
566
|
-
export interface PdfProps extends PdfProps {
|
|
567
|
-
}
|
|
568
|
-
/**
|
|
569
|
-
* The props for the AddRowBefore tool component of the Editor.
|
|
570
|
-
*/
|
|
571
|
-
export interface AddRowBeforeProps extends TableEditNS.AddRowBeforeProps {
|
|
572
|
-
}
|
|
573
|
-
/**
|
|
574
|
-
* The props for the AddRowAfter tool component of the Editor.
|
|
575
|
-
*/
|
|
576
|
-
export interface AddRowAfterProps extends TableEditNS.AddRowAfterProps {
|
|
577
|
-
}
|
|
578
|
-
/**
|
|
579
|
-
* The props for the AddColumnBefore tool component of the Editor.
|
|
580
|
-
*/
|
|
581
|
-
export interface AddColumnBeforeProps extends TableEditNS.AddColumnBeforeProps {
|
|
582
|
-
}
|
|
583
|
-
/**
|
|
584
|
-
* The props for the AddColumnAfter tool component of the Editor.
|
|
585
|
-
*/
|
|
586
|
-
export interface AddColumnAfterProps extends TableEditNS.AddColumnAfterProps {
|
|
587
|
-
}
|
|
588
|
-
/**
|
|
589
|
-
* The props for the DeleteRow tool component of the Editor.
|
|
590
|
-
*/
|
|
591
|
-
export interface DeleteRowProps extends TableEditNS.DeleteRowProps {
|
|
592
|
-
}
|
|
593
|
-
/**
|
|
594
|
-
* The props for the DeleteColumn tool component of the Editor.
|
|
595
|
-
*/
|
|
596
|
-
export interface DeleteColumnProps extends TableEditNS.DeleteColumnProps {
|
|
597
|
-
}
|
|
598
|
-
/**
|
|
599
|
-
* The props for the DeleteTable tool component of the Editor.
|
|
600
|
-
*/
|
|
601
|
-
export interface DeleteTableProps extends TableEditNS.DeleteTableProps {
|
|
602
|
-
}
|
|
603
|
-
/**
|
|
604
|
-
* The props for the MergeCells tool component of the Editor.
|
|
605
|
-
*/
|
|
606
|
-
export interface MergeCellsProps extends TableEditNS.MergeCellsProps {
|
|
607
|
-
}
|
|
608
|
-
/**
|
|
609
|
-
* The props for the SplitCell tool component of the Editor.
|
|
610
|
-
*/
|
|
611
|
-
export interface SplitCellProps extends TableEditNS.SplitCellProps {
|
|
612
|
-
}
|
|
613
|
-
/**
|
|
614
|
-
* The props for the FindAndReplace tool component of the Editor.
|
|
615
|
-
*/
|
|
616
|
-
export interface FindAndReplaceProps extends FindAndReplaceProps {
|
|
617
|
-
}
|
|
618
|
-
}
|
|
619
|
-
|
|
620
|
-
/**
|
|
621
|
-
* Represents a wrapping namespace for the tool settings of the Editor.
|
|
622
|
-
*/
|
|
623
|
-
export declare namespace EditorToolsSettings {
|
|
624
|
-
/**
|
|
625
|
-
* The type of the Editor command.
|
|
626
|
-
*/
|
|
627
|
-
export type Command = 'Bold' | 'Italic' | 'Underline' | 'Strikethrough' | 'Subscript' | 'Superscript' | 'Undo' | 'Redo' | 'Link' | 'Unlink' | 'InsertImage' | 'InsertFile' | 'AlignLeft' | 'AlignCenter' | 'AlignRight' | 'AlignJustify' | 'AlignRemove' | 'OrderedList' | 'UnorderedList' | 'Indent' | 'Outdent' | 'SetContent' | 'FontSize' | 'FontName' | 'ForeColor' | 'BackColor' | 'FormatBlock' | 'InsertTable' | 'AddRowBefore' | 'AddRowAfter' | 'AddColumnBefore' | 'AddColumnAfter' | 'DeleteRow' | 'DeleteColumn' | 'DeleteTable' | 'MergeCells' | 'SplitCell' | 'CleanFormatting' | 'Custom';
|
|
628
|
-
/**
|
|
629
|
-
* The settings of the toolbar tools.
|
|
630
|
-
*/
|
|
631
|
-
export interface ToolSettings {
|
|
632
|
-
/**
|
|
633
|
-
* The props which will be added to the Button component of the tool.
|
|
634
|
-
*/
|
|
635
|
-
props: ButtonProps;
|
|
636
|
-
/**
|
|
637
|
-
* The keys of the messages that are used by the tool.
|
|
638
|
-
*/
|
|
639
|
-
messages: {
|
|
640
|
-
[key: string]: string;
|
|
641
|
-
};
|
|
642
|
-
/**
|
|
643
|
-
* The name of the command that is used by the tool.
|
|
644
|
-
*/
|
|
645
|
-
commandName?: Command;
|
|
646
|
-
command?: any;
|
|
647
|
-
}
|
|
648
|
-
/**
|
|
649
|
-
* The `AlignAction` object.
|
|
650
|
-
*/
|
|
651
|
-
export interface AlignAction {
|
|
652
|
-
/**
|
|
653
|
-
* The name of the target node.
|
|
654
|
-
*/
|
|
655
|
-
node: string;
|
|
656
|
-
/**
|
|
657
|
-
* The styles that will be applied to the target node.
|
|
658
|
-
*/
|
|
659
|
-
style: Array<{
|
|
660
|
-
name: string;
|
|
661
|
-
value: string;
|
|
662
|
-
}>;
|
|
663
|
-
}
|
|
664
|
-
/**
|
|
665
|
-
* The settings of the Align tool.
|
|
666
|
-
*/
|
|
667
|
-
export interface AlignSettings extends ToolSettings {
|
|
668
|
-
/**
|
|
669
|
-
* A collection of `AlignAction` objects which defines the behavior of the Align tool.
|
|
670
|
-
*/
|
|
671
|
-
actions: Array<AlignAction>;
|
|
672
|
-
}
|
|
673
|
-
/**
|
|
674
|
-
* The settings of the Style tool which is presented by a DropDownList component.
|
|
675
|
-
*/
|
|
676
|
-
export interface StyleDropDownListSettings {
|
|
677
|
-
/**
|
|
678
|
-
* The name of the style which will be added or removed by the Style tool.
|
|
679
|
-
*/
|
|
680
|
-
style: string;
|
|
681
|
-
/**
|
|
682
|
-
* The default item of the Style tool.
|
|
683
|
-
*/
|
|
684
|
-
defaultItem: {
|
|
685
|
-
text: string;
|
|
686
|
-
value: string;
|
|
687
|
-
localizationKey?: string;
|
|
688
|
-
};
|
|
689
|
-
/**
|
|
690
|
-
* The data items of the Style tool.
|
|
691
|
-
*/
|
|
692
|
-
items: Array<{
|
|
693
|
-
text: string;
|
|
694
|
-
value: string;
|
|
695
|
-
style?: {};
|
|
696
|
-
}>;
|
|
697
|
-
/**
|
|
698
|
-
* The name of the command that is used by the Style tool.
|
|
699
|
-
*/
|
|
700
|
-
commandName?: Command;
|
|
701
|
-
}
|
|
702
|
-
/**
|
|
703
|
-
* The settings of the FormatBlock tool which is presented by a DropDownList.
|
|
704
|
-
*/
|
|
705
|
-
export interface FormatBlockDropDownListSettings {
|
|
706
|
-
/**
|
|
707
|
-
* The default item of the FormatBlock tool.
|
|
708
|
-
*/
|
|
709
|
-
defaultItem: {
|
|
710
|
-
text: string;
|
|
711
|
-
value: string;
|
|
712
|
-
localizationKey?: string;
|
|
713
|
-
};
|
|
714
|
-
/**
|
|
715
|
-
* The data items of the FormatBlock tool.
|
|
716
|
-
*/
|
|
717
|
-
items: Array<{
|
|
718
|
-
text: string;
|
|
719
|
-
value: string;
|
|
720
|
-
style?: {};
|
|
721
|
-
}>;
|
|
722
|
-
/**
|
|
723
|
-
* The name of the command that is used by the FormatBlock tool.
|
|
724
|
-
*/
|
|
725
|
-
commandName?: Command;
|
|
726
|
-
}
|
|
727
|
-
/**
|
|
728
|
-
* The inline-formatting options.
|
|
729
|
-
*/
|
|
730
|
-
export interface InlineFormatOptions {
|
|
731
|
-
/**
|
|
732
|
-
* The mark which will be applied or stripped.
|
|
733
|
-
*/
|
|
734
|
-
mark: string;
|
|
735
|
-
/**
|
|
736
|
-
* The additional marks which will be stripped.
|
|
737
|
-
*/
|
|
738
|
-
altMarks?: Array<string>;
|
|
739
|
-
/**
|
|
740
|
-
* An object which holds the style that will be stripped by the tool.
|
|
741
|
-
*/
|
|
742
|
-
altStyle?: {
|
|
743
|
-
/**
|
|
744
|
-
* The name of the style.
|
|
745
|
-
*/
|
|
746
|
-
name: string;
|
|
747
|
-
/**
|
|
748
|
-
* The regular expression which will be matched with the value of the style.
|
|
749
|
-
*/
|
|
750
|
-
value: RegExp;
|
|
751
|
-
};
|
|
752
|
-
}
|
|
753
|
-
/**
|
|
754
|
-
* The settings of the tool which applies inline formatting.
|
|
755
|
-
*/
|
|
756
|
-
export interface InlineFormatSettings extends ToolSettings, InlineFormatOptions {
|
|
757
|
-
}
|
|
758
|
-
/**
|
|
759
|
-
* The settings of the ForeColor and BackColor tools.
|
|
760
|
-
*/
|
|
761
|
-
export interface ApplyColorSettings {
|
|
762
|
-
/**
|
|
763
|
-
* The applied style by the tool (`color` or `background-color`).
|
|
764
|
-
*/
|
|
765
|
-
color: string;
|
|
766
|
-
/**
|
|
767
|
-
* The props of the underlying [Kendo UI for Vue ColorPicker component]({% slug overview_colorpicker %}).
|
|
768
|
-
*/
|
|
769
|
-
colorPickerProps: any;
|
|
770
|
-
/**
|
|
771
|
-
* The name of the applied command.
|
|
772
|
-
*/
|
|
773
|
-
commandName: string;
|
|
774
|
-
/**
|
|
775
|
-
* The dir of the applied command.
|
|
776
|
-
*/
|
|
777
|
-
dir?: String;
|
|
778
|
-
/**
|
|
779
|
-
* The ariaLabel of the applied command.
|
|
780
|
-
*/
|
|
781
|
-
ariaLabel?: String;
|
|
782
|
-
}
|
|
783
|
-
/**
|
|
784
|
-
* The setting of the IndentAction tool.
|
|
785
|
-
*/
|
|
786
|
-
export interface IndentAction {
|
|
787
|
-
node: string;
|
|
788
|
-
style: string;
|
|
789
|
-
rtlStyle: string;
|
|
790
|
-
step: number;
|
|
791
|
-
unit: string;
|
|
792
|
-
}
|
|
793
|
-
/**
|
|
794
|
-
* The settings of the tool which applies indentation.
|
|
795
|
-
*/
|
|
796
|
-
export interface IndentationSettings extends ToolSettings {
|
|
797
|
-
actions: Array<IndentAction>;
|
|
798
|
-
/**
|
|
799
|
-
* The list node types of the Indent and Outdent tools.
|
|
800
|
-
*/
|
|
801
|
-
listsTypes: {
|
|
802
|
-
orderedList: string;
|
|
803
|
-
bulletList: string;
|
|
804
|
-
listItem: string;
|
|
805
|
-
};
|
|
806
|
-
}
|
|
807
|
-
/**
|
|
808
|
-
* The settings of the Link tool or dialog.
|
|
809
|
-
*/
|
|
810
|
-
export interface LinkSettings extends ToolSettings {
|
|
811
|
-
mark: string;
|
|
812
|
-
linkTarget?: boolean;
|
|
813
|
-
}
|
|
814
|
-
/**
|
|
815
|
-
* The settings of the Unlink tool.
|
|
816
|
-
*/
|
|
817
|
-
export interface UnlinkSettings extends ToolSettings {
|
|
818
|
-
mark: string;
|
|
819
|
-
}
|
|
820
|
-
/**
|
|
821
|
-
* The settings of the InsertFile tool or dialog.
|
|
822
|
-
*/
|
|
823
|
-
export interface InsertFileSettings extends LinkSettings {
|
|
824
|
-
}
|
|
825
|
-
/**
|
|
826
|
-
* The settings of the tool which toggles lists.
|
|
827
|
-
*/
|
|
828
|
-
export interface ListSettings extends ToolSettings {
|
|
829
|
-
/**
|
|
830
|
-
* The list type of the tool.
|
|
831
|
-
*/
|
|
832
|
-
listType: string;
|
|
833
|
-
/**
|
|
834
|
-
* The types of the list nodes that are used by the tool.
|
|
835
|
-
*/
|
|
836
|
-
types: {
|
|
837
|
-
orderedList: string;
|
|
838
|
-
bulletList: string;
|
|
839
|
-
listItem: string;
|
|
840
|
-
};
|
|
841
|
-
}
|
|
842
|
-
/**
|
|
843
|
-
* The settings of the InsertTable tool.
|
|
844
|
-
*/
|
|
845
|
-
export interface InsertTableSettings extends ToolSettings {
|
|
846
|
-
}
|
|
847
|
-
/**
|
|
848
|
-
* The settings of the AddRowBefore tool.
|
|
849
|
-
*/
|
|
850
|
-
export interface AddRowBeforeSettings extends ToolSettings {
|
|
851
|
-
}
|
|
852
|
-
/**
|
|
853
|
-
* The settings of the AddRowAfter tool.
|
|
854
|
-
*/
|
|
855
|
-
export interface AddRowAfterSettings extends ToolSettings {
|
|
856
|
-
}
|
|
857
|
-
/**
|
|
858
|
-
* The settings of the AddColumnBefore tool.
|
|
859
|
-
*/
|
|
860
|
-
export interface AddColumnBeforeSettings extends ToolSettings {
|
|
861
|
-
}
|
|
862
|
-
/**
|
|
863
|
-
* The settings of the AddColumnAfter tool.
|
|
864
|
-
*/
|
|
865
|
-
export interface AddColumnAfterSettings extends ToolSettings {
|
|
866
|
-
}
|
|
867
|
-
/**
|
|
868
|
-
* The settings of the DeleteRow tool.
|
|
869
|
-
*/
|
|
870
|
-
export interface DeleteRowSettings extends ToolSettings {
|
|
871
|
-
}
|
|
872
|
-
/**
|
|
873
|
-
* The settings of the DeleteColumn tool.
|
|
874
|
-
*/
|
|
875
|
-
export interface DeleteColumnSettings extends ToolSettings {
|
|
876
|
-
}
|
|
877
|
-
/**
|
|
878
|
-
* The settings of the DeleteTable tool.
|
|
879
|
-
*/
|
|
880
|
-
export interface DeleteTableSettings extends ToolSettings {
|
|
881
|
-
}
|
|
882
|
-
/**
|
|
883
|
-
* The settings of the MergeCells tool.
|
|
884
|
-
*/
|
|
885
|
-
export interface MergeCellsSettings extends ToolSettings {
|
|
886
|
-
}
|
|
887
|
-
/**
|
|
888
|
-
* The settings of the SplitCell tool.
|
|
889
|
-
*/
|
|
890
|
-
export interface SplitCellSettings extends ToolSettings {
|
|
891
|
-
}
|
|
892
|
-
/**
|
|
893
|
-
* The settings of the Print tool.
|
|
894
|
-
*/
|
|
895
|
-
export interface PrintSettings extends ToolSettings {
|
|
896
|
-
}
|
|
897
|
-
/**
|
|
898
|
-
* The settings of the SelectAll tool.
|
|
899
|
-
*/
|
|
900
|
-
export interface SelectAllSettings extends ToolSettings {
|
|
901
|
-
}
|
|
902
|
-
/**
|
|
903
|
-
* The settings of the Pdf tool.
|
|
904
|
-
*/
|
|
905
|
-
export interface PdfSettings extends ToolSettings {
|
|
906
|
-
}
|
|
907
|
-
/**
|
|
908
|
-
* The settings of the CleanFormatting tool.
|
|
909
|
-
*/
|
|
910
|
-
export interface CleanFormattingSettings extends ToolSettings {
|
|
911
|
-
}
|
|
912
|
-
/**
|
|
913
|
-
* The settings of the InsertImage tool or dialog.
|
|
914
|
-
*/
|
|
915
|
-
export interface ImageSettings extends ToolSettings {
|
|
916
|
-
node: string;
|
|
917
|
-
}
|
|
918
|
-
/**
|
|
919
|
-
* The settings of the ViewHtml tool or dialog.
|
|
920
|
-
*/
|
|
921
|
-
export interface ViewHtmlSettings extends ToolSettings {
|
|
922
|
-
}
|
|
923
|
-
/**
|
|
924
|
-
* The settings of the Find and Replace tool or dialog.
|
|
925
|
-
*/
|
|
926
|
-
export interface FindReplaceSettings extends ToolSettings {
|
|
927
|
-
}
|
|
928
|
-
/**
|
|
929
|
-
* The object of the Bold tool settings.
|
|
930
|
-
*/
|
|
931
|
-
const bold: InlineFormatSettings;
|
|
932
|
-
/**
|
|
933
|
-
* The object of the Italic tool settings.
|
|
934
|
-
*/
|
|
935
|
-
const italic: InlineFormatSettings;
|
|
936
|
-
/**
|
|
937
|
-
* The object of the Underline tool settings.
|
|
938
|
-
*/
|
|
939
|
-
const underline: InlineFormatSettings;
|
|
940
|
-
/**
|
|
941
|
-
* The object of the Strikethrough tool settings.
|
|
942
|
-
*/
|
|
943
|
-
const strikethrough: InlineFormatSettings;
|
|
944
|
-
/**
|
|
945
|
-
* The object of the Subscript tool settings.
|
|
946
|
-
*/
|
|
947
|
-
const subscript: InlineFormatSettings;
|
|
948
|
-
/**
|
|
949
|
-
* The object of the Superscript tool settings.
|
|
950
|
-
*/
|
|
951
|
-
const superscript: InlineFormatSettings;
|
|
952
|
-
/**
|
|
953
|
-
* The object of the Link tool settings.
|
|
954
|
-
*/
|
|
955
|
-
const link: LinkSettings;
|
|
956
|
-
/**
|
|
957
|
-
* The object of the Link tool settings.
|
|
958
|
-
*/
|
|
959
|
-
const insertFile: InsertFileSettings;
|
|
960
|
-
/**
|
|
961
|
-
* The object of the InsertTable tool settings.
|
|
962
|
-
*/
|
|
963
|
-
const insertTable: InsertTableSettings;
|
|
964
|
-
/**
|
|
965
|
-
* The object of the AddRowBefore tool settings.
|
|
966
|
-
*/
|
|
967
|
-
const addRowBefore: AddRowBeforeSettings;
|
|
968
|
-
/**
|
|
969
|
-
* The object of the AddRowAfter tool settings.
|
|
970
|
-
*/
|
|
971
|
-
const addRowAfter: AddRowAfterSettings;
|
|
972
|
-
/**
|
|
973
|
-
* The object of the AddColumnBefore tool settings.
|
|
974
|
-
*/
|
|
975
|
-
const addColumnBefore: AddColumnBeforeSettings;
|
|
976
|
-
/**
|
|
977
|
-
* The object of the AddColumnAfter tool settings.
|
|
978
|
-
*/
|
|
979
|
-
const addColumnAfter: AddColumnAfterSettings;
|
|
980
|
-
/**
|
|
981
|
-
* The object of the DeleteRow tool settings.
|
|
982
|
-
*/
|
|
983
|
-
const deleteRow: DeleteRowSettings;
|
|
984
|
-
/**
|
|
985
|
-
* The object of the DeleteColumn tool settings.
|
|
986
|
-
*/
|
|
987
|
-
const deleteColumn: DeleteColumnSettings;
|
|
988
|
-
/**
|
|
989
|
-
* The object of the DeleteTable tool settings.
|
|
990
|
-
*/
|
|
991
|
-
const deleteTable: DeleteTableSettings;
|
|
992
|
-
/**
|
|
993
|
-
* The object of the MergeCells tool settings.
|
|
994
|
-
*/
|
|
995
|
-
const mergeCells: MergeCellsSettings;
|
|
996
|
-
/**
|
|
997
|
-
* The object of the SplitCell tool settings.
|
|
998
|
-
*/
|
|
999
|
-
const splitCell: SplitCellSettings;
|
|
1000
|
-
/**
|
|
1001
|
-
* The object of the Print tool settings.
|
|
1002
|
-
*/
|
|
1003
|
-
const print: PrintSettings;
|
|
1004
|
-
/**
|
|
1005
|
-
* The object of the Print tool settings.
|
|
1006
|
-
*/
|
|
1007
|
-
const selectAll: SelectAllSettings;
|
|
1008
|
-
/**
|
|
1009
|
-
* The object of the Print tool settings.
|
|
1010
|
-
*/
|
|
1011
|
-
const pdf: PdfSettings;
|
|
1012
|
-
/**
|
|
1013
|
-
* The PDF export options.
|
|
1014
|
-
*
|
|
1015
|
-
* const savePdfOptions = {
|
|
1016
|
-
* fileName: 'editor.pdf',
|
|
1017
|
-
* paperSize: 'A4',
|
|
1018
|
-
* margin: '1cm'
|
|
1019
|
-
* };
|
|
1020
|
-
*/
|
|
1021
|
-
const savePdfOptions: PDFExportProps;
|
|
1022
|
-
/**
|
|
1023
|
-
* The object of the CleanFormatting tool settings.
|
|
1024
|
-
*/
|
|
1025
|
-
const cleanFormatting: CleanFormattingSettings;
|
|
1026
|
-
/**
|
|
1027
|
-
* The object of the InsertImage tool settings.
|
|
1028
|
-
*/
|
|
1029
|
-
const image: ImageSettings;
|
|
1030
|
-
/**
|
|
1031
|
-
* The object of the ViewHtml tool settings.
|
|
1032
|
-
*/
|
|
1033
|
-
const viewHtml: ViewHtmlSettings;
|
|
1034
|
-
/**
|
|
1035
|
-
* The object of the Find and Replace tool settings.
|
|
1036
|
-
*/
|
|
1037
|
-
const findAndReplace: FindReplaceSettings;
|
|
1038
|
-
/**
|
|
1039
|
-
* The object of the Unlink tool settings.
|
|
1040
|
-
*/
|
|
1041
|
-
const unlink: UnlinkSettings;
|
|
1042
|
-
/**
|
|
1043
|
-
* The object of the Undo tool settings.
|
|
1044
|
-
*/
|
|
1045
|
-
const undo: ToolSettings;
|
|
1046
|
-
/**
|
|
1047
|
-
* The object of the Redo tool settings.
|
|
1048
|
-
*/
|
|
1049
|
-
const redo: ToolSettings;
|
|
1050
|
-
/**
|
|
1051
|
-
* The object of the FontSize tool settings.
|
|
1052
|
-
*/
|
|
1053
|
-
const fontSize: StyleDropDownListSettings;
|
|
1054
|
-
/**
|
|
1055
|
-
* The object of the FontName tool settings.
|
|
1056
|
-
*/
|
|
1057
|
-
const fontName: StyleDropDownListSettings;
|
|
1058
|
-
/**
|
|
1059
|
-
* The object of the FormatBlock tool settings.
|
|
1060
|
-
*/
|
|
1061
|
-
const formatBlock: FormatBlockDropDownListSettings;
|
|
1062
|
-
/**
|
|
1063
|
-
* The object of the ForeColor tool settings.
|
|
1064
|
-
*/
|
|
1065
|
-
const foreColor: ApplyColorSettings;
|
|
1066
|
-
/**
|
|
1067
|
-
* The object of the BackColor tool settings.
|
|
1068
|
-
*/
|
|
1069
|
-
const backColor: ApplyColorSettings;
|
|
1070
|
-
/**
|
|
1071
|
-
* The object of the AlignLeft tool settings.
|
|
1072
|
-
*/
|
|
1073
|
-
const alignLeft: AlignSettings;
|
|
1074
|
-
/**
|
|
1075
|
-
* The object of the AlignRight tool settings.
|
|
1076
|
-
*/
|
|
1077
|
-
const alignRight: AlignSettings;
|
|
1078
|
-
/**
|
|
1079
|
-
* The object of the AlignCenter tool settings.
|
|
1080
|
-
*/
|
|
1081
|
-
const alignCenter: AlignSettings;
|
|
1082
|
-
/**
|
|
1083
|
-
* The object of the AlignJustify tool settings.
|
|
1084
|
-
*/
|
|
1085
|
-
const alignJustify: AlignSettings;
|
|
1086
|
-
/**
|
|
1087
|
-
* The object of the AlignRemove tool settings.
|
|
1088
|
-
*/
|
|
1089
|
-
const alignRemove: AlignSettings;
|
|
1090
|
-
/**
|
|
1091
|
-
* The object of the Indent tool settings.
|
|
1092
|
-
*/
|
|
1093
|
-
const indent: IndentationSettings;
|
|
1094
|
-
/**
|
|
1095
|
-
* The object of the Outdent tool settings.
|
|
1096
|
-
*/
|
|
1097
|
-
const outdent: IndentationSettings;
|
|
1098
|
-
/**
|
|
1099
|
-
* The object of the OrderedList tool settings.
|
|
1100
|
-
*/
|
|
1101
|
-
const orderedList: ListSettings;
|
|
1102
|
-
/**
|
|
1103
|
-
* The object of the UnorderedList tool settings.
|
|
1104
|
-
*/
|
|
1105
|
-
const bulletList: ListSettings;
|
|
1106
|
-
}
|
|
1107
|
-
|
|
1108
|
-
/**
|
|
1109
|
-
* Represents a wrapping namespace for the utility functions, `nodes`, and `marks` objects of the Editor.
|
|
1110
|
-
*/
|
|
1111
|
-
export declare namespace EditorUtils {
|
|
1112
|
-
/**
|
|
1113
|
-
* Aligns the block elements in the selection.
|
|
1114
|
-
*
|
|
1115
|
-
* @returns {boolean} - If alignment is applied to any of the elements, returns `true`.
|
|
1116
|
-
*/
|
|
1117
|
-
export function alignBlocks(view: EditorView, actions: EditorToolsSettings.AlignAction[], command?: EditorToolsSettings.Command): boolean;
|
|
1118
|
-
/**
|
|
1119
|
-
* Wraps the selection in a `span` element with inline styles.
|
|
1120
|
-
*
|
|
1121
|
-
* @returns {boolean} - If a style is applied to any of the elements, returns `true`.
|
|
1122
|
-
*/
|
|
1123
|
-
export function applyInlineStyle(view: EditorView, options: {
|
|
1124
|
-
style: string;
|
|
1125
|
-
value: string;
|
|
1126
|
-
}, command?: EditorToolsSettings.Command): boolean;
|
|
1127
|
-
/**
|
|
1128
|
-
* Applies the link mark.
|
|
1129
|
-
*
|
|
1130
|
-
* @returns {boolean} - If the link is applied, returns `true`.
|
|
1131
|
-
*/
|
|
1132
|
-
export function applyLink(view: any, options: {
|
|
1133
|
-
mark: string;
|
|
1134
|
-
attrs: any;
|
|
1135
|
-
}, command?: EditorToolsSettings.Command): boolean;
|
|
1136
|
-
/**
|
|
1137
|
-
* Checks if any of the `list` elements in the selection can be indented.
|
|
1138
|
-
*
|
|
1139
|
-
* @returns {boolean}
|
|
1140
|
-
*/
|
|
1141
|
-
export function canIndentList(state: EditorState, nodeType: NodeType): boolean;
|
|
1142
|
-
/**
|
|
1143
|
-
* Checks if a node can be inserted in the current selection.
|
|
1144
|
-
*
|
|
1145
|
-
* @param {EditorState} state - The `state` object of the Editor.
|
|
1146
|
-
* @param {NodeType} nodeType - The type of the node that will be inserted.
|
|
1147
|
-
* @returns {boolean} - The node of this type can be inserted in the current selection.
|
|
1148
|
-
*/
|
|
1149
|
-
export function canInsert(state: EditorState, nodeType: NodeType): boolean;
|
|
1150
|
-
/**
|
|
1151
|
-
* Checks if any of the `list` elements in the selection can be outdented.
|
|
1152
|
-
*
|
|
1153
|
-
* @returns {boolean}
|
|
1154
|
-
*/
|
|
1155
|
-
export function canOutdentList(state: EditorState, listsTypes: {
|
|
1156
|
-
listItem: string;
|
|
1157
|
-
orderedList: string;
|
|
1158
|
-
bulletList: string;
|
|
1159
|
-
}): boolean;
|
|
1160
|
-
/**
|
|
1161
|
-
* Converts the MS Word lists into HTML lists.
|
|
1162
|
-
*
|
|
1163
|
-
* @param {string} html - The input HTML.
|
|
1164
|
-
* @returns {string} - The result HTML.
|
|
1165
|
-
*/
|
|
1166
|
-
export function convertMsLists(html: string): string;
|
|
1167
|
-
/**
|
|
1168
|
-
* Creates an Editor document from HTML content.
|
|
1169
|
-
*
|
|
1170
|
-
* @param {Schema} schema - The `schema` object of the Editor.
|
|
1171
|
-
* @param {string} html - The HTML content.
|
|
1172
|
-
* @param {ParseOptions} parseOptions - The HTML parsing options. Defaults to `{ preserveWhitespace: 'full' }`.
|
|
1173
|
-
* @returns {Node} - The `document` object of the Editor.
|
|
1174
|
-
*/
|
|
1175
|
-
export function createDocument(schema: Schema<any, any>, html: string, parseOptions?: ParseOptions): Node_2;
|
|
1176
|
-
/**
|
|
1177
|
-
* Creates a table.
|
|
1178
|
-
*
|
|
1179
|
-
* @param {object} tableTypes - An object which contains `table`, `table_row`, and `table_cell` node types.
|
|
1180
|
-
* @param {number} rows - The number of rows.
|
|
1181
|
-
* @param {number} columns - The number of columns.
|
|
1182
|
-
* @returns {Node} - The generated table.
|
|
1183
|
-
*
|
|
1184
|
-
* @example
|
|
1185
|
-
* ```jsx-no-run
|
|
1186
|
-
* import { EditorUtils } from '@progress/kendo-vue-editor';
|
|
1187
|
-
*
|
|
1188
|
-
* const nodes = editorRef.view.state.schema.nodes;
|
|
1189
|
-
* const rows = 3;
|
|
1190
|
-
* const columns = 4;
|
|
1191
|
-
*
|
|
1192
|
-
* const table = EditorUtils.createTable(nodes, rows, columns);
|
|
1193
|
-
* ```
|
|
1194
|
-
*/
|
|
1195
|
-
export function createTable(tableTypes: {
|
|
1196
|
-
table: NodeType;
|
|
1197
|
-
table_row: NodeType;
|
|
1198
|
-
table_cell: NodeType;
|
|
1199
|
-
}, rows: number, columns: number): Node_2;
|
|
1200
|
-
/**
|
|
1201
|
-
* Formats the paragraph and heading nodes in the selection.
|
|
1202
|
-
*
|
|
1203
|
-
* @returns {boolean} - If an element is formatted, returns `true`.
|
|
1204
|
-
*/
|
|
1205
|
-
export function formatBlockElements(view: EditorView, value: 'p' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6', commandName?: EditorToolsSettings.Command): boolean;
|
|
1206
|
-
/**
|
|
1207
|
-
* Returns the paragraph and heading nodes in the selection.
|
|
1208
|
-
*
|
|
1209
|
-
* @returns {string[]}
|
|
1210
|
-
*/
|
|
1211
|
-
export function getBlockFormats(state: EditorState): string[];
|
|
1212
|
-
/**
|
|
1213
|
-
* Gets the HTML from the `EditorState` object.
|
|
1214
|
-
*
|
|
1215
|
-
* @param {EditorState} state - The `state` object of the Editor or an object containing editor's `doc` and `schema`
|
|
1216
|
-
* - { doc: value, schema: value.types.schema } where the `value` variable is the editor's value prop.
|
|
1217
|
-
* @returns {string} - The HTML content.
|
|
1218
|
-
*/
|
|
1219
|
-
export function getHtml(state: EditorState | {
|
|
1220
|
-
doc: Node_2;
|
|
1221
|
-
schema: Schema;
|
|
1222
|
-
}): string;
|
|
1223
|
-
/**
|
|
1224
|
-
* @returns {string[]} - An array of matched styles that are found in the selection.
|
|
1225
|
-
*/
|
|
1226
|
-
export function getInlineStyles(state: EditorState, style: {
|
|
1227
|
-
name: string;
|
|
1228
|
-
value: RegExp;
|
|
1229
|
-
}): string[];
|
|
1230
|
-
/**
|
|
1231
|
-
* Returns a mark of the specified type from the nodes in selection.
|
|
1232
|
-
*
|
|
1233
|
-
* @returns {Mark}
|
|
1234
|
-
*/
|
|
1235
|
-
export function getMark(state: EditorState, markType: MarkType): Mark | undefined;
|
|
1236
|
-
/**
|
|
1237
|
-
* Checks if according to the specified `InlineFormatOptions` a node in the selection is present.
|
|
1238
|
-
*
|
|
1239
|
-
* @returns {boolean}
|
|
1240
|
-
*/
|
|
1241
|
-
export function hasMark(state: EditorState, options: EditorToolsSettings.InlineFormatOptions): boolean;
|
|
1242
|
-
/**
|
|
1243
|
-
* Checks if the selection contains a specific type of node.
|
|
1244
|
-
*
|
|
1245
|
-
* @returns {boolean}
|
|
1246
|
-
*/
|
|
1247
|
-
export function hasNode(state: EditorState, nodeType: NodeType): boolean;
|
|
1248
|
-
/**
|
|
1249
|
-
* Indents the block elements in the selection.
|
|
1250
|
-
*
|
|
1251
|
-
* @returns {boolean} - If indentation is applied to any of the elements, returns `true`.
|
|
1252
|
-
*/
|
|
1253
|
-
export function indentBlocks(view: EditorView, actions: EditorToolsSettings.IndentAction[], command?: EditorToolsSettings.Command, dir?: string): boolean;
|
|
1254
|
-
/**
|
|
1255
|
-
* Adds new lines after block elements and hard breaks.
|
|
1256
|
-
*
|
|
1257
|
-
* @param {string} content - The HTML content.
|
|
1258
|
-
* @returns {string} - The indented HTML.
|
|
1259
|
-
*/
|
|
1260
|
-
export function indentHtml(content: string): string;
|
|
1261
|
-
/**
|
|
1262
|
-
* Inserts a node in the selection.
|
|
1263
|
-
*
|
|
1264
|
-
* @param {EditorView} view - The `view` object of the Editor.
|
|
1265
|
-
* @param {Node} node - A `node` object of the Editor.
|
|
1266
|
-
* @param {boolean} scrollIntoView - An optional parameter.
|
|
1267
|
-
* Defines if the content element will be scrolled to the current selection.
|
|
1268
|
-
*/
|
|
1269
|
-
export function insertNode(view: EditorView | {
|
|
1270
|
-
state: EditorState;
|
|
1271
|
-
dispatch: (tr: Transaction) => void;
|
|
1272
|
-
}, node: Node_2, scrollIntoView?: boolean | undefined): void;
|
|
1273
|
-
/**
|
|
1274
|
-
* Checks if any of the block elements in the selection is aligned.
|
|
1275
|
-
*
|
|
1276
|
-
* @returns {boolean}
|
|
1277
|
-
*/
|
|
1278
|
-
export function isAligned(state: EditorState, actions: EditorToolsSettings.AlignAction[]): boolean;
|
|
1279
|
-
/**
|
|
1280
|
-
* Checks if any of the block elements in the selection is indented.
|
|
1281
|
-
*
|
|
1282
|
-
* @returns {boolean}
|
|
1283
|
-
*/
|
|
1284
|
-
export function isIndented(state: any, actions: EditorToolsSettings.IndentAction[], dir?: string): boolean;
|
|
1285
|
-
/**
|
|
1286
|
-
* Removes the comments from the HTML.
|
|
1287
|
-
*
|
|
1288
|
-
* @param {string} html - The input HTML.
|
|
1289
|
-
* @returns {string} - The result HTML.
|
|
1290
|
-
*
|
|
1291
|
-
* @example
|
|
1292
|
-
* ```jsx-no-run
|
|
1293
|
-
* import { EditorUtils } from '@progress/kendo-vue-editor';
|
|
1294
|
-
* const html = EditorUtils.removeComments('<p>some content<!-- comment --></p>');
|
|
1295
|
-
* ```
|
|
1296
|
-
*/
|
|
1297
|
-
export function removeComments(html: string): string;
|
|
1298
|
-
/**
|
|
1299
|
-
* Removes the specified tag from the HTML and keeps its child nodes.
|
|
1300
|
-
*
|
|
1301
|
-
* @param {string} html - The input HTML.
|
|
1302
|
-
* @param {string} tag - A tag or multiple tags separated by a vertical slash which will be removed.
|
|
1303
|
-
* For example, `span` or `b|i|u|span`.
|
|
1304
|
-
* @returns {string} - The resulting HTML.
|
|
1305
|
-
*
|
|
1306
|
-
* @example
|
|
1307
|
-
* ```jsx-no-run
|
|
1308
|
-
* import { EditorUtils } from '@progress/kendo-vue-editor';
|
|
1309
|
-
* const html = EditorUtils.removeTag('<p>some <span>content</span></p>', 'span|p');
|
|
1310
|
-
* ```
|
|
1311
|
-
*/
|
|
1312
|
-
export function removeTag(html: string, tag: string): string;
|
|
1313
|
-
/**
|
|
1314
|
-
* A function for sanitizing the content on paste ([see example]({% slug paste_editor %})).
|
|
1315
|
-
*
|
|
1316
|
-
* @param {string} html - The input HTML.
|
|
1317
|
-
* @param {PasteCleanupSettings} settings - The settings used for sanitizing the content.
|
|
1318
|
-
* @returns {string} - The resulting HTML.
|
|
1319
|
-
*/
|
|
1320
|
-
export function pasteCleanup(html: string, settings: PasteCleanupSettings): string;
|
|
1321
|
-
/**
|
|
1322
|
-
* A function for sanitizing the CSS classes of the pasted from MS Word content ([see example]({% slug paste_editor %})).
|
|
1323
|
-
* The function will remove any class attribute which value starts with `Mso`.
|
|
1324
|
-
* For example `<p class="MsoNormal">pasted from MS Word</p>` will result in `<p>pasted from MS Word</p>`.
|
|
1325
|
-
*
|
|
1326
|
-
* @param {Attr} attr - The DOM class attribute that will be sanitized.
|
|
1327
|
-
*/
|
|
1328
|
-
export function sanitizeClassAttr(attr: Attr): void;
|
|
1329
|
-
/**
|
|
1330
|
-
* A function for sanitizing the style attributes of the pasted from MS Word content ([see example]({% slug paste_editor %})).
|
|
1331
|
-
* The function will loop through all styles and will remove those that are invalid.
|
|
1332
|
-
* For example `<p><span style='color:#7C7C7C;mso-themecolor:accent3;mso-themeshade:191;background:silver;'>content</span></p>`,
|
|
1333
|
-
* will result in `<p><span style="color: #7C7C7C; background: silver;">content</span></p>`.
|
|
1334
|
-
*
|
|
1335
|
-
* @param {Attr} attr - The DOM style attribute that will be sanitized.
|
|
1336
|
-
*/
|
|
1337
|
-
export function sanitizeStyleAttr(attr: Attr): void;
|
|
1338
|
-
/**
|
|
1339
|
-
* A function that will remove a DOM attribute from the pasted content ([see example]({% slug paste_editor %})).
|
|
1340
|
-
*
|
|
1341
|
-
* @param {Attr} attr - The DOM attribute that will be removed.
|
|
1342
|
-
*/
|
|
1343
|
-
export function removeAttribute(attr: Attr): void;
|
|
1344
|
-
/**
|
|
1345
|
-
* Removes the invalid HTML.
|
|
1346
|
-
*
|
|
1347
|
-
* @param {string} html - The HTML which will be sanitized.
|
|
1348
|
-
* @returns {string} - The sanitized HTML.
|
|
1349
|
-
*
|
|
1350
|
-
* @example
|
|
1351
|
-
* ```jsx-no-run
|
|
1352
|
-
* import { EditorUtils } from '@progress/kendo-vue-editor';
|
|
1353
|
-
* const html = EditorUtils.sanitize('something pasted from MS Word, containing <o:p>, <w:sdtPr>, <v:shapes tags');
|
|
1354
|
-
* ```
|
|
1355
|
-
*/
|
|
1356
|
-
export function sanitize(html: string): string;
|
|
1357
|
-
/**
|
|
1358
|
-
* If the input `html` contains images with 'src' pointing to local file system (it happens when pasting images and text from MS Word),
|
|
1359
|
-
* the function will extract the images sources from the RTF in base64 format and replace them in the input `html`.
|
|
1360
|
-
*
|
|
1361
|
-
* @param html - The input HTML (pasted HTML).
|
|
1362
|
-
* @param clipboardData - The paste event clipboardData object (event.clipboardData).
|
|
1363
|
-
* @returns - The html with the replaced images sources.
|
|
1364
|
-
*/
|
|
1365
|
-
export function replaceImageSourcesFromRtf(html: string, clipboardData: DataTransfer): string;
|
|
1366
|
-
/**
|
|
1367
|
-
* Creates a plugin which highlights the matches of Find and Replace dialog.
|
|
1368
|
-
*
|
|
1369
|
-
* @param {PluginKey} key - The key of the plugin (Optional).
|
|
1370
|
-
* @returns {Plugin} - The text highlight plugin.
|
|
1371
|
-
*/
|
|
1372
|
-
export function textHighlight(key?: PluginKey): Plugin_2;
|
|
1373
|
-
/**
|
|
1374
|
-
* The image resizing plugin options.
|
|
1375
|
-
*/
|
|
1376
|
-
export interface ImageResizeOptions extends ImageResizeOptions {
|
|
1377
|
-
}
|
|
1378
|
-
/**
|
|
1379
|
-
* Creates a plugin which adds image resizing functionality.
|
|
1380
|
-
*
|
|
1381
|
-
* @param {ImageResizeOptions} options - The resizing option (Optional).
|
|
1382
|
-
* @returns {Plugin} - The image resizing plugin.
|
|
1383
|
-
*/
|
|
1384
|
-
export function imageResizing(options?: ImageResizeOptions): Plugin_2;
|
|
1385
|
-
/**
|
|
1386
|
-
* Sets the HTML to the `EditorView`.
|
|
1387
|
-
*
|
|
1388
|
-
* @param {EditorView} view - The `view` object of the Editor.
|
|
1389
|
-
* @param {string} html - The HTML content.
|
|
1390
|
-
* @param {Command} command - An optional parameter.
|
|
1391
|
-
* Defines the type of the command that will be set to the `setHtml` metadata of the transaction.
|
|
1392
|
-
* Defaults to `SetContent`.
|
|
1393
|
-
* @param {ParseOptions} parseOptions - An optional parameter.
|
|
1394
|
-
* Defines the options that will be used for parsing the HTML. Defaults to `{ preserveWhitespace: 'full' }`.
|
|
1395
|
-
*/
|
|
1396
|
-
export function setHtml(view: EditorView, html: string, command?: EditorToolsSettings.Command, parseOptions?: ParseOptions): void;
|
|
1397
|
-
/**
|
|
1398
|
-
* Toggles the inline element formatting according to the `InlineFormatOptions` and `markAttrs` settings.
|
|
1399
|
-
*
|
|
1400
|
-
* @returns {boolean}
|
|
1401
|
-
*/
|
|
1402
|
-
export function toggleInlineFormat(view: {
|
|
1403
|
-
state: EditorState;
|
|
1404
|
-
dispatch: (tr: Transaction) => void;
|
|
1405
|
-
}, options: EditorToolsSettings.InlineFormatOptions, transaction?: Transaction, markAttrs?: any): boolean;
|
|
1406
|
-
/**
|
|
1407
|
-
* Toggles a list of the specified type.
|
|
1408
|
-
*
|
|
1409
|
-
* @returns {boolean}
|
|
1410
|
-
*/
|
|
1411
|
-
export function toggleList(view: EditorView, types: {
|
|
1412
|
-
listType: string;
|
|
1413
|
-
orderedList: string;
|
|
1414
|
-
bulletList: string;
|
|
1415
|
-
listItem: string;
|
|
1416
|
-
}, command?: EditorToolsSettings.Command): boolean;
|
|
1417
|
-
/**
|
|
1418
|
-
* Represents the `Shortcuts` object.
|
|
1419
|
-
*/
|
|
1420
|
-
export interface Shortcuts extends shortcuts.Shortcuts {
|
|
1421
|
-
}
|
|
1422
|
-
/**
|
|
1423
|
-
* A function which returns the mapped `Shortcuts` object based on the passed settings.
|
|
1424
|
-
* Useful when the default Editor nodes or tool settings are changed and the `Shortcuts` object has to be regenerated.
|
|
1425
|
-
*
|
|
1426
|
-
* @params - An object which holds specific types of nodes and tool settings that are used by the default `Shortcuts` handlers.
|
|
1427
|
-
* @returns - An object which holds the shortcuts.
|
|
1428
|
-
*/
|
|
1429
|
-
export function getShortcuts(settings?: {
|
|
1430
|
-
types?: {
|
|
1431
|
-
listItem: string;
|
|
1432
|
-
hardBreak: string;
|
|
1433
|
-
};
|
|
1434
|
-
toolsSettings?: {
|
|
1435
|
-
bold?: EditorToolsSettings.InlineFormatOptions;
|
|
1436
|
-
italic?: EditorToolsSettings.InlineFormatOptions;
|
|
1437
|
-
underline?: EditorToolsSettings.InlineFormatOptions;
|
|
1438
|
-
};
|
|
1439
|
-
}): Shortcuts;
|
|
1440
|
-
/**
|
|
1441
|
-
* The `PluginKey` used in the Editor to pass editor props to the tools.
|
|
1442
|
-
*/
|
|
1443
|
-
const propsKey: PluginKey;
|
|
1444
|
-
/**
|
|
1445
|
-
* The `PluginKey` used in the Editor by the image resizing plugin.
|
|
1446
|
-
*/
|
|
1447
|
-
const imageResizeKey: PluginKey;
|
|
1448
|
-
/**
|
|
1449
|
-
* Represents the `marks` object of the Editor.
|
|
1450
|
-
*/
|
|
1451
|
-
const marks: {
|
|
1452
|
-
[mark: string]: MarkSpec;
|
|
1453
|
-
};
|
|
1454
|
-
/**
|
|
1455
|
-
* Represents the `nodes` object of the Editor.
|
|
1456
|
-
*/
|
|
1457
|
-
const nodes: {
|
|
1458
|
-
[node: string]: NodeSpec_2;
|
|
1459
|
-
};
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
/**
|
|
1463
|
-
* @hidden
|
|
1464
|
-
*/
|
|
1465
|
-
export declare const FindAndReplace: DefineComponent< {}, {}, {
|
|
1466
|
-
showDialog: boolean;
|
|
1467
|
-
}, {}, {
|
|
1468
|
-
onClose(): void;
|
|
1469
|
-
onOpen(): void;
|
|
1470
|
-
preventDefault(e: any): void;
|
|
1471
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1472
|
-
[x: string]: any;
|
|
1473
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1474
|
-
|
|
1475
|
-
declare interface FindAndReplaceProps extends BasicToolProps, ToolRenderProp, ButtonProps {
|
|
1476
|
-
}
|
|
1477
|
-
|
|
1478
|
-
/**
|
|
1479
|
-
* @hidden
|
|
1480
|
-
*/
|
|
1481
|
-
export declare const FontName: DefineComponent< {}, {}, {}, {}, {
|
|
1482
|
-
customItemRender(h: any, li: any, itemProps: any): any;
|
|
1483
|
-
onFontNameChange(e: DropDownListChangeEvent): void;
|
|
1484
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1485
|
-
[x: string]: any;
|
|
1486
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1487
|
-
|
|
1488
|
-
/**
|
|
1489
|
-
* @hidden
|
|
1490
|
-
*/
|
|
1491
|
-
export declare const FormatBlock: DefineComponent< {}, {}, {}, {}, {
|
|
1492
|
-
customItemRender(hRender: any, li: any, itemProps: any): any;
|
|
1493
|
-
onFormatBlockChange(e: DropDownListChangeEvent): void;
|
|
1494
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1495
|
-
[x: string]: any;
|
|
1496
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1497
|
-
|
|
1498
|
-
/**
|
|
1499
|
-
* @hidden
|
|
1500
|
-
*/
|
|
1501
|
-
declare const getShortcuts: (settings?: {
|
|
1502
|
-
types?: {
|
|
1503
|
-
listItem: string;
|
|
1504
|
-
hardBreak: string;
|
|
1505
|
-
};
|
|
1506
|
-
toolsSettings?: {
|
|
1507
|
-
bold?: EditorToolsSettings.InlineFormatOptions;
|
|
1508
|
-
italic?: EditorToolsSettings.InlineFormatOptions;
|
|
1509
|
-
underline?: EditorToolsSettings.InlineFormatOptions;
|
|
1510
|
-
};
|
|
1511
|
-
}) => Shortcuts;
|
|
1512
|
-
|
|
1513
|
-
/**
|
|
1514
|
-
* @hidden
|
|
1515
|
-
*/
|
|
1516
|
-
export declare const Indent: DefineComponent< {}, {}, {}, {}, {
|
|
1517
|
-
handleClick(): void;
|
|
1518
|
-
preventDefault(e: any): void;
|
|
1519
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1520
|
-
[x: string]: any;
|
|
1521
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1522
|
-
|
|
1523
|
-
/**
|
|
1524
|
-
* @hidden
|
|
1525
|
-
*/
|
|
1526
|
-
export declare const InlineFormat: DefineComponent< {}, {}, {}, {}, {
|
|
1527
|
-
handleClick(): boolean;
|
|
1528
|
-
preventDefault(e: any): void;
|
|
1529
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1530
|
-
[x: string]: any;
|
|
1531
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1532
|
-
|
|
1533
|
-
/**
|
|
1534
|
-
* @hidden
|
|
1535
|
-
*/
|
|
1536
|
-
export declare const InsertImage: DefineComponent< {}, {}, {
|
|
1537
|
-
openedDialog: boolean;
|
|
1538
|
-
}, {}, {
|
|
1539
|
-
toggleDialog(): void;
|
|
1540
|
-
preventDefault(e: any): void;
|
|
1541
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1542
|
-
[x: string]: any;
|
|
1543
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1544
|
-
|
|
1545
|
-
/**
|
|
1546
|
-
* @hidden
|
|
1547
|
-
*/
|
|
1548
|
-
export declare const InsertTable: DefineComponent< {}, {}, {
|
|
1549
|
-
openedPopup: boolean;
|
|
1550
|
-
}, {}, {
|
|
1551
|
-
togglePopup(): void;
|
|
1552
|
-
closePopup(): void;
|
|
1553
|
-
onTableInsert(row: number, col: number): void;
|
|
1554
|
-
preventDefault(e: any): void;
|
|
1555
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1556
|
-
[x: string]: any;
|
|
1557
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1558
|
-
|
|
1559
|
-
/**
|
|
1560
|
-
* @hidden
|
|
1561
|
-
*/
|
|
1562
|
-
export declare const LinkTool: DefineComponent< {}, {}, {
|
|
1563
|
-
openedDialog: boolean;
|
|
1564
|
-
}, {}, {
|
|
1565
|
-
toggleDialog(): void;
|
|
1566
|
-
preventDefault(e: any): void;
|
|
1567
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1568
|
-
[x: string]: any;
|
|
1569
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1570
|
-
|
|
1571
|
-
/**
|
|
1572
|
-
* @hidden
|
|
1573
|
-
*/
|
|
1574
|
-
export declare const List: DefineComponent< {}, {}, {}, {}, {
|
|
1575
|
-
handleClick(): void;
|
|
1576
|
-
preventDefault(e: any): void;
|
|
1577
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1578
|
-
[x: string]: any;
|
|
1579
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1580
|
-
|
|
1581
|
-
/**
|
|
1582
|
-
* @hidden
|
|
1583
|
-
*/
|
|
1584
|
-
export declare const Outdent: DefineComponent< {}, {}, {}, {}, {
|
|
1585
|
-
handleClick(): void;
|
|
1586
|
-
preventDefault(e: any): void;
|
|
1587
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1588
|
-
[x: string]: any;
|
|
1589
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1590
|
-
|
|
1591
|
-
/**
|
|
1592
|
-
* The settings passed to `pasteCleanup` function ([see example]({% slug paste_editor %})).
|
|
1593
|
-
*/
|
|
1594
|
-
export declare interface PasteCleanupSettings extends PasteCleanupSettings_2 {
|
|
1595
|
-
}
|
|
1596
|
-
|
|
1597
|
-
/**
|
|
1598
|
-
* @hidden
|
|
1599
|
-
*/
|
|
1600
|
-
export declare const Pdf: DefineComponent< {}, {}, {}, {}, {
|
|
1601
|
-
handleClick(): void;
|
|
1602
|
-
preventDefault(e: any): void;
|
|
1603
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1604
|
-
[x: string]: any;
|
|
1605
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1606
|
-
|
|
1607
|
-
declare interface PdfProps extends ToolProps {
|
|
1608
|
-
/**
|
|
1609
|
-
* The settings of the tool. Use it to modify the tool appearance.
|
|
1610
|
-
*/
|
|
1611
|
-
settings?: EditorToolsSettings.PdfSettings;
|
|
1612
|
-
/**
|
|
1613
|
-
* The options which will be passed to the [`savePDF`]({% slug api_pdf_savepdf %}) function.
|
|
1614
|
-
*/
|
|
1615
|
-
savePdfOptions?: PDFExportProps;
|
|
1616
|
-
/**
|
|
1617
|
-
* The callback which will be passed to the [`savePDF`]({% slug api_pdf_savepdf %}) function.
|
|
1618
|
-
*/
|
|
1619
|
-
savePdfCallback?: () => void;
|
|
1620
|
-
}
|
|
1621
|
-
|
|
1622
|
-
/**
|
|
1623
|
-
* @hidden
|
|
1624
|
-
*/
|
|
1625
|
-
export declare const Print: DefineComponent< {}, {}, {}, {}, {
|
|
1626
|
-
handleClick(): void;
|
|
1627
|
-
preventDefault(e: any): void;
|
|
1628
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1629
|
-
[x: string]: any;
|
|
1630
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1631
|
-
|
|
1632
|
-
declare interface PrintProps extends ToolProps {
|
|
1633
|
-
/**
|
|
1634
|
-
* The settings of the tool. Use it to modify the tool appearance.
|
|
1635
|
-
*/
|
|
1636
|
-
settings?: EditorToolsSettings.PrintSettings;
|
|
1637
|
-
}
|
|
1638
|
-
|
|
1639
|
-
/**
|
|
1640
|
-
* An object containing the content of ProseMirror packages used at the Editor component.
|
|
1641
|
-
*
|
|
1642
|
-
* "prosemirror-state",
|
|
1643
|
-
* "prosemirror-view",
|
|
1644
|
-
* "prosemirror-model",
|
|
1645
|
-
* "prosemirror-transform",
|
|
1646
|
-
* "prosemirror-commands",
|
|
1647
|
-
* "prosemirror-keymap",
|
|
1648
|
-
* "prosemirror-tables",
|
|
1649
|
-
* "prosemirror-schema-list",
|
|
1650
|
-
* "prosemirror-history",
|
|
1651
|
-
* "prosemirror-inputrules",
|
|
1652
|
-
* "prosemirror-dropcursor",
|
|
1653
|
-
* "prosemirror-gapcursor"
|
|
1654
|
-
*/
|
|
1655
|
-
export declare const ProseMirror: {
|
|
1656
|
-
Selection: typeof Selection_2;
|
|
1657
|
-
SelectionRange: typeof SelectionRange;
|
|
1658
|
-
TextSelection: typeof TextSelection;
|
|
1659
|
-
NodeSelection: typeof NodeSelection;
|
|
1660
|
-
AllSelection: typeof AllSelection;
|
|
1661
|
-
EditorState: typeof EditorState;
|
|
1662
|
-
Plugin: typeof Plugin_2;
|
|
1663
|
-
PluginKey: typeof PluginKey;
|
|
1664
|
-
Transaction: typeof Transaction;
|
|
1665
|
-
Decoration: typeof Decoration;
|
|
1666
|
-
DecorationSet: typeof DecorationSet;
|
|
1667
|
-
EditorView: typeof EditorView;
|
|
1668
|
-
Node: typeof Node_2;
|
|
1669
|
-
ResolvedPos: typeof ResolvedPos;
|
|
1670
|
-
NodeRange: typeof NodeRange;
|
|
1671
|
-
Fragment: typeof Fragment;
|
|
1672
|
-
Slice: typeof Slice;
|
|
1673
|
-
ReplaceError: typeof ReplaceError;
|
|
1674
|
-
Mark: typeof Mark;
|
|
1675
|
-
Schema: typeof Schema;
|
|
1676
|
-
NodeType: typeof NodeType;
|
|
1677
|
-
MarkType: typeof MarkType;
|
|
1678
|
-
ContentMatch: typeof ContentMatch;
|
|
1679
|
-
DOMParser: typeof DOMParser_2;
|
|
1680
|
-
DOMSerializer: typeof DOMSerializer;
|
|
1681
|
-
Transform: typeof Transform;
|
|
1682
|
-
Step: typeof Step;
|
|
1683
|
-
StepResult: typeof StepResult;
|
|
1684
|
-
joinPoint: typeof joinPoint;
|
|
1685
|
-
canJoin: typeof canJoin;
|
|
1686
|
-
canSplit: typeof canSplit;
|
|
1687
|
-
insertPoint: typeof insertPoint;
|
|
1688
|
-
dropPoint: typeof dropPoint;
|
|
1689
|
-
liftTarget: typeof liftTarget;
|
|
1690
|
-
findWrapping: typeof findWrapping;
|
|
1691
|
-
StepMap: typeof StepMap;
|
|
1692
|
-
MapResult: typeof MapResult;
|
|
1693
|
-
Mapping: typeof Mapping;
|
|
1694
|
-
AddMarkStep: typeof AddMarkStep;
|
|
1695
|
-
RemoveMarkStep: typeof RemoveMarkStep;
|
|
1696
|
-
ReplaceStep: typeof ReplaceStep;
|
|
1697
|
-
ReplaceAroundStep: typeof ReplaceAroundStep;
|
|
1698
|
-
replaceStep: typeof replaceStep;
|
|
1699
|
-
deleteSelection: Command;
|
|
1700
|
-
joinBackward: Command;
|
|
1701
|
-
selectNodeBackward: Command;
|
|
1702
|
-
joinForward: Command;
|
|
1703
|
-
selectNodeForward: Command;
|
|
1704
|
-
joinUp: Command;
|
|
1705
|
-
joinDown: Command;
|
|
1706
|
-
lift: Command;
|
|
1707
|
-
newlineInCode: Command;
|
|
1708
|
-
exitCode: Command;
|
|
1709
|
-
createParagraphNear: Command;
|
|
1710
|
-
liftEmptyBlock: Command;
|
|
1711
|
-
splitBlock: Command;
|
|
1712
|
-
splitBlockKeepMarks: Command;
|
|
1713
|
-
selectParentNode: Command;
|
|
1714
|
-
selectAll: Command;
|
|
1715
|
-
wrapIn: typeof wrapIn;
|
|
1716
|
-
setBlockType: typeof setBlockType;
|
|
1717
|
-
toggleMark: typeof toggleMark;
|
|
1718
|
-
autoJoin: typeof autoJoin;
|
|
1719
|
-
chainCommands: typeof chainCommands;
|
|
1720
|
-
pcBaseKeymap: {
|
|
1721
|
-
[key: string]: Command;
|
|
1722
|
-
};
|
|
1723
|
-
macBaseKeymap: {
|
|
1724
|
-
[key: string]: Command;
|
|
1725
|
-
};
|
|
1726
|
-
baseKeymap: {
|
|
1727
|
-
[key: string]: Command;
|
|
1728
|
-
};
|
|
1729
|
-
history: typeof history_2;
|
|
1730
|
-
undo: Command;
|
|
1731
|
-
redo: Command;
|
|
1732
|
-
undoDepth: typeof undoDepth;
|
|
1733
|
-
redoDepth: typeof redoDepth;
|
|
1734
|
-
InputRule: typeof InputRule;
|
|
1735
|
-
inputRules: typeof inputRules;
|
|
1736
|
-
undoInputRule: Command;
|
|
1737
|
-
emDash: InputRule;
|
|
1738
|
-
ellipsis: InputRule;
|
|
1739
|
-
openDoubleQuote: InputRule;
|
|
1740
|
-
closeDoubleQuote: InputRule;
|
|
1741
|
-
openSingleQuote: InputRule;
|
|
1742
|
-
closeSingleQuote: InputRule;
|
|
1743
|
-
smartQuotes: readonly InputRule[];
|
|
1744
|
-
wrappingInputRule: typeof wrappingInputRule;
|
|
1745
|
-
textblockTypeInputRule: typeof textblockTypeInputRule;
|
|
1746
|
-
keymap: typeof keymap;
|
|
1747
|
-
keydownHandler: typeof keydownHandler;
|
|
1748
|
-
orderedList: NodeSpec;
|
|
1749
|
-
bulletList: NodeSpec;
|
|
1750
|
-
listItem: NodeSpec;
|
|
1751
|
-
addListNodes: typeof addListNodes;
|
|
1752
|
-
wrapInList: typeof wrapInList;
|
|
1753
|
-
splitListItem: typeof splitListItem;
|
|
1754
|
-
liftListItem: typeof liftListItem;
|
|
1755
|
-
sinkListItem: typeof sinkListItem;
|
|
1756
|
-
dropCursor: typeof dropCursor;
|
|
1757
|
-
gapCursor: typeof gapCursor;
|
|
1758
|
-
tableEditing: typeof tableEditing;
|
|
1759
|
-
fixTables: typeof fixTables;
|
|
1760
|
-
fixTablesKey: PluginKey<{
|
|
1761
|
-
fixTables: boolean;
|
|
1762
|
-
}>;
|
|
1763
|
-
cellAround: typeof cellAround;
|
|
1764
|
-
isInTable: typeof isInTable;
|
|
1765
|
-
selectionCell: typeof selectionCell;
|
|
1766
|
-
moveCellForward: typeof moveCellForward;
|
|
1767
|
-
inSameTable: typeof inSameTable;
|
|
1768
|
-
findCell: typeof findCell;
|
|
1769
|
-
colCount: typeof colCount;
|
|
1770
|
-
nextCell: typeof nextCell;
|
|
1771
|
-
removeColSpan: typeof removeColSpan;
|
|
1772
|
-
addColSpan: typeof addColSpan;
|
|
1773
|
-
columnIsHeader: typeof columnIsHeader;
|
|
1774
|
-
tableNodes: typeof tableNodes;
|
|
1775
|
-
tableNodeTypes: typeof tableNodeTypes;
|
|
1776
|
-
CellSelection: typeof CellSelection;
|
|
1777
|
-
TableMap: typeof TableMap;
|
|
1778
|
-
tableEditingKey: PluginKey<number>;
|
|
1779
|
-
columnResizing: typeof columnResizing;
|
|
1780
|
-
columnResizingPluginKey: any;
|
|
1781
|
-
updateColumnsOnResize: typeof updateColumnsOnResize;
|
|
1782
|
-
selectedRect: typeof selectedRect;
|
|
1783
|
-
addColumn: typeof addColumn;
|
|
1784
|
-
addColumnBefore: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
1785
|
-
addColumnAfter: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
1786
|
-
deleteColumn: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
1787
|
-
rowIsHeader: typeof rowIsHeader;
|
|
1788
|
-
addRow: typeof addRow;
|
|
1789
|
-
addRowBefore: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
1790
|
-
addRowAfter: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
1791
|
-
deleteRow: typeof deleteRow;
|
|
1792
|
-
mergeCells: typeof mergeCells;
|
|
1793
|
-
splitCell: typeof splitCell;
|
|
1794
|
-
splitCellWithType: typeof splitCellWithType;
|
|
1795
|
-
setCellAttr: typeof setCellAttr;
|
|
1796
|
-
toggleHeader: typeof toggleHeader;
|
|
1797
|
-
toggleHeaderRow: Command;
|
|
1798
|
-
toggleHeaderColumn: Command;
|
|
1799
|
-
toggleHeaderCell: Command;
|
|
1800
|
-
goToNextCell: typeof goToNextCell;
|
|
1801
|
-
deleteTable: typeof deleteTable;
|
|
1802
|
-
};
|
|
1803
|
-
|
|
1804
|
-
/**
|
|
1805
|
-
* @hidden
|
|
1806
|
-
*/
|
|
1807
|
-
export declare const ProseMirrorTool: DefineComponent< {}, {}, {}, {
|
|
1808
|
-
command(): any;
|
|
1809
|
-
}, {
|
|
1810
|
-
handleClick(): void;
|
|
1811
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1812
|
-
[x: string]: any;
|
|
1813
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1814
|
-
|
|
1815
|
-
/**
|
|
1816
|
-
* @hidden
|
|
1817
|
-
*/
|
|
1818
|
-
export declare const SelectAll: DefineComponent< {}, {}, {}, {}, {
|
|
1819
|
-
handleClick(): void;
|
|
1820
|
-
preventDefault(e: any): void;
|
|
1821
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1822
|
-
[x: string]: any;
|
|
1823
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1824
|
-
|
|
1825
|
-
/**
|
|
1826
|
-
* @hidden
|
|
1827
|
-
*/
|
|
1828
|
-
export declare interface Shortcuts {
|
|
1829
|
-
[key: string]: (state: EditorState, dispatch: (tr: Transaction) => void, view: EditorView) => boolean;
|
|
1830
|
-
}
|
|
1831
|
-
|
|
1832
|
-
declare namespace shortcuts {
|
|
1833
|
-
export {
|
|
1834
|
-
Shortcuts,
|
|
1835
|
-
getShortcuts
|
|
1836
|
-
}
|
|
1837
|
-
}
|
|
1838
|
-
|
|
1839
|
-
/**
|
|
1840
|
-
* @hidden
|
|
1841
|
-
*/
|
|
1842
|
-
declare namespace TableEditNS {
|
|
1843
|
-
/**
|
|
1844
|
-
* @hidden
|
|
1845
|
-
*/
|
|
1846
|
-
interface AddRowBeforeProps extends ToolProps {
|
|
1847
|
-
}
|
|
1848
|
-
/**
|
|
1849
|
-
* @hidden
|
|
1850
|
-
*/
|
|
1851
|
-
interface AddRowAfterProps extends ToolProps {
|
|
1852
|
-
}
|
|
1853
|
-
/**
|
|
1854
|
-
* @hidden
|
|
1855
|
-
*/
|
|
1856
|
-
interface AddColumnBeforeProps extends ToolProps {
|
|
1857
|
-
}
|
|
1858
|
-
/**
|
|
1859
|
-
* @hidden
|
|
1860
|
-
*/
|
|
1861
|
-
interface AddColumnAfterProps extends ToolProps {
|
|
1862
|
-
}
|
|
1863
|
-
/**
|
|
1864
|
-
* @hidden
|
|
1865
|
-
*/
|
|
1866
|
-
interface DeleteRowProps extends ToolProps {
|
|
1867
|
-
}
|
|
1868
|
-
/**
|
|
1869
|
-
* @hidden
|
|
1870
|
-
*/
|
|
1871
|
-
interface DeleteColumnProps extends ToolProps {
|
|
1872
|
-
}
|
|
1873
|
-
/**
|
|
1874
|
-
* @hidden
|
|
1875
|
-
*/
|
|
1876
|
-
interface DeleteTableProps extends ToolProps {
|
|
1877
|
-
}
|
|
1878
|
-
/**
|
|
1879
|
-
* @hidden
|
|
1880
|
-
*/
|
|
1881
|
-
interface MergeCellsProps extends ToolProps {
|
|
1882
|
-
}
|
|
1883
|
-
/**
|
|
1884
|
-
* @hidden
|
|
1885
|
-
*/
|
|
1886
|
-
interface SplitCellProps extends ToolProps {
|
|
1887
|
-
}
|
|
1888
|
-
}
|
|
1889
|
-
|
|
1890
|
-
/**
|
|
1891
|
-
* @hidden
|
|
1892
|
-
*/
|
|
1893
|
-
declare interface ToolProps extends BasicToolProps, ToolRenderProp, ButtonProps {
|
|
1894
|
-
}
|
|
1895
|
-
|
|
1896
|
-
/**
|
|
1897
|
-
* @hidden
|
|
1898
|
-
*/
|
|
1899
|
-
declare interface ToolRenderProp {
|
|
1900
|
-
/**
|
|
1901
|
-
* Fires when a tool is about to be rendered. Used to override the default appearance of the tool.
|
|
1902
|
-
*/
|
|
1903
|
-
settings?: any;
|
|
1904
|
-
}
|
|
1905
|
-
|
|
1906
|
-
/**
|
|
1907
|
-
* @hidden
|
|
1908
|
-
*/
|
|
1909
|
-
export declare const Unlink: DefineComponent< {}, {}, {}, {}, {
|
|
1910
|
-
handleClick(): void;
|
|
1911
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1912
|
-
[x: string]: any;
|
|
1913
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1914
|
-
|
|
1915
|
-
/**
|
|
1916
|
-
* @hidden
|
|
1917
|
-
*/
|
|
1918
|
-
export declare const ViewHtml: DefineComponent< {}, {}, {
|
|
1919
|
-
openedDialog: boolean;
|
|
1920
|
-
}, {}, {
|
|
1921
|
-
toggleDialog(): void;
|
|
1922
|
-
preventDefault(e: any): void;
|
|
1923
|
-
}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {} | {
|
|
1924
|
-
[x: string]: any;
|
|
1925
|
-
}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
|
|
1926
|
-
|
|
1927
|
-
export { }
|
|
8
|
+
import { Editor } from './Editor.js';
|
|
9
|
+
import { EditorProps, EditorMountEvent, EditorPasteEvent, EditorChangeEvent, EditorExecuteEvent, EditorFocusEvent, EditorBlurEvent } from './EditorProps.js';
|
|
10
|
+
import { EditorTools } from './tools/main.js';
|
|
11
|
+
import { EditorToolsSettings } from './config/toolsSettings.js';
|
|
12
|
+
import { EditorUtils } from './utils/main.js';
|
|
13
|
+
import { Selection, SelectionRange, TextSelection, NodeSelection, AllSelection, EditorState, Plugin, PluginKey, Transaction, Decoration, DecorationSet, EditorView, Node, ResolvedPos, NodeRange, Fragment, Slice, ReplaceError, Mark, Schema, NodeType, MarkType, ContentMatch, DOMParser, DOMSerializer, Transform, Step, StepResult, joinPoint, canJoin, canSplit, insertPoint, dropPoint, liftTarget, findWrapping, StepMap, MapResult, Mapping, AddMarkStep, RemoveMarkStep, ReplaceStep, ReplaceAroundStep, replaceStep, wrapIn, setBlockType, toggleMark, autoJoin, chainCommands, history, undoDepth, redoDepth, InputRule, inputRules, wrappingInputRule, textblockTypeInputRule, keymap, keydownHandler, addListNodes, wrapInList, splitListItem, liftListItem, sinkListItem, dropCursor, gapCursor, tableEditing, fixTables, cellAround, isInTable, selectionCell, moveCellForward, inSameTable, findCell, colCount, nextCell, removeColSpan, addColSpan, columnIsHeader, tableNodes, tableNodeTypes, CellSelection, TableMap, columnResizing, updateColumnsOnResize, selectedRect, addColumn, rowIsHeader, addRow, deleteRow, mergeCells, splitCell, splitCellWithType, setCellAttr, toggleHeader, goToNextCell, deleteTable } from '@progress/kendo-editor-common';
|
|
14
|
+
export { type Shortcuts } from './config/shortcuts.js';
|
|
15
|
+
export { type PasteCleanupSettings } from './config/pasteSettings.js';
|
|
16
|
+
/**
|
|
17
|
+
* An object containing the content of ProseMirror packages used at the Editor component.
|
|
18
|
+
*
|
|
19
|
+
* "prosemirror-state",
|
|
20
|
+
* "prosemirror-view",
|
|
21
|
+
* "prosemirror-model",
|
|
22
|
+
* "prosemirror-transform",
|
|
23
|
+
* "prosemirror-commands",
|
|
24
|
+
* "prosemirror-keymap",
|
|
25
|
+
* "prosemirror-tables",
|
|
26
|
+
* "prosemirror-schema-list",
|
|
27
|
+
* "prosemirror-history",
|
|
28
|
+
* "prosemirror-inputrules",
|
|
29
|
+
* "prosemirror-dropcursor",
|
|
30
|
+
* "prosemirror-gapcursor"
|
|
31
|
+
*/
|
|
32
|
+
export declare const ProseMirror: {
|
|
33
|
+
Selection: typeof Selection;
|
|
34
|
+
SelectionRange: typeof SelectionRange;
|
|
35
|
+
TextSelection: typeof TextSelection;
|
|
36
|
+
NodeSelection: typeof NodeSelection;
|
|
37
|
+
AllSelection: typeof AllSelection;
|
|
38
|
+
EditorState: typeof EditorState;
|
|
39
|
+
Plugin: typeof Plugin;
|
|
40
|
+
PluginKey: typeof PluginKey;
|
|
41
|
+
Transaction: typeof Transaction;
|
|
42
|
+
Decoration: typeof Decoration;
|
|
43
|
+
DecorationSet: typeof DecorationSet;
|
|
44
|
+
EditorView: typeof EditorView;
|
|
45
|
+
Node: typeof Node;
|
|
46
|
+
ResolvedPos: typeof ResolvedPos;
|
|
47
|
+
NodeRange: typeof NodeRange;
|
|
48
|
+
Fragment: typeof Fragment;
|
|
49
|
+
Slice: typeof Slice;
|
|
50
|
+
ReplaceError: typeof ReplaceError;
|
|
51
|
+
Mark: typeof Mark;
|
|
52
|
+
Schema: typeof Schema;
|
|
53
|
+
NodeType: typeof NodeType;
|
|
54
|
+
MarkType: typeof MarkType;
|
|
55
|
+
ContentMatch: typeof ContentMatch;
|
|
56
|
+
DOMParser: typeof DOMParser;
|
|
57
|
+
DOMSerializer: typeof DOMSerializer;
|
|
58
|
+
Transform: typeof Transform;
|
|
59
|
+
Step: typeof Step;
|
|
60
|
+
StepResult: typeof StepResult;
|
|
61
|
+
joinPoint: typeof joinPoint;
|
|
62
|
+
canJoin: typeof canJoin;
|
|
63
|
+
canSplit: typeof canSplit;
|
|
64
|
+
insertPoint: typeof insertPoint;
|
|
65
|
+
dropPoint: typeof dropPoint;
|
|
66
|
+
liftTarget: typeof liftTarget;
|
|
67
|
+
findWrapping: typeof findWrapping;
|
|
68
|
+
StepMap: typeof StepMap;
|
|
69
|
+
MapResult: typeof MapResult;
|
|
70
|
+
Mapping: typeof Mapping;
|
|
71
|
+
AddMarkStep: typeof AddMarkStep;
|
|
72
|
+
RemoveMarkStep: typeof RemoveMarkStep;
|
|
73
|
+
ReplaceStep: typeof ReplaceStep;
|
|
74
|
+
ReplaceAroundStep: typeof ReplaceAroundStep;
|
|
75
|
+
replaceStep: typeof replaceStep;
|
|
76
|
+
deleteSelection: import('prosemirror-state').Command;
|
|
77
|
+
joinBackward: import('prosemirror-state').Command;
|
|
78
|
+
selectNodeBackward: import('prosemirror-state').Command;
|
|
79
|
+
joinForward: import('prosemirror-state').Command;
|
|
80
|
+
selectNodeForward: import('prosemirror-state').Command;
|
|
81
|
+
joinUp: import('prosemirror-state').Command;
|
|
82
|
+
joinDown: import('prosemirror-state').Command;
|
|
83
|
+
lift: import('prosemirror-state').Command;
|
|
84
|
+
newlineInCode: import('prosemirror-state').Command;
|
|
85
|
+
exitCode: import('prosemirror-state').Command;
|
|
86
|
+
createParagraphNear: import('prosemirror-state').Command;
|
|
87
|
+
liftEmptyBlock: import('prosemirror-state').Command;
|
|
88
|
+
splitBlock: import('prosemirror-state').Command;
|
|
89
|
+
splitBlockKeepMarks: import('prosemirror-state').Command;
|
|
90
|
+
selectParentNode: import('prosemirror-state').Command;
|
|
91
|
+
selectAll: import('prosemirror-state').Command;
|
|
92
|
+
wrapIn: typeof wrapIn;
|
|
93
|
+
setBlockType: typeof setBlockType;
|
|
94
|
+
toggleMark: typeof toggleMark;
|
|
95
|
+
autoJoin: typeof autoJoin;
|
|
96
|
+
chainCommands: typeof chainCommands;
|
|
97
|
+
pcBaseKeymap: {
|
|
98
|
+
[key: string]: import('prosemirror-state').Command;
|
|
99
|
+
};
|
|
100
|
+
macBaseKeymap: {
|
|
101
|
+
[key: string]: import('prosemirror-state').Command;
|
|
102
|
+
};
|
|
103
|
+
baseKeymap: {
|
|
104
|
+
[key: string]: import('prosemirror-state').Command;
|
|
105
|
+
};
|
|
106
|
+
history: typeof history;
|
|
107
|
+
undo: import('prosemirror-state').Command;
|
|
108
|
+
redo: import('prosemirror-state').Command;
|
|
109
|
+
undoDepth: typeof undoDepth;
|
|
110
|
+
redoDepth: typeof redoDepth;
|
|
111
|
+
InputRule: typeof InputRule;
|
|
112
|
+
inputRules: typeof inputRules;
|
|
113
|
+
undoInputRule: import('prosemirror-state').Command;
|
|
114
|
+
emDash: InputRule;
|
|
115
|
+
ellipsis: InputRule;
|
|
116
|
+
openDoubleQuote: InputRule;
|
|
117
|
+
closeDoubleQuote: InputRule;
|
|
118
|
+
openSingleQuote: InputRule;
|
|
119
|
+
closeSingleQuote: InputRule;
|
|
120
|
+
smartQuotes: readonly InputRule[];
|
|
121
|
+
wrappingInputRule: typeof wrappingInputRule;
|
|
122
|
+
textblockTypeInputRule: typeof textblockTypeInputRule;
|
|
123
|
+
keymap: typeof keymap;
|
|
124
|
+
keydownHandler: typeof keydownHandler;
|
|
125
|
+
orderedList: import('prosemirror-model').NodeSpec;
|
|
126
|
+
bulletList: import('prosemirror-model').NodeSpec;
|
|
127
|
+
listItem: import('prosemirror-model').NodeSpec;
|
|
128
|
+
addListNodes: typeof addListNodes;
|
|
129
|
+
wrapInList: typeof wrapInList;
|
|
130
|
+
splitListItem: typeof splitListItem;
|
|
131
|
+
liftListItem: typeof liftListItem;
|
|
132
|
+
sinkListItem: typeof sinkListItem;
|
|
133
|
+
dropCursor: typeof dropCursor;
|
|
134
|
+
gapCursor: typeof gapCursor;
|
|
135
|
+
tableEditing: typeof tableEditing;
|
|
136
|
+
fixTables: typeof fixTables;
|
|
137
|
+
fixTablesKey: PluginKey<{
|
|
138
|
+
fixTables: boolean;
|
|
139
|
+
}>;
|
|
140
|
+
cellAround: typeof cellAround;
|
|
141
|
+
isInTable: typeof isInTable;
|
|
142
|
+
selectionCell: typeof selectionCell;
|
|
143
|
+
moveCellForward: typeof moveCellForward;
|
|
144
|
+
inSameTable: typeof inSameTable;
|
|
145
|
+
findCell: typeof findCell;
|
|
146
|
+
colCount: typeof colCount;
|
|
147
|
+
nextCell: typeof nextCell;
|
|
148
|
+
removeColSpan: typeof removeColSpan;
|
|
149
|
+
addColSpan: typeof addColSpan;
|
|
150
|
+
columnIsHeader: typeof columnIsHeader;
|
|
151
|
+
tableNodes: typeof tableNodes;
|
|
152
|
+
tableNodeTypes: typeof tableNodeTypes;
|
|
153
|
+
CellSelection: typeof CellSelection;
|
|
154
|
+
TableMap: typeof TableMap;
|
|
155
|
+
tableEditingKey: PluginKey<number>;
|
|
156
|
+
columnResizing: typeof columnResizing;
|
|
157
|
+
columnResizingPluginKey: any;
|
|
158
|
+
updateColumnsOnResize: typeof updateColumnsOnResize;
|
|
159
|
+
selectedRect: typeof selectedRect;
|
|
160
|
+
addColumn: typeof addColumn;
|
|
161
|
+
addColumnBefore: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
162
|
+
addColumnAfter: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
163
|
+
deleteColumn: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
164
|
+
rowIsHeader: typeof rowIsHeader;
|
|
165
|
+
addRow: typeof addRow;
|
|
166
|
+
addRowBefore: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
167
|
+
addRowAfter: (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
|
|
168
|
+
deleteRow: typeof deleteRow;
|
|
169
|
+
mergeCells: typeof mergeCells;
|
|
170
|
+
splitCell: typeof splitCell;
|
|
171
|
+
splitCellWithType: typeof splitCellWithType;
|
|
172
|
+
setCellAttr: typeof setCellAttr;
|
|
173
|
+
toggleHeader: typeof toggleHeader;
|
|
174
|
+
toggleHeaderRow: import('prosemirror-state').Command;
|
|
175
|
+
toggleHeaderColumn: import('prosemirror-state').Command;
|
|
176
|
+
toggleHeaderCell: import('prosemirror-state').Command;
|
|
177
|
+
goToNextCell: typeof goToNextCell;
|
|
178
|
+
deleteTable: typeof deleteTable;
|
|
179
|
+
};
|
|
180
|
+
export { Align } from './tools/align.js';
|
|
181
|
+
export { Indent } from './tools/indent.js';
|
|
182
|
+
export { List } from './tools/lists.js';
|
|
183
|
+
export { Outdent } from './tools/outdent.js';
|
|
184
|
+
export { InlineFormat } from './tools/inlineFormat.js';
|
|
185
|
+
export { FontName } from './tools/fontStyle.js';
|
|
186
|
+
export { FormatBlock } from './tools/formatBlock.js';
|
|
187
|
+
export { ProseMirror as ProseMirrorTool } from './tools/proseMirrorTool.js';
|
|
188
|
+
export { LinkTool } from './tools/insertLink.js';
|
|
189
|
+
export { Unlink } from './tools/unlink.js';
|
|
190
|
+
export { CleanFormatting } from './tools/cleanFormatting.js';
|
|
191
|
+
export { SelectAll } from './tools/selectAll.js';
|
|
192
|
+
export { InsertImage } from './tools/insertImage.js';
|
|
193
|
+
export { InsertTable } from './tools/insertTable/tool.js';
|
|
194
|
+
export { ViewHtml } from './tools/viewHtml.js';
|
|
195
|
+
export { Pdf } from './tools/pdf.js';
|
|
196
|
+
export { Print } from './tools/print.js';
|
|
197
|
+
export { FindAndReplace } from './tools/findReplace.js';
|
|
198
|
+
export { ApplyColor } from './tools/applyColor.js';
|
|
199
|
+
export { Editor, type EditorProps, type EditorMountEvent, type EditorPasteEvent, type EditorChangeEvent, type EditorExecuteEvent, type EditorFocusEvent, type EditorBlurEvent, type EditorTools, EditorToolsSettings, EditorUtils };
|