UNPKG

1.02 kBTypeScriptView Raw
1/**
2 * @license Copyright (c) 2003-2024, 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/legacylistproperties/legacyliststartcommand
7 */
8import { Command } from 'ckeditor5/src/core.js';
9/**
10 * The list start index command. It changes the `listStart` attribute of the selected list items.
11 * It is used by the {@link module:list/legacylistproperties~LegacyListProperties legacy list properties feature}.
12 */
13export default class LegacyListStartCommand extends Command {
14 /**
15 * @inheritDoc
16 */
17 value: number | null;
18 /**
19 * @inheritDoc
20 */
21 refresh(): void;
22 /**
23 * Executes the command.
24 *
25 * @fires execute
26 * @param options.startIndex The list start index.
27 */
28 execute({ startIndex }?: {
29 startIndex?: number;
30 }): void;
31 /**
32 * Checks the command's {@link #value}.
33 *
34 * @returns The current value.
35 */
36 private _getValue;
37}