@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 CHANGED
@@ -429,58 +429,10 @@ export declare const allTools: {
429
429
  };
430
430
  };
431
431
  /**
432
- * Represents the [Kendo UI for Vue Editor component]({% slug overview_editor %}).
432
+ * Represents the [KendoVue Editor component](slug:overview_editor).
433
433
  *
434
- * ```jsx
435
- * <template>
436
- * <div>
437
- * <Editor
438
- * :tools="tools"
439
- * :content-style="{
440
- * height: '690px',
441
- * }"
442
- * :default-content="content"
443
- * />
444
- * </div>
445
- * </template>
446
- *
447
- * <script>
448
- * import { Editor } from "@progress/kendo-vue-editor";
449
- * import content from "./content-overview";
450
- *
451
- * export default {
452
- * components: {
453
- * Editor,
454
- * },
455
- * data() {
456
- * return {
457
- * tools: [
458
- * ["Bold", "Italic", "Underline", "Strikethrough"],
459
- * ["Subscript", "Superscript"],
460
- * ["AlignLeft", "AlignCenter", "AlignRight", "AlignJustify"],
461
- * ["Indent", "Outdent"],
462
- * ["OrderedList", "UnorderedList"],
463
- * "FontSize",
464
- * "FontName",
465
- * "FormatBlock",
466
- * ["Undo", "Redo"],
467
- * ["Link", "Unlink", "InsertImage", "ViewHtml"],
468
- * ["InsertTable"],
469
- * ["AddRowBefore", "AddRowAfter", "AddColumnBefore", "AddColumnAfter"],
470
- * ["DeleteRow", "DeleteColumn", "DeleteTable"],
471
- * ["MergeCells", "SplitCell"],
472
- * ],
473
- * content: content,
474
- * };
475
- * },
476
- * };
477
- * </script>
478
- * ```
479
- *
480
- *
481
- *
482
- * ### props <span class='code'>Readonly&lt;[EditorProps]({% slug api_editor_editorprops %})</span>
483
- * The props of the Editor component.
434
+ * ### props <span class='code'>Readonly&lt;[EditorProps](slug:api_editor_editorprops)</span>
435
+ * The props of the Editor.
484
436
  *
485
437
  * ### contentElement <span class='code'>HTMLDivElement</span>
486
438
  * Returns the content-editable DOM element of the Editor.
@@ -489,10 +441,21 @@ export declare const allTools: {
489
441
  * Returns the DOM element of the Editor.
490
442
  *
491
443
  * ### value <span class='code'>Node | string</span>
492
- * The value of the Editor.
444
+ * Returns the value of the Editor.
493
445
  *
494
446
  * ### view <span class='code'>EditorView&lt;any&gt;</span>
495
447
  * Returns the `view` object of the Editor.
448
+ *
449
+ * @example
450
+ * ```vue
451
+ * <Editor
452
+ * :tools="[['Bold', 'Italic', 'Underline'], ['Undo', 'Redo']]"
453
+ * :content-style="{ height: '300px' }"
454
+ * :default-content="'<p>Order #10248 ships today.</p>'"
455
+ * :default-edit-mode="'div'"
456
+ * :resizable="true"
457
+ * />
458
+ * ```
496
459
  */
497
460
  declare const Editor: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
498
461
  defaultContent: PropType<string>;
package/EditorProps.d.ts CHANGED
@@ -9,36 +9,36 @@ import { EditorState, Plugin, Transaction, EditorView, Schema, Node } from '@pro
9
9
  import { EditorUtils } from './utils/main';
10
10
  interface EditorEvent {
11
11
  /**
12
- * An event target.
12
+ * The target of the event.
13
13
  */
14
14
  target: any;
15
15
  }
16
16
  /**
17
- * Represents the object of the `onChange` Editor event.
17
+ * Represents the object of the `change` event of the Editor.
18
18
  */
