@ckeditor/ckeditor5-link
Version:
Link feature for CKEditor 5.
75 lines (74 loc) • 3.18 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 link/utils/manualdecorator
*/
import { ObservableMixin } from 'ckeditor5/src/utils.js';
/**
* Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~ManualDecorator#value}
* to support integration with the UI state. An instance of this class is a model with the state of individual manual decorators.
* These decorators are kept as collections in {@link module:link/linkcommand~LinkCommand#manualDecorators}.
*/
export default class ManualDecorator extends /* #__PURE__ */ ObservableMixin() {
/**
* An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
*/
id;
/**
* The default value of manual decorator.
*/
defaultValue;
/**
* The label used in the user interface to toggle the manual decorator.
*/
label;
/**
* A set of attributes added to downcasted data when the decorator is activated for a specific link.
* Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
*/
attributes;
/**
* A set of classes added to downcasted data when the decorator is activated for a specific link.
* Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
*/
classes;
/**
* A set of styles added to downcasted data when the decorator is activated for a specific link.
* Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
*/
styles;
/**
* Creates a new instance of {@link module:link/utils/manualdecorator~ManualDecorator}.
*
* @param config.id The name of the attribute used in the model that represents a given manual decorator.
* For example: `'linkIsExternal'`.
* @param config.label The label used in the user interface to toggle the manual decorator.
* @param config.attributes A set of attributes added to output data when the decorator is active for a specific link.
* Attributes should keep the format of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
* @param [config.defaultValue] Controls whether the decorator is "on" by default.
*/
constructor({ id, label, attributes, classes, styles, defaultValue }) {
super();
this.id = id;
this.set('value', undefined);
this.defaultValue = defaultValue;
this.label = label;
this.attributes = attributes;
this.classes = classes;
this.styles = styles;
}
/**
* Returns {@link module:engine/view/matcher~MatcherPattern} with decorator attributes.
*
* @internal
*/
_createPattern() {
return {
attributes: this.attributes,
classes: this.classes,
styles: this.styles
};
}
}