UNPKG

899 BTypeScriptView Raw
1import { Command, Editor } from '@ckeditor/ckeditor5-core';
2
3/**
4 * The list command. It is used by the {@link module:list/list~List list feature}.
5 */
6export default class ListCommand extends Command {
7 /**
8 * Creates an instance of the command.
9 */
10 constructor(editor: Editor, type: 'numbered' | 'bulleted');
11
12 /**
13 * The type of the list created by the command.
14 */
15 readonly type: 'numbered' | 'bulleted';
16
17 /**
18 * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
19 */
20 get value(): boolean;
21 protected set value(value: boolean);
22
23 /**
24 * Executes the list command.
25 */
26 execute(options?: { forceValue?: boolean | undefined }): void;
27}
28
29declare module '@ckeditor/ckeditor5-core/src/commandcollection' {
30 interface Commands {
31 ListCommand: ListCommand;
32 }
33}