@ckeditor/ckeditor5-editor-inline 41.4.2 → 42.0.0-alpha.0
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/README.md +7 -1
- package/build/editor-inline.js +1 -1
- package/dist/index.js +272 -237
- package/dist/index.js.map +1 -1
- package/dist/types/inlineeditor.d.ts +3 -49
- package/package.json +2 -2
- package/src/inlineeditor.d.ts +3 -49
- package/src/inlineeditor.js +3 -50
- package/src/inlineeditoruiview.js +1 -1
package/src/inlineeditor.d.ts
CHANGED
@@ -5,34 +5,17 @@
|
|
5
5
|
/**
|
6
6
|
* @module editor-inline/inlineeditor
|
7
7
|
*/
|
8
|
-
import { Editor,
|
9
|
-
import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
|
8
|
+
import { Editor, type EditorConfig } from 'ckeditor5/src/core.js';
|
10
9
|
import InlineEditorUI from './inlineeditorui.js';
|
11
10
|
declare const InlineEditor_base: import("ckeditor5/src/utils.js").Mixed<typeof Editor, import("ckeditor5/src/core.js").ElementApi>;
|
12
11
|
/**
|
13
|
-
* The
|
14
|
-
* It uses an inline editable and a floating toolbar.
|
12
|
+
* The inline editor implementation. It uses an inline editable and a floating toolbar.
|
15
13
|
* See the {@glink examples/builds/inline-editor demo}.
|
16
14
|
*
|
17
15
|
* In order to create a inline editor instance, use the static
|
18
16
|
* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method.
|
19
|
-
*
|
20
|
-
* # Inline editor and inline build
|
21
|
-
*
|
22
|
-
* The inline editor can be used directly from source (if you installed the
|
23
|
-
* [`@ckeditor/ckeditor5-editor-inline`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline) package)
|
24
|
-
* but it is also available in the {@glink installation/getting-started/predefined-builds#inline-editor inline build}.
|
25
|
-
*
|
26
|
-
* {@glink installation/getting-started/predefined-builds Builds}
|
27
|
-
* are ready-to-use editors with plugins bundled in. When using the editor from
|
28
|
-
* source you need to take care of loading all plugins by yourself
|
29
|
-
* (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
|
30
|
-
* Using the editor from source gives much better flexibility and allows easier customization.
|
31
|
-
*
|
32
|
-
* Read more about initializing the editor from source or as a build in
|
33
|
-
* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
|
34
17
|
*/
|
35
|
-
export default class InlineEditor extends InlineEditor_base {
|
18
|
+
export default class InlineEditor extends /* #__PURE__ */ InlineEditor_base {
|
36
19
|
/**
|
37
20
|
* @inheritDoc
|
38
21
|
*/
|
@@ -128,17 +111,6 @@ export default class InlineEditor extends InlineEditor_base {
|
|
128
111
|
* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
|
129
112
|
* customizing plugins, toolbar and more.
|
130
113
|
*
|
131
|
-
* # Using the editor from source
|
132
|
-
*
|
133
|
-
* The code samples listed in the previous sections of this documentation assume that you are using an
|
134
|
-
* {@glink installation/getting-started/predefined-builds editor build} (for example – `@ckeditor/ckeditor5-build-inline`).
|
135
|
-
*
|
136
|
-
* If you want to use the inline editor from source (`@ckeditor/ckeditor5-editor-inline/src/inlineeditor`),
|
137
|
-
* you need to define the list of
|
138
|
-
* {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
|
139
|
-
* {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
|
140
|
-
* source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
|
141
|
-
*
|
142
114
|
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
143
115
|
* or the editor's initial data.
|
144
116
|
*
|
@@ -154,23 +126,5 @@ export default class InlineEditor extends InlineEditor_base {
|
|
154
126
|
* @returns A promise resolved once the editor is ready. The promise resolves with the created editor instance.
|
155
127
|
*/
|
156
128
|
static create(sourceElementOrData: HTMLElement | string, config?: EditorConfig): Promise<InlineEditor>;
|
157
|
-
/**
|
158
|
-
* The {@link module:core/context~Context} class.
|
159
|
-
*
|
160
|
-
* Exposed as static editor field for easier access in editor builds.
|
161
|
-
*/
|
162
|
-
static Context: typeof Context;
|
163
|
-
/**
|
164
|
-
* The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
|
165
|
-
*
|
166
|
-
* Exposed as static editor field for easier access in editor builds.
|
167
|
-
*/
|
168
|
-
static EditorWatchdog: typeof EditorWatchdog;
|
169
|
-
/**
|
170
|
-
* The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
|
171
|
-
*
|
172
|
-
* Exposed as static editor field for easier access in editor builds.
|
173
|
-
*/
|
174
|
-
static ContextWatchdog: typeof ContextWatchdog;
|
175
129
|
}
|
176
130
|
export {};
|
package/src/inlineeditor.js
CHANGED
@@ -5,36 +5,19 @@
|
|
5
5
|
/**
|
6
6
|
* @module editor-inline/inlineeditor
|
7
7
|
*/
|
8
|
-
import { Editor,
|
8
|
+
import { Editor, ElementApiMixin, attachToForm, secureSourceElement } from 'ckeditor5/src/core.js';
|
9
9
|
import { getDataFromElement, CKEditorError } from 'ckeditor5/src/utils.js';
|
10
|
-
import { ContextWatchdog, EditorWatchdog } from 'ckeditor5/src/watchdog.js';
|
11
10
|
import InlineEditorUI from './inlineeditorui.js';
|
12
11
|
import InlineEditorUIView from './inlineeditoruiview.js';
|
13
12
|
import { isElement as _isElement } from 'lodash-es';
|
14
13
|
/**
|
15
|
-
* The
|
16
|
-
* It uses an inline editable and a floating toolbar.
|
14
|
+
* The inline editor implementation. It uses an inline editable and a floating toolbar.
|
17
15
|
* See the {@glink examples/builds/inline-editor demo}.
|
18
16
|
*
|
19
17
|
* In order to create a inline editor instance, use the static
|
20
18
|
* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`} method.
|
21
|
-
*
|
22
|
-
* # Inline editor and inline build
|
23
|
-
*
|
24
|
-
* The inline editor can be used directly from source (if you installed the
|
25
|
-
* [`@ckeditor/ckeditor5-editor-inline`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-inline) package)
|
26
|
-
* but it is also available in the {@glink installation/getting-started/predefined-builds#inline-editor inline build}.
|
27
|
-
*
|
28
|
-
* {@glink installation/getting-started/predefined-builds Builds}
|
29
|
-
* are ready-to-use editors with plugins bundled in. When using the editor from
|
30
|
-
* source you need to take care of loading all plugins by yourself
|
31
|
-
* (through the {@link module:core/editor/editorconfig~EditorConfig#plugins `config.plugins`} option).
|
32
|
-
* Using the editor from source gives much better flexibility and allows easier customization.
|
33
|
-
*
|
34
|
-
* Read more about initializing the editor from source or as a build in
|
35
|
-
* {@link module:editor-inline/inlineeditor~InlineEditor.create `InlineEditor.create()`}.
|
36
19
|
*/
|
37
|
-
class InlineEditor extends ElementApiMixin(Editor) {
|
20
|
+
export default class InlineEditor extends /* #__PURE__ */ ElementApiMixin(Editor) {
|
38
21
|
/**
|
39
22
|
* Creates an instance of the inline editor.
|
40
23
|
*
|
@@ -159,17 +142,6 @@ class InlineEditor extends ElementApiMixin(Editor) {
|
|
159
142
|
* See the {@link module:core/editor/editorconfig~EditorConfig editor configuration documentation} to learn more about
|
160
143
|
* customizing plugins, toolbar and more.
|
161
144
|
*
|
162
|
-
* # Using the editor from source
|
163
|
-
*
|
164
|
-
* The code samples listed in the previous sections of this documentation assume that you are using an
|
165
|
-
* {@glink installation/getting-started/predefined-builds editor build} (for example – `@ckeditor/ckeditor5-build-inline`).
|
166
|
-
*
|
167
|
-
* If you want to use the inline editor from source (`@ckeditor/ckeditor5-editor-inline/src/inlineeditor`),
|
168
|
-
* you need to define the list of
|
169
|
-
* {@link module:core/editor/editorconfig~EditorConfig#plugins plugins to be initialized} and
|
170
|
-
* {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar items}. Read more about using the editor from
|
171
|
-
* source in the {@glink installation/advanced/alternative-setups/integrating-from-source-webpack dedicated guide}.
|
172
|
-
*
|
173
145
|
* @param sourceElementOrData The DOM element that will be the source for the created editor
|
174
146
|
* or the editor's initial data.
|
175
147
|
*
|
@@ -200,25 +172,6 @@ class InlineEditor extends ElementApiMixin(Editor) {
|
|
200
172
|
});
|
201
173
|
}
|
202
174
|
}
|
203
|
-
/**
|
204
|
-
* The {@link module:core/context~Context} class.
|
205
|
-
*
|
206
|
-
* Exposed as static editor field for easier access in editor builds.
|
207
|
-
*/
|
208
|
-
InlineEditor.Context = Context;
|
209
|
-
/**
|
210
|
-
* The {@link module:watchdog/editorwatchdog~EditorWatchdog} class.
|
211
|
-
*
|
212
|
-
* Exposed as static editor field for easier access in editor builds.
|
213
|
-
*/
|
214
|
-
InlineEditor.EditorWatchdog = EditorWatchdog;
|
215
|
-
/**
|
216
|
-
* The {@link module:watchdog/contextwatchdog~ContextWatchdog} class.
|
217
|
-
*
|
218
|
-
* Exposed as static editor field for easier access in editor builds.
|
219
|
-
*/
|
220
|
-
InlineEditor.ContextWatchdog = ContextWatchdog;
|
221
|
-
export default InlineEditor;
|
222
175
|
function getInitialData(sourceElementOrData) {
|
223
176
|
return isElement(sourceElementOrData) ? getDataFromElement(sourceElementOrData) : sourceElementOrData;
|
224
177
|
}
|
@@ -7,7 +7,7 @@
|
|
7
7
|
*/
|
8
8
|
import { BalloonPanelView, EditorUIView, InlineEditableUIView, ToolbarView } from 'ckeditor5/src/ui.js';
|
9
9
|
import { Rect, ResizeObserver, toUnit } from 'ckeditor5/src/utils.js';
|
10
|
-
const toPx = toUnit('px');
|
10
|
+
const toPx = /* #__PURE__ */ toUnit('px');
|
11
11
|
/**
|
12
12
|
* Inline editor UI view. Uses an nline editable and a floating toolbar.
|
13
13
|
*/
|