@ckeditor/ckeditor5-image
Version:
Image feature for CKEditor 5.
35 lines (34 loc) • 996 B
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
*/
/**
* @module image/imagetextalternative/imagetextalternativecommand
*/
import { Command } from 'ckeditor5/src/core';
/**
* The image text alternative command. It is used to change the `alt` attribute of `<imageBlock>` and `<imageInline>` model elements.
*/
export default class ImageTextAlternativeCommand extends Command {
/**
* The command value: `false` if there is no `alt` attribute, otherwise the value of the `alt` attribute.
*
* @readonly
* @observable
*/
value: string | false;
/**
* @inheritDoc
*/
refresh(): void;
/**
* Executes the command.
*
* @fires execute
* @param options
* @param options.newValue The new value of the `alt` attribute to set.
*/
execute(options: {
newValue: string;
}): void;
}