UNPKG

1.09 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 list/documentlistproperties/documentliststartcommand
7 */
8import { Command } from 'ckeditor5/src/core';
9/**
10 * The list start index command. It changes the `listStart` attribute of the selected list items,
11 * letting the user to choose the starting point of an ordered list.
12 * It is used by the {@link module:list/documentlistproperties~DocumentListProperties list properties feature}.
13 */
14export default class DocumentListStartCommand extends Command {
15 /**
16 * @inheritDoc
17 */
18 value: number | null;
19 /**
20 * @inheritDoc
21 */
22 refresh(): void;
23 /**
24 * Executes the command.
25 *
26 * @fires execute
27 * @param options.startIndex The list start index.
28 */
29 execute({ startIndex }?: {
30 startIndex?: number;
31 }): void;
32 /**
33 * Checks the command's {@link #value}.
34 *
35 * @returns The current value.
36 */
37 private _getValue;
38}