19
19
  export interface EditorChangeEvent extends EditorEvent {
20
20
  /**
21
- * Represents the [Editor document](https://prosemirror.net/docs/guide/#doc).
21
+ * The [Editor document](https://prosemirror.net/docs/guide/#doc).
22
22
  */
23
23
  value: Node;
24
24
  /**
25
- * A getter of the Editor HTML content.
26
- * Once called, it will convert the Editor document into HTML string.
27
- * Note that, since onChange event is triggered on every key while typing,
28
- * this conversion may not be suitable if the Editor is dealing with large amount of content.
25
+ * A getter that returns the HTML content of the Editor.
26
+ * When you call it, it converts the Editor document into an HTML string.
27
+ * The `change` event fires on every key press while you type,
28
+ * so this conversion can be slow when the Editor holds a large amount of content.
29
29
  */
30
30
  html: string;
31
31
  /**
32
- * The Editor Schema object.
32
+ * The `Schema` object of the Editor.
33
33
  */
34
34
  schema: Schema;
35
35
  /**
36
- * The Transaction which causes the change.
36
+ * The `Transaction` that causes the change.
37
37
  */
38
38
  transaction: Transaction;
39
39
  }
40
40
  /**
41
- * Represents the object of the `onMount` Editor event.
41
+ * Represents the object of the `loaded` event of the Editor.
42
42
  */
