UNPKG

1.47 kBTypeScriptView Raw
1/**
2 * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4 */
5/**
6 * @module essentials/essentials
7 */
8import { Plugin } from 'ckeditor5/src/core';
9import { Clipboard } from 'ckeditor5/src/clipboard';
10import { Enter, ShiftEnter } from 'ckeditor5/src/enter';
11import { SelectAll } from 'ckeditor5/src/select-all';
12import { Typing } from 'ckeditor5/src/typing';
13import { Undo } from 'ckeditor5/src/undo';
14/**
15 * A plugin including all essential editing features. It represents a set of features that enables similar functionalities
16 * to a `<textarea>` element.
17 *
18 * It includes:
19 *
20 * * {@link module:clipboard/clipboard~Clipboard},
21 * * {@link module:enter/enter~Enter},
22 * * {@link module:select-all/selectall~SelectAll},
23 * * {@link module:enter/shiftenter~ShiftEnter},
24 * * {@link module:typing/typing~Typing},
25 * * {@link module:undo/undo~Undo}.
26 *
27 * This plugin set does not define any block-level containers (such as {@link module:paragraph/paragraph~Paragraph}).
28 * If your editor is supposed to handle block content, make sure to include it.
29 */
30export default class Essentials extends Plugin {
31 /**
32 * @inheritDoc
33 */
34 static get requires(): readonly [typeof Clipboard, typeof Enter, typeof SelectAll, typeof ShiftEnter, typeof Typing, typeof Undo];
35 /**
36 * @inheritDoc
37 */
38 static get pluginName(): 'Essentials';
39}