@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
38 lines (37 loc) • 1.25 kB
TypeScript
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
import { Command, type Editor } from 'ckeditor5/src/core';
/**
* The list indent command. It is used by the {@link module:list/list~List list feature}.
*/
export default class IndentCommand extends Command {
/**
* Determines by how much the command will change the list item's indent attribute.
*/
private readonly _indentBy;
/**
* Creates an instance of the command.
*
* @param editor The editor instance.
* @param indentDirection The direction of indent. If it is equal to `backward`, the command will outdent a list item.
*/
constructor(editor: Editor, indentDirection: 'forward' | 'backward');
/**
* @inheritDoc
*/
refresh(): void;
/**
* Indents or outdents (depending on the {@link #constructor}'s `indentDirection` parameter) selected list items.
*
* @fires execute
*/
execute(): void;
/**
* Checks whether the command can be enabled in the current context.
*
* @returns Whether the command should be enabled.
*/
private _checkEnabled;
}