UNPKG

1.51 kBJavaScriptView Raw
1/**
2 * @license Copyright (c) 2003-2022, 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/**
7 * @module list/list
8 */
9
10import ListEditing from './list/listediting';
11import ListUI from './list/listui';
12
13import { Plugin } from 'ckeditor5/src/core';
14
15/**
16 * The list feature.
17 *
18 * This is a "glue" plugin that loads the {@link module:list/list/listediting~ListEditing list editing feature}
19 * and {@link module:list/list/listui~ListUI list UI feature}.
20 *
21 * @extends module:core/plugin~Plugin
22 */
23export default class List extends Plugin {
24 /**
25 * @inheritDoc
26 */
27 static get requires() {
28 return [ ListEditing, ListUI ];
29 }
30
31 /**
32 * @inheritDoc
33 */
34 static get pluginName() {
35 return 'List';
36 }
37}
38
39/**
40 * The configuration of the {@link module:list/list~List list} feature
41 * and the {@link module:list/documentlist~DocumentList document list} feature.
42 *
43 * ClassicEditor
44 * .create( editorElement, {
45 * list: ... // The list feature configuration.
46 * } )
47 * .then( ... )
48 * .catch( ... );
49 *
50 * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
51 *
52 * @interface ListConfig
53 */
54
55/**
56 * The configuration of the {@link module:list/list~List} feature and the {@link module:list/documentlist~DocumentList} feature.
57 *
58 * Read more in {@link module:list/list~ListConfig}.
59 *
60 * @member {module:module:list/list~ListConfig} module:core/editor/editorconfig~EditorConfig#list
61 */