@ckeditor/ckeditor5-font
Version:
Font feature for CKEditor 5.
49 lines (48 loc) • 1.3 kB
TypeScript
/**
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module font/fontcommand
*/
import { Command, type Editor } from "@ckeditor/ckeditor5-core";
import { type Batch } from "@ckeditor/ckeditor5-engine";
/**
* The base font command.
*/
export declare abstract class FontCommand extends Command {
/**
* When set, it reflects the {@link #attributeKey} value of the selection.
*
* @observable
* @readonly
*/
value: string;
/**
* A model attribute on which this command operates.
*/
readonly attributeKey: string;
/**
* Creates an instance of the command.
*
* @param editor Editor instance.
* @param attributeKey The name of a model attribute on which this command operates.
*/
constructor(editor: Editor, attributeKey: string);
/**
* @inheritDoc
*/
override refresh(): void;
/**
* Executes the command. Applies the `value` of the {@link #attributeKey} to the selection.
* If no `value` is passed, it removes the attribute from the selection.
*
* @param options Options for the executed command.
* @param options.value The value to apply.
* @fires execute
*/
override execute(options?: {
value?: string;
batch?: Batch;
}): void;
}