43
43
  export interface EditorMountEvent extends EditorEvent {
44
44
  /**
@@ -46,7 +46,7 @@ export interface EditorMountEvent extends EditorEvent {
46
46
  */
47
47
  dom: HTMLDivElement;
48
48
  /**
49
- * The default plugins collection of the Editor.
49
+ * The default plugins of the Editor.
50
50
  */
51
51
  plugins: Array<Plugin>;
52
52
  /**
@@ -62,11 +62,11 @@ export interface EditorMountEvent extends EditorEvent {
62
62
  };
63
63
  }
64
64
  /**
65
- * Represents the object of the `onPaste` Editor event.
65
+ * Represents the object that the `pasteHtml` function of the Editor receives.
66
66
  */
67
67
  export interface EditorPasteEvent extends EditorEvent {
68
68
  /**
69
- * The HTML that will be pasted in the Editor.
69
+ * The HTML that the Editor is about to paste.
70
70
  */
71
71
  pastedHtml: string;
72
72
  /**
@@ -75,11 +75,11 @@ export interface EditorPasteEvent extends EditorEvent {
75
75
  event: ClipboardEvent;
76
76
  }
77
77
  /**
78
- * Represents the object of the `onExecute` Editor event.
78
+ * Represents the object of the `execute` event of the Editor.
79
79
  */
80
80
  export interface EditorExecuteEvent extends EditorEvent {
81
81
  /**
82
- * The transaction that will be executed.
82
+ * The transaction that the Editor is about to execute.
83
83
  */
84
84
  transaction: Transaction;
85
85
  /**
@@ -88,7 +88,7 @@ export interface EditorExecuteEvent extends EditorEvent {
88
88
  state: EditorState;
89
89
  }
90
90
  /**
91
- * Represents the object of the `onFocus` Editor event.
91
+ * Represents the object of the `focus` event of the Editor.
92
92
  */
93
93
  export interface EditorFocusEvent extends EditorEvent {
94
94
  /**
@@ -97,7 +97,7 @@ export interface EditorFocusEvent extends EditorEvent {
97
97
  event: FocusEvent;
98
98
  }
99
99
  /**
100
- * Represents the object of the `onBlur` Editor event.
100
+ * Represents the object of the `blur` event of the Editor.
101
101
  */
102
102
  export interface EditorBlurEvent extends EditorEvent {
103
103
  /**
@@ -106,27 +106,29 @@ export interface EditorBlurEvent extends EditorEvent {
106
106
  event: FocusEvent;
107
107
  }
108
108
  /**
109
- * Represents the props of the [Kendo UI for Vue Editor component]({% slug overview_editor %}).
109
+ * Represents the props of the [KendoVue Editor component](slug:overview_editor).
110
110
  */
111
111
  export interface EditorProps {
112
112
  /**
113
- * Sets the default HTML content of the Editor.
113
+ * Sets the initial HTML content of the Editor.
114
114
  */
115
115
  defaultContent?: string;
116
116
  /**
117
- * Sets the initial edit mode of the Editor. Defaults to `iframe`.
117
+ * Sets the initial edit mode of the Editor.
118
+ *
119
+ * @default `'iframe'`
118
120
  */
119
121
  defaultEditMode?: 'iframe' | 'div' | string;
120
122
  /**
121
- * Sets styles to the content element wrapper of the Editor.
123
+ * Sets the styles of the content element wrapper of the Editor.
122
124
  */
123
125
  contentStyle?: object;
124
126
  /**
125
- * Represents the `dir` HTML attribute.
127
+ * Sets the `dir` HTML attribute of the Editor.
126
128
  */
127
129
  dir?: string;
128
130
  /**
129
- * Specifies if the Editor will be resizable.
131
+ * Sets whether you can resize the Editor.
130
132
  */
131
133
  resizable?: boolean;
132
134
  /**
@@ -134,20 +136,20 @@ export interface EditorProps {
134
136
  */
135
137
  tools?: Array<any>;
136
138
  /**
137
- * A funciton that fires each time the Editor is about to insert pasted content.
138
- * Useful for modifying pasted content.
139
+ * Sets a function that runs each time the Editor is about to insert pasted content.
140
+ * Use it to change the pasted content.
139
141
  */
140
142
  pasteHtml?: (event: EditorPasteEvent) => string | void;
141
143
  /**
142
- * Fires each time the Editor is about to mount.
143
- * Useful for configuring the `EditorView` object.
144
- * To initialize `EditorView`, use the properties of the `event` object.
144
+ * Sets a function that runs each time the Editor is about to mount.
145
+ * Use it to configure the `EditorView` object.
146
+ * To create the `EditorView`, use the properties of the `event` object.
145
147
  */
146
148
  extendView?: (event: EditorMountEvent) => EditorView | void;
147
149
  /**
148
150
  * Fires each time the Editor is about to mount.
149
- * Useful for configuring the `EditorView` object.
150
- * To initialize `EditorView`, use the properties of the `event` object.
151
+ * Use it to configure the `EditorView` object.
152
+ * To create the `EditorView`, use the properties of the `event` object.
151
153
  */
152
154
  onLoaded?: (event: EditorMountEvent) => EditorView | void;
153
155
  /**
@@ -156,11 +158,11 @@ export interface EditorProps {
156
158
  */
157
159
  onExecute?: (event: EditorExecuteEvent) => boolean | void;
158
160
  /**
159
- * Fires when the Editor's content element has received focus.
161
+ * Fires when the content element of the Editor receives focus.
160
162
  */
161
163
  onFocus?: (event: EditorFocusEvent) => void;
162
164
  /**
163
- * Fires when the Editor's content element has lost focus.
165
+ * Fires when the content element of the Editor loses focus.
164
166
  */
165
167
  onBlur?: (event: EditorBlurEvent) => void;
166
168
  /**
@@ -168,33 +170,45 @@ export interface EditorProps {
168
170
  */
169
171
  onChange?: (event: EditorChangeEvent) => void;
170
172
  /**
171
- * The value of the Editor.
173
+ * Sets the value of the Editor.
172
174
  */
173
175
  value?: Node | string;
174
176
  /**
175
- * If set to `false`, it will turn off the built-in keyboard navigation of the Editor's Toolbar.
177
+ * Turns the built-in keyboard navigation of the Editor toolbar on or off.
178
+ * To turn it off, set it to `false`.
179
+ *
180
+ * @default `true`
176
181
  */
177
182
  keyboardNavigation?: boolean;
178
183
  /**
179
- * Defines the options that will be used for parsing the HTML.
180
- * If `false` is set, the whitespace is collapsed as per HTML's rules.
181
- * Pass `true` to preserve whitespace, but normalize newlines to spaces.
182
- * `full` will preserve whitespace entirely.
184
+ * Sets how the Editor handles whitespace when it parses HTML.
185
+ * When you set it to `false`, the Editor collapses whitespace by the HTML rules.
186
+ * When you set it to `true`, the Editor keeps whitespace but turns newlines into spaces.
187
+ * When you set it to `full`, the Editor keeps all whitespace.
183
188
  *
184
- * Defaults to `full`.
189
+ * @default `'full'`
185
190
  */
186
191
  preserveWhitespace?: boolean | 'full' | string;
187
192
  /**
188
- * Identifies the element(s) which will describe the component, similar
189
- * to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
193
+ * Sets the `id` of one or more elements that describe the Editor, similar
194
+ * to the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
195
+ *
196
+ * @remarks
197
+ * This property is related to accessibility.
190
198
  */
191
199
  ariaDescribedBy?: string;
192
200
  /**
193
- * Identifies the element(s) which will label the component.
201
+ * Sets the `id` of one or more elements that label the Editor.
202
+ *
203
+ * @remarks
204
+ * This property is related to accessibility.
194
205
  */
195
206
  ariaLabelledBy?: string;
196
207
  /**
197
- * The accessible label of the component.
208
+ * Sets the accessible label of the Editor.
209
+ *
210
+ * @remarks
211
+ * This property is related to accessibility.
198
212
  */
199
213
  ariaLabel?: string;
200
214
  }
package/NOTICE.txt CHANGED
@@ -1,18 +1,18 @@
1
1
 
2
- Progress Kendo UI for Vue 2026 Updated August 2026
2
+ Progress Kendo UI for Vue 2026 Updated November 2026
3
3
 
4
4
  ----------------------------------------------------------------------------------------------------------------------------
5
5
  NOTICES REPORT
6
6
  ----------------------------------------------------------------------------------------------------------------------------
7
7
 
8
8
  Portions of the Products include certain open source and commercial third-party components listed below ("Third-Party
9
- Components"). The authors of the Third-Party Components require Progress Software Corporation ("PSC") to include the
10
- following notices and additional licensing terms as a condition of PSC's use of such Third-Party Components. You
11
- acknowledge that the authors of the Third-Party Components have no obligation to provide support to you for the Third-Party
12
- Components or the Product. You hereby undertake to comply with all licenses related to the applicable Third-Party
9
+ Components"). The authors of the Third-Party Components require Progress Software Corporation ("PSC") to include
10
+ the following notices and additional licensing terms as a condition of PSC's use of such Third-Party Components. You
11
+ acknowledge that the authors of the Third-Party Components have no obligation to provide support to you for the Third-
12
+ Party Components or the Product. You hereby undertake to comply with all licenses related to the applicable Third-Party
13
13
  Components. Notwithstanding anything to the contrary, to the extent that any of the terms and conditions of the Progress
14
- Agreement conflict, vary, or are in addition to the terms and conditions of the aforementioned third-party licenses for these
15
- technologies, such terms and conditions are offered by PSC alone and not by any other party.
14
+ Agreement conflict, vary, or are in addition to the terms and conditions of the aforementioned third-party licenses for
15
+ these technologies, such terms and conditions are offered by PSC alone and not by any other party.
16
16
 
17
17
  ----------------------------------------------------------------------------------------------------------------------------
18
18
  Report Content
@@ -28,8 +28,8 @@
28
28
  GENERATIVE ARTIFICIAL INTELLIGENCE INTEGRATION
29
29
  If the Software documentation specifies integration with some form of generative artificial intelligence (AI), then the
30
30
  Software will include a configuration to connect to AI. You acknowledge that a separate license or subscription access
31
- to AI governed by the terms and conditions of a license agreement from AI licensor will be required for use and access of
32
- AI capabilities integrated with the Software. You will be responsible to comply with the terms of such license agreement
31
+ to AI governed by the terms and conditions of a license agreement from AI licensor will be required for use and access
32
+ of AI capabilities integrated with the Software. You will be responsible to comply with the terms of such license agreement
33
33
  for a valid use of AI. You acknowledge and accept that Progress is not a party to the license agreement between You
34
34
  and AI licensor for AI use, and as a result Progress does not have any control over AI and its availability, and Progress
35
35
  disclaims any and all liabilities for any output, error, damages, loss, etc., or any other result of Your use of AI
@@ -37,8 +37,8 @@
37
37
 
38
38
  ----------------------------------------------------------------------------------------------------------------------------
39
39
 
40
- NOTICE FROM PROGRESS SOFTWARE CORPORATION: Additional notices may be included in the release notes or other
41
- documentation that accompanies updates received in connection with support of the Product.
40
+ NOTICE FROM PROGRESS SOFTWARE CORPORATION: Additional notices may be included in the release notes or
41
+ other documentation that accompanies updates received in connection with support of the Product.
42
42
 
43
43
  ----------------------------------------------------------------------------------------------------------------------------
44
44
 
@@ -52,9 +52,9 @@ Components:
52
52
  | | readme | |
53
53
  | @progress/pako-esm 1.0.1 | https://github.com/telerik/pako-esm#r | MIT License |
54
54
  | | eadme | |
55
- | prosemirror-commands 1.7.1 | https://github.com/prosemirror/prosem | MIT License |
55
+ | prosemirror-commands 1.7.2 | https://github.com/prosemirror/prosem | MIT License |
56
56
  | | irror-commands#readme | |
57
- | prosemirror-dropcursor 1.8.2 | https://github.com/prosemirror/prosem | MIT License |
57
+ | prosemirror-dropcursor 1.8.3 | https://github.com/prosemirror/prosem | MIT License |
58
58
  | | irror-dropcursor#readme | |
59
59
  | prosemirror-gapcursor 1.4.1 | https://github.com/prosemirror/prosem | MIT License |
60
60
  | | irror-gapcursor#readme | |
@@ -64,7 +64,7 @@ Components:
64
64
  | | irror-inputrules#readme | |
65
65
  | prosemirror-keymap 1.2.3 | https://github.com/prosemirror/prosem | MIT License |
66
66
  | | irror-keymap#readme | |
67
- | prosemirror-model 1.25.9 | https://github.com/prosemirror/prosem | MIT License |
67
+ | prosemirror-model 1.25.12 | https://github.com/prosemirror/prosem | MIT License |
68
68
  | | irror-model#readme | |
69
69
  | prosemirror-schema-list 1.5.1 | https://github.com/prosemirror/prosem | MIT License |
70
70
  | | irror-schema-list#readme | |
@@ -72,9 +72,9 @@ Components:
72
72
  | | irror-state#readme | |
73
73
  | prosemirror-tables 1.8.5 | https://github.com/prosemirror/prosem | MIT License |
74
74
  | | irror-tables#readme | |
75
- | prosemirror-transform 1.10.5 | https://github.com/prosemirror/prosem | MIT License |
75
+ | prosemirror-transform 1.12.1 | https://github.com/prosemirror/prosem | MIT License |
76
76
  | | irror-transform#readme | |
77
- | prosemirror-view 1.41.6 | https://github.com/prosemirror/prosem | MIT License |
77
+ | prosemirror-view 1.42.5 | https://github.com/prosemirror/prosem | MIT License |
78
78
  | | irror-view#readme | |
79
79
  | -------------------------------------- | ------------------------------------- | ---------------------------------------- |
80
80
 
@@ -269,7 +269,7 @@ third-party archives.
269
269
  ---
270
270
 
271
271
  MIT License
272
- (@progress/jszip-esm 1.0.4, @progress/pako-esm 1.0.1, prosemirror-commands 1.7.1, prosemirror-dropcursor 1.8.2, prosemirror-gapcursor 1.4.1, prosemirror-history 1.5.0, prosemirror-inputrules 1.5.1, prosemirror-keymap 1.2.3, prosemirror-model 1.25.9, prosemirror-schema-list 1.5.1, prosemirror-state 1.4.4, prosemirror-tables 1.8.5, prosemirror-transform 1.10.5, prosemirror-view 1.41.6)
272
+ (@progress/jszip-esm 1.0.4, @progress/pako-esm 1.0.1, prosemirror-commands 1.7.2, prosemirror-dropcursor 1.8.3, prosemirror-gapcursor 1.4.1, prosemirror-history 1.5.0, prosemirror-inputrules 1.5.1, prosemirror-keymap 1.2.3, prosemirror-model 1.25.12, prosemirror-schema-list 1.5.1, prosemirror-state 1.4.4, prosemirror-tables 1.8.5, prosemirror-transform 1.12.1, prosemirror-view 1.42.5)
273
273
 
274
274
  The MIT License
275
275
  ===============
@@ -7,7 +7,7 @@
7
7
  */
8
8
  import { PasteCleanupSettings as PasteSettings } from '@progress/kendo-editor-common';
9
9
  /**
10
- * The settings passed to `pasteCleanup` function ([see example]({% slug paste_editor %})).
10
+ * Represents the settings that you pass to the `pasteCleanup` function ([see example](slug:paste_editor)).
11
11
  */
12
12
  export interface PasteCleanupSettings extends PasteSettings {
13
13
  }