UNPKG

1.05 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/listproperties/listreversedcommand
7 */
8import { Command } from 'ckeditor5/src/core';
9/**
10 * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
11 * reversed.
12 * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13 */
14export default class ListReversedCommand extends Command {
15 /**
16 * @inheritDoc
17 */
18 value: boolean | null;
19 /**
20 * @inheritDoc
21 */
22 refresh(): void;
23 /**
24 * Executes the command.
25 *
26 * @fires execute
27 * @param options.reversed Whether the list should be reversed.
28 */
29 execute(options?: {
30 reversed?: boolean;
31 }): void;
32 /**
33 * Checks the command's {@link #value}.
34 *
35 * @returns The current value.
36 */
37 private _getValue;
38}