| 1 | import Editor from './editor';
|
| 2 | import EditorUI from './editorui';
|
| 3 |
|
| 4 | /**
|
| 5 | * Interface defining a type of {@link module:core/editor/editor~Editor editor} which has a UI.
|
| 6 | *
|
| 7 | * Most editors (like {@link module:editor-classic/classiceditor~ClassicEditor} or
|
| 8 | * {@link module:editor-inline/inlineeditor~InlineEditor}) implement this interface, however, it is not required to do so.
|
| 9 | *
|
| 10 | * Editors with an external UI (i.e. Bootstrap-based) or a headless editor may not implement this interface.
|
| 11 | * When developing editor features you can consider this by splitting them into two parts: the "editing" part,
|
| 12 | * which bases on {@link module:core/editor/editor~Editor} itself, and the UI part which bases on this interface.
|
| 13 | * This will make your features compatible with more types of editors.
|
| 14 | */
|
| 15 | export interface EditorWithUI extends Editor {
|
| 16 | readonly ui: EditorUI;
|
| 17 | }
|