@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
39 lines (38 loc) • 1.06 kB
TypeScript
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module list/listproperties/liststartcommand
*/
import { Command } from 'ckeditor5/src/core.js';
/**
* The list start index command. It changes the `listStart` attribute of the selected list items,
* letting the user to choose the starting point of an ordered list.
* It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
*/
export default class ListStartCommand extends Command {
/**
* @inheritDoc
*/
value: number | null;
/**
* @inheritDoc
*/
refresh(): void;
/**
* Executes the command.
*
* @fires execute
* @param options.startIndex The list start index.
*/
execute({ startIndex }?: {
startIndex?: number;
}): void;
/**
* Checks the command's {@link #value}.
*
* @returns The current value.
*/
private _getValue;
}