@progress/kendo-angular-editor/common/commands.d.ts

Kendo UI Editor for Angular

/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { EditorState, Transaction, EditorView } from '@progress/kendo-editor-common';
/**
 * @hidden
 */
export type DispatchFn = (tr: Transaction) => void;
/**
 * @hidden
 */
export type Command = (state: EditorState, dispatch: DispatchFn, view?: EditorView) => boolean | void;
/**
 * @hidden
 */
export type EditorInternalCommand = 'print';
/**
 * The list of the command names that are accepted by the `exec` method.
 */
export type EditorCommand = 'bold' | 'italic' | 'underline' | 'strikethrough' | 'createLink' | 'unlink' | 'insertFile' | 'insertImage' | 'insertOrderedList' | 'insertUnorderedList' | 'insertText' | 'indent' | 'outdent' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'format' | 'fontFamily' | 'fontSize' | 'cleanFormat' | 'setHTML' | 'undo' | 'redo' | 'subscript' | 'superscript' | 'cleanFormatting' | 'foreColor' | 'backColor' | 'insertTable' | 'addColumnBefore' | 'addColumnAfter' | 'addRowBefore' | 'addRowAfter' | 'deleteRow' | 'deleteColumn' | 'mergeCells' | 'splitCell' | 'deleteTable' | 'selectAll' | 'blockquote';
/**
 * The list of the dialog commands that are accepted by the `openDialog` method.
 *
 * The supported dialog commands are:
 * - `createLink`
 * - `viewSource`
 * - `insertFile`
 * - `insertImage`
 * - `tableWizard`
 *
 * ```ts
 * // Opens a `createLink` dialog.
 * editor.openDialog('createLink');
 *
 * // Opens a `viewSource` dialog.
 * editor.openDialog('viewSource');
 * ```
 */
export type DialogCommand = 'createLink' | 'insertFile' | 'insertImage' | 'viewSource';