StyleUI (style)
@ckeditor/ckeditor5-style/src/styleui
The UI plugin of the style feature .
It registers the 'style' UI dropdown in the editor's component factory
that displays a grid of styles and allows changing styles of the content.
Filtering
Properties
-
The editor instance.
Note that most editors implement the
uiproperty. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not have this property or throw an error when accessing it.Because of above, to make plugins more universal, it is recommended to split features into:
-
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.
Plugin can be simply disabled like that:
// Disable the plugin so that no toolbars are visible. editor.plugins.get( 'TextTransformation' ).isEnabled = false;You can also use
forceDisabledmethod.
Static properties
Methods
-
-
Binds observable properties to other objects implementing the
Observableinterface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
buttonand an associatedcommand(bothObservable).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );or even shorter:
button.bind( 'isEnabled' ).to( command );which works in the following way:
button.isEnabledinstantly equalscommand.isEnabled,- whenever
command.isEnabledchanges,button.isEnabledwill immediately reflect its value.
Note: To release the binding, use
unbind.You can also "rename" the property in the binding by specifying the new name in the
to()chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );It is also possible to bind to the same property in an array of observables. To bind a
buttonto multiple commands (alsoObservables) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );Parameters
bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>Observable properties that will be bound to other observable(s).
Returns
MultiBindChainThe bind chain with the
to()andtoMany()methods.
-
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, StyleUI[ K1 ], K2, StyleUI[ K2 ]>module:style/styleui~StyleUI#bind:DUAL_BINDBinds observable properties to other objects implementing the
Observableinterface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
buttonand an associatedcommand(bothObservable).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );or even shorter:
button.bind( 'isEnabled' ).to( command );which works in the following way:
button.isEnabledinstantly equalscommand.isEnabled,- whenever
command.isEnabledchanges,button.isEnabledwill immediately reflect its value.
Note: To release the binding, use
unbind.You can also "rename" the property in the binding by specifying the new name in the
to()chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );It is also possible to bind to the same property in an array of observables. To bind a
buttonto multiple commands (alsoObservables) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );Type parameters
K1K2
Parameters
bindProperty1 : K1Observable property that will be bound to other observable(s).
bindProperty2 : K2Observable property that will be bound to other observable(s).
Returns
-
inherited
bind( bindProperty ) → SingleBindChain<K, StyleUI[ K ]>module:style/styleui~StyleUI#bind:SINGLE_BINDBinds observable properties to other objects implementing the
Observableinterface.Read more in the dedicated guide covering the topic of property bindings with some additional examples.
Consider two objects: a
buttonand an associatedcommand(bothObservable).A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );or even shorter:
button.bind( 'isEnabled' ).to( command );which works in the following way:
button.isEnabledinstantly equalscommand.isEnabled,- whenever
command.isEnabledchanges,button.isEnabledwill immediately reflect its value.
Note: To release the binding, use
unbind.You can also "rename" the property in the binding by specifying the new name in the
to()chain:button.bind( 'isEnabled' ).to( command, 'isWorking' );It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );which corresponds to:
button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible', ( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );It is also possible to bind to the same property in an array of observables. To bind a
buttonto multiple commands (alsoObservables) so that each and every one of them must be enabled for the button to become enabled, use the following code:button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled', ( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );Type parameters
K
Parameters
bindProperty : KObservable property that will be bound to other observable(s).
Returns
SingleBindChain<K, StyleUI[ K ]>The bind chain with the
to()andtoMany()methods.
-
Clears forced disable previously set through
forceDisabled. SeeforceDisabled.Parameters
id : stringUnique identifier, equal to the one passed in
forceDisabledcall.
Returns
void
-
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.
Read more in the dedicated guide covering the topic of decorating methods with some additional examples.
Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.
For example, to cancel the method execution the event can be stopped:
class Foo extends ObservableMixin() { constructor() { super(); this.decorate( 'method' ); } method() { console.log( 'called!' ); } } const foo = new Foo(); foo.on( 'method', ( evt ) => { evt.stop(); }, { priority: 'high' } ); foo.method(); // Nothing is logged.Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
foo.on( 'method', ( evt ) => { evt.return = 'Foo!'; } ); foo.method(); // -> 'Foo'Finally, it is possible to access and modify the arguments the method is called with:
method( a, b ) { console.log( `${ a }, ${ b }` ); } // ... foo.on( 'method', ( evt, args ) => { args[ 0 ] = 3; console.log( args[ 1 ] ); // -> 2 }, { priority: 'high' } ); foo.method( 1, 2 ); // -> '3, 2'Parameters
methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled'Name of the method to decorate.
Returns
void
-
Delegates selected events to another
Emitter. For instance:emitterA.delegate( 'eventX' ).to( emitterB ); emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );then
eventXis delegated (fired by)emitterBandemitterCalong withdata:emitterA.fire( 'eventX', data );and
eventYis delegated (fired by)emitterCalong withdata:emitterA.fire( 'eventY', data );Parameters
events : Array<string>Event names that will be delegated to another emitter.
Returns
-
Destroys the plugin.
Note: This method is optional. A plugin instance does not need to have it defined.
Returns
void
-
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:style/styleui~StyleUI#fireFires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an
EventInfoobject, followed by the optionalargsprovided in thefire()method call.Type parameters
Parameters
eventOrInfo : GetNameOrEventInfo<TEvent>The name of the event or
EventInfoobject if event is delegated.args : TEvent[ 'args' ]Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]By default the method returns
undefined. However, the return value can be changed by listeners through modification of theevt.return's property (the event info is the first param of every callback).
-
Disables the plugin.
Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.
Disabling and enabling a plugin:
plugin.isEnabled; // -> true plugin.forceDisabled( 'MyFeature' ); plugin.isEnabled; // -> false plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> truePlugin disabled by multiple features:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'OtherFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> false plugin.clearForceDisabled( 'OtherFeature' ); plugin.isEnabled; // -> trueMultiple disabling with the same identifier is redundant:
plugin.forceDisabled( 'MyFeature' ); plugin.forceDisabled( 'MyFeature' ); plugin.clearForceDisabled( 'MyFeature' ); plugin.isEnabled; // -> trueNote: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after
clearForceDisabledwas used.Parameters
id : stringUnique identifier for disabling. Use the same id when enabling back the plugin.
Returns
void
-
init() → voidmodule:style/styleui~StyleUI#init -
inherited
listenTo( emitter, event, callback, [ options ] ) → voidmodule:style/styleui~StyleUI#listenTo:BASE_EMITTERRegisters a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using
:. When namespaced event is fired, it additionally fires all callbacks for that namespace.// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ). myEmitter.on( 'myGroup', genericCallback ); myEmitter.on( 'myGroup:myEvent', specificCallback ); // genericCallback is fired. myEmitter.fire( 'myGroup' ); // both genericCallback and specificCallback are fired. myEmitter.fire( 'myGroup:myEvent' ); // genericCallback is fired even though there are no callbacks for "foo". myEmitter.fire( 'myGroup:foo' );An event callback can stop the event and set the return value of the
firemethod.Type parameters
Parameters
emitter : EmitterThe object that fires the event.
event : TEvent[ 'name' ]The name of the event.
callback : GetCallback<TEvent>The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>Additional options.
Returns
void
-
Stops executing the callback on the given event. Shorthand for
this.stopListening( this, event, callback ).Parameters
event : stringThe name of the event.
callback : FunctionThe function to stop being called.
Returns
void
-
Registers a callback function to be executed when an event is fired.
Shorthand for
this.listenTo( this, event, callback, options )(it makes the emitter listen on itself).Type parameters
Parameters
event : TEvent[ 'name' ]The name of the event.
callback : GetCallback<TEvent>The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>Additional options.
Returns
void
-
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling
onfollowed byoffin the callback.Type parameters
Parameters
event : TEvent[ 'name' ]The name of the event.
callback : GetCallback<TEvent>The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>Additional options.
Returns
void
-
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.
It accepts a single object literal containing key/value pairs with properties to be set.
This method throws the
observable-set-cannot-overrideerror if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means thatfoo.set( 'bar', 1 )may be slightly slower thanfoo.bar = 1.In TypeScript, those properties should be declared in class using
declarekeyword. In example:public declare myProp1: number; public declare myProp2: string; constructor() { this.set( { 'myProp1: 2, 'myProp2: 'foo' } ); }Parameters
values : objectAn object with
name=>valuepairs.
Returns
void
-
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.
This method throws the
observable-set-cannot-overrideerror if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means thatfoo.set( 'bar', 1 )may be slightly slower thanfoo.bar = 1.In TypeScript, those properties should be declared in class using
declarekeyword. In example:public declare myProp: number; constructor() { this.set( 'myProp', 2 ); }Type parameters
K
Parameters
name : KThe property's name.
value : StyleUI[ K ]The property's value.
Returns
void
-
inherited
stopDelegating( [ event ], [ emitter ] ) → voidmodule:style/styleui~StyleUI#stopDelegatingStops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters
[ event ] : stringThe name of the event to stop delegating. If omitted, stops it all delegations.
[ emitter ] : Emitter(requires
event) The object to stop delegating a particular event to. If omitted, stops delegation ofeventto all emitters.
Returns
void
-
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:style/styleui~StyleUI#stopListening:BASE_STOPStops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters
[ emitter ] : EmitterThe object to stop listening to. If omitted, stops it for all objects.
[ event ] : string(Requires the
emitter) The name of the event to stop listening to. If omitted, stops it for all events fromemitter.[ callback ] : Function(Requires the
event) The function to be removed from the call list for the givenevent.
Returns
void
-
Removes the binding created with
bind.// Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind();Parameters
unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'isEnabled' | 'init' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
Events
-
inherited
change:isEnabled( eventInfo, name, value, oldValue )module:style/styleui~StyleUI#event:change:isEnabledFired when the
isEnabledproperty changed value.Parameters
eventInfo : EventInfoAn object containing information about the fired event.
name : stringName of the changed property (
isEnabled).value : booleanNew value of the
isEnabledproperty with given key ornull, if operation should remove property.oldValue : booleanOld value of the
isEnabledproperty with given key ornull, if property was not set before.
-
inherited
change:{property}( eventInfo, name, value, oldValue )module:style/styleui~StyleUI#event:change:{property}Fired when a property changed value.
observable.set( 'prop', 1 ); observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` ); } ); observable.prop = 2; // -> 'prop has changed from 1 to 2'Parameters
eventInfo : EventInfoAn object containing information about the fired event.
name : stringThe property name.
value : TValueThe new property value.
oldValue : TValueThe previous property value.
-
inherited
set:isEnabled( eventInfo, name, value, oldValue )module:style/styleui~StyleUI#event:set:isEnabledFired when the
isEnabledproperty is going to be set but is not set yet (before thechangeevent is fired).Parameters
eventInfo : EventInfoAn object containing information about the fired event.
name : stringName of the changed property (
isEnabled).value : booleanNew value of the
isEnabledproperty with given key ornull, if operation should remove property.oldValue : booleanOld value of the
isEnabledproperty with given key ornull, if property was not set before.
-
inherited
set:{property}( eventInfo, name, value, oldValue )module:style/styleui~StyleUI#event:set:{property}Fired when a property value is going to be set but is not set yet (before the
changeevent is fired).You can control the final value of the property by using the event's
returnproperty.observable.set( 'prop', 1 ); observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` ); console.log( `Current property value is ${ observable[ propertyName ] }` ); // Let's override the value. evt.return = 3; } ); observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => { console.log( `Value has changed from ${ oldValue } to ${ newValue }` ); } ); observable.prop = 2; // -> 'Value is going to be changed from 1 to 2' // -> 'Current property value is 1' // -> 'Value has changed from 1 to 3'Note: The event is fired even when the new value is the same as the old value.
Parameters
eventInfo : EventInfoAn object containing information about the fired event.
name : stringThe property name.
value : TValueThe new property value.
oldValue : TValueThe previous property value.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.