@progress/kendo-vue-editor 11.0.0-develop.1 → 11.0.1-develop.1
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 +15 -52
- package/EditorProps.d.ts +57 -43
- package/NOTICE.txt +17 -17
- package/config/pasteSettings.d.ts +1 -1
- package/config/toolsSettings.d.ts +72 -33
- package/dist/cdn/js/kendo-vue-editor.js +1 -1
- package/index.d.mts +1 -1
- package/index.d.ts +1 -1
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +13 -13
- package/tools/ToolProps.d.ts +2 -2
- package/tools/pdf.d.ts +3 -3
- package/tools/print.d.ts +1 -1
- package/utils/cleanup.d.ts +5 -5
- package/utils/main.d.ts +85 -85
|
@@ -12,31 +12,34 @@ import { PDFExportProps } from '@progress/kendo-vue-pdf';
|
|
|
12
12
|
*/
|
|
13
13
|
export declare namespace EditorToolsSettings {
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Represents the name of an Editor command.
|
|
16
16
|
*/
|
|
17
17
|
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';
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Represents the settings of a toolbar tool.
|
|
20
20
|
*/
|
|
21
21
|
interface ToolSettings {
|
|
22
22
|
/**
|
|
23
|
-
* The props
|
|
23
|
+
* The props that the tool passes to its Button component.
|
|
24
24
|
*/
|
|
25
25
|
props: ButtonProps;
|
|
26
26
|
/**
|
|
27
|
-
* The keys of the messages that
|
|
27
|
+
* The keys of the messages that the tool uses.
|
|
28
28
|
*/
|
|
29
29
|
messages: {
|
|
30
30
|
[key: string]: string;
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
|
-
* The name of the command that
|
|
33
|
+
* The name of the command that the tool uses.
|
|
34
34
|
*/
|
|
35
35
|
commandName?: Command;
|
|
36
|
+
/**
|
|
37
|
+
* The command function that the tool runs.
|
|
38
|
+
*/
|
|
36
39
|
command?: any;
|
|
37
40
|
}
|
|
38
41
|
/**
|
|
39
|
-
*
|
|
42
|
+
* Represents an action of the Align tool.
|
|
40
43
|
*/
|
|
41
44
|
interface AlignAction {
|
|
42
45
|
/**
|
|
@@ -44,7 +47,7 @@ export declare namespace EditorToolsSettings {
|
|
|
44
47
|
*/
|
|
45
48
|
node: string;
|
|
46
49
|
/**
|
|
47
|
-
* The styles that
|
|
50
|
+
* The styles that the tool applies to the target node.
|
|
48
51
|
*/
|
|
49
52
|
style: Array<{
|
|
50
53
|
name: string;
|
|
@@ -56,16 +59,16 @@ export declare namespace EditorToolsSettings {
|
|
|
56
59
|
*/
|
|
57
60
|
interface AlignSettings extends ToolSettings {
|
|
58
61
|
/**
|
|
59
|
-
*
|
|
62
|
+
* The `AlignAction` objects that define the behavior of the Align tool.
|
|
60
63
|
*/
|
|
61
64
|
actions: Array<AlignAction>;
|
|
62
65
|
}
|
|
63
66
|
/**
|
|
64
|
-
*
|
|
67
|
+
* Represents the settings of the Style tool. The Style tool renders a DropDownList.
|
|
65
68
|
*/
|
|
66
69
|
interface StyleDropDownListSettings {
|
|
67
70
|
/**
|
|
68
|
-
* The name of the style
|
|
71
|
+
* The name of the style that the Style tool adds or removes.
|
|
69
72
|
*/
|
|
70
73
|
style: string;
|
|
71
74
|
/**
|
|
@@ -85,12 +88,12 @@ export declare namespace EditorToolsSettings {
|
|
|
85
88
|
style?: {};
|
|
86
89
|
}>;
|
|
87
90
|
/**
|
|
88
|
-
* The name of the command that
|
|
91
|
+
* The name of the command that the Style tool uses.
|
|
89
92
|
*/
|
|
90
93
|
commandName?: Command;
|
|
91
94
|
}
|
|
92
95
|
/**
|
|
93
|
-
*
|
|
96
|
+
* Represents the settings of the FormatBlock tool. The FormatBlock tool renders a DropDownList.
|
|
94
97
|
*/
|
|
95
98
|
interface FormatBlockDropDownListSettings {
|
|
96
99
|
/**
|
|
@@ -110,24 +113,24 @@ export declare namespace EditorToolsSettings {
|
|
|
110
113
|
style?: {};
|
|
111
114
|
}>;
|
|
112
115
|
/**
|
|
113
|
-
* The name of the command that
|
|
116
|
+
* The name of the command that the FormatBlock tool uses.
|
|
114
117
|
*/
|
|
115
118
|
commandName?: Command;
|
|
116
119
|
}
|
|
117
120
|
/**
|
|
118
|
-
*
|
|
121
|
+
* Represents the options for inline formatting.
|
|
119
122
|
*/
|
|
120
123
|
interface InlineFormatOptions {
|
|
121
124
|
/**
|
|
122
|
-
* The mark
|
|
125
|
+
* The mark that the tool applies or removes.
|
|
123
126
|
*/
|
|
124
127
|
mark: string;
|
|
125
128
|
/**
|
|
126
|
-
* The additional marks
|
|
129
|
+
* The additional marks that the tool removes.
|
|
127
130
|
*/
|
|
128
131
|
altMarks?: Array<string>;
|
|
129
132
|
/**
|
|
130
|
-
* An object
|
|
133
|
+
* An object that holds the style that the tool removes.
|
|
131
134
|
*/
|
|
132
135
|
altStyle?: {
|
|
133
136
|
/**
|
|
@@ -135,55 +138,76 @@ export declare namespace EditorToolsSettings {
|
|
|
135
138
|
*/
|
|
136
139
|
name: string;
|
|
137
140
|
/**
|
|
138
|
-
* The regular expression
|
|
141
|
+
* The regular expression that the tool matches against the value of the style.
|
|
139
142
|
*/
|
|
140
143
|
value: RegExp;
|
|
141
144
|
};
|
|
142
145
|
}
|
|
143
146
|
/**
|
|
144
|
-
*
|
|
147
|
+
* Represents the settings of a tool that applies inline formatting.
|
|
145
148
|
*/
|
|
146
149
|
interface InlineFormatSettings extends ToolSettings, InlineFormatOptions {
|
|
147
150
|
}
|
|
148
151
|
/**
|
|
149
|
-
*
|
|
152
|
+
* Represents the settings of the ForeColor and BackColor tools.
|
|
150
153
|
*/
|
|
151
154
|
interface ApplyColorSettings {
|
|
152
155
|
/**
|
|
153
|
-
* The
|
|
156
|
+
* The style that the tool applies, `color` or `background-color`.
|
|
154
157
|
*/
|
|
155
158
|
color: string;
|
|
156
159
|
/**
|
|
157
|
-
* The props of the underlying [Kendo UI for Vue ColorPicker component](
|
|
160
|
+
* The props of the underlying [Kendo UI for Vue ColorPicker component](slug:overview_colorpicker).
|
|
158
161
|
*/
|
|
159
162
|
colorPickerProps: any;
|
|
160
163
|
/**
|
|
161
|
-
* The name of the
|
|
164
|
+
* The name of the command that the tool applies.
|
|
162
165
|
*/
|
|
163
166
|
commandName: string;
|
|
164
167
|
/**
|
|
165
|
-
* The dir of the
|
|
168
|
+
* The `dir` HTML attribute of the ColorPicker.
|
|
166
169
|
*/
|
|
167
170
|
dir?: String;
|
|
168
171
|
/**
|
|
169
|
-
* The
|
|
172
|
+
* The accessible name of the ColorPicker.
|
|
173
|
+
*
|
|
174
|
+
* @remarks
|
|
175
|
+
* This property is related to accessibility.
|
|
170
176
|
*/
|
|
171
177
|
ariaLabel?: String;
|
|
172
178
|
}
|
|
173
179
|
/**
|
|
174
|
-
*
|
|
180
|
+
* Represents an action of the Indent and Outdent tools.
|
|
175
181
|
*/
|
|
176
182
|
interface IndentAction {
|
|
183
|
+
/**
|
|
184
|
+
* The name of the target node.
|
|
185
|
+
*/
|
|
177
186
|
node: string;
|
|
187
|
+
/**
|
|
188
|
+
* The style that the tool changes, for example, `margin-left`.
|
|
189
|
+
*/
|
|
178
190
|
style: string;
|
|
191
|
+
/**
|
|
192
|
+
* The style that the tool changes in right-to-left (RTL) mode.
|
|
193
|
+
*/
|
|
179
194
|
rtlStyle: string;
|
|
195
|
+
/**
|
|
196
|
+
* The amount by which the tool changes the indentation.
|
|
197
|
+
*/
|
|
180
198
|
step: number;
|
|
199
|
+
/**
|
|
200
|
+
* The unit of the `step` value, for example, `em`.
|
|
201
|
+
*/
|
|
181
202
|
unit: string;
|
|
182
203
|
}
|
|
183
204
|
/**
|
|
184
|
-
*
|
|
205
|
+
* Represents the settings of a tool that applies indentation.
|
|
185
206
|
*/
|
|
186
207
|
interface IndentationSettings extends ToolSettings {
|
|
208
|
+
/**
|
|
209
|
+
* The `IndentAction` objects that define the behavior of the tool.
|
|
210
|
+
*/
|
|
187
211
|
actions: Array<IndentAction>;
|
|
188
212
|
/**
|
|
189
213
|
* The list node types of the Indent and Outdent tools.
|
|
@@ -198,13 +222,23 @@ export declare namespace EditorToolsSettings {
|
|
|
198
222
|
* The settings of the Link tool or dialog.
|
|
199
223
|
*/
|
|
200
224
|
interface LinkSettings extends ToolSettings {
|
|
225
|
+
/**
|
|
226
|
+
* The name of the link mark.
|
|
227
|
+
*/
|
|
201
228
|
mark: string;
|
|
229
|
+
/**
|
|
230
|
+
* Sets whether the dialog shows the option to open the link in a new window.
|
|
231
|
+
* To hide the option, set it to `false`.
|
|
232
|
+
*/
|
|
202
233
|
linkTarget?: boolean;
|
|
203
234
|
}
|
|
204
235
|
/**
|
|
205
236
|
* The settings of the Unlink tool.
|
|
206
237
|
*/
|
|
207
238
|
interface UnlinkSettings extends ToolSettings {
|
|
239
|
+
/**
|
|
240
|
+
* The name of the link mark that the tool removes.
|
|
241
|
+
*/
|
|
208
242
|
mark: string;
|
|
209
243
|
}
|
|
210
244
|
/**
|
|
@@ -213,7 +247,7 @@ export declare namespace EditorToolsSettings {
|
|
|
213
247
|
interface InsertFileSettings extends LinkSettings {
|
|
214
248
|
}
|
|
215
249
|
/**
|
|
216
|
-
*
|
|
250
|
+
* Represents the settings of a tool that toggles lists.
|
|
217
251
|
*/
|
|
218
252
|
interface ListSettings extends ToolSettings {
|
|
219
253
|
/**
|
|
@@ -221,7 +255,7 @@ export declare namespace EditorToolsSettings {
|
|
|
221
255
|
*/
|
|
222
256
|
listType: string;
|
|
223
257
|
/**
|
|
224
|
-
* The types of the list nodes that
|
|
258
|
+
* The types of the list nodes that the tool uses.
|
|
225
259
|
*/
|
|
226
260
|
types: {
|
|
227
261
|
orderedList: string;
|
|
@@ -303,6 +337,9 @@ export declare namespace EditorToolsSettings {
|
|
|
303
337
|
* The settings of the InsertImage tool or dialog.
|
|
304
338
|
*/
|
|
305
339
|
interface ImageSettings extends ToolSettings {
|
|
340
|
+
/**
|
|
341
|
+
* The name of the image node.
|
|
342
|
+
*/
|
|
306
343
|
node: string;
|
|
307
344
|
}
|
|
308
345
|
/**
|
|
@@ -344,7 +381,7 @@ export declare namespace EditorToolsSettings {
|
|
|
344
381
|
*/
|
|
345
382
|
const link: LinkSettings;
|
|
346
383
|
/**
|
|
347
|
-
* The object of the
|
|
384
|
+
* The object of the InsertFile tool settings.
|
|
348
385
|
*/
|
|
349
386
|
const insertFile: InsertFileSettings;
|
|
350
387
|
/**
|
|
@@ -392,21 +429,23 @@ export declare namespace EditorToolsSettings {
|
|
|
392
429
|
*/
|
|
393
430
|
const print: PrintSettings;
|
|
394
431
|
/**
|
|
395
|
-
* The object of the
|
|
432
|
+
* The object of the SelectAll tool settings.
|
|
396
433
|
*/
|
|
397
434
|
const selectAll: SelectAllSettings;
|
|
398
435
|
/**
|
|
399
|
-
* The object of the
|
|
436
|
+
* The object of the Pdf tool settings.
|
|
400
437
|
*/
|
|
401
438
|
const pdf: PdfSettings;
|
|
402
439
|
/**
|
|
403
|
-
* The PDF export options.
|
|
440
|
+
* The default PDF export options of the Pdf tool.
|
|
404
441
|
*
|
|
442
|
+
* ```js
|
|
405
443
|
* const savePdfOptions = {
|
|
406
444
|
* fileName: 'editor.pdf',
|
|
407
445
|
* paperSize: 'A4',
|
|
408
446
|
* margin: '1cm'
|
|
409
447
|
* };
|
|
448
|
+
* ```
|
|
410
449
|
*/
|
|
411
450
|
const savePdfOptions: PDFExportProps;
|
|
412
451
|
/**
|