@ckeditor/ckeditor5-ckbox
Version:
CKBox integration for CKEditor 5.
58 lines (57 loc) • 2.02 kB
JavaScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module ckbox/ckboximageedit/ckboximageeditui
*/
import { Plugin } from 'ckeditor5/src/core.js';
import { ButtonView } from 'ckeditor5/src/ui.js';
import { IconCkboxImageEdit } from 'ckeditor5/src/icons.js';
/**
* The UI plugin of the CKBox image edit feature.
*
* It registers the `'ckboxImageEdit'` UI button in the editor's {@link module:ui/componentfactory~ComponentFactory component factory}
* that allows you to open the CKBox dialog and edit the image.
*/
export default class CKBoxImageEditUI extends Plugin {
/**
* @inheritDoc
*/
static get pluginName() {
return 'CKBoxImageEditUI';
}
/**
* @inheritDoc
*/
static get isOfficialPlugin() {
return true;
}
/**
* @inheritDoc
*/
init() {
const editor = this.editor;
editor.ui.componentFactory.add('ckboxImageEdit', locale => {
const command = editor.commands.get('ckboxImageEdit');
const uploadImageCommand = editor.commands.get('uploadImage');
const view = new ButtonView(locale);
const t = locale.t;
view.set({
icon: IconCkboxImageEdit,
tooltip: true
});
view.bind('label').to(uploadImageCommand, 'isAccessAllowed', isAccessAllowed => isAccessAllowed ?
t('Edit image') :
t('You have no image editing permissions.'));
view.bind('isOn').to(command, 'value', command, 'isEnabled', (value, isEnabled) => value && isEnabled);
view.bind('isEnabled').to(command);
// Execute the command.
this.listenTo(view, 'execute', () => {
editor.execute('ckboxImageEdit');
editor.editing.view.focus();
});
return view;
});
}
}