Sign up (with export icon)

DataFilter

Api-class icon class

Allows to validate elements and element attributes registered by DataSchema.

To enable registered element in the editor, use allowElement method:

dataFilter.allowElement( 'section' );
Copy code

You can also allow or disallow specific element attributes:

// Allow `data-foo` attribute on `section` element.
dataFilter.allowAttributes( {
	name: 'section',
	attributes: {
		'data-foo': true
	}
} );

// Disallow `color` style attribute on 'section' element.
dataFilter.disallowAttributes( {
	name: 'section',
	styles: {
		color: /[\s\S]+/
	}
} );
Copy code

To apply the information about allowed and disallowed attributes in custom integration plugin, use the processViewAttributes() method.

See source (with github icon)

Properties

Static properties

Methods

  • Chevron-right icon

    constructor( editor )

    See source (with github icon)

    Parameters

    editor : Editor
  • Chevron-right icon

    allowAttributes( config ) → void

    Allow the given attributes for view element allowed by allowElement method.

    See source (with github icon)

    Parameters

    config : MatcherPattern

    Pattern matching all attributes which should be allowed.

    Returns

    void
  • Chevron-right icon

    allowElement( viewName ) → void

    Allow the given element in the editor context.

    This method will only allow elements described by the DataSchema used to create data filter.

    Note: Rules will be applied just before next data pipeline data init or set.

    See source (with github icon)

    Parameters

    viewName : string | RegExp

    String or regular expression matching view name.

    Returns

    void
  • Chevron-right icon

    allowEmptyElement( viewName ) → void

    Allow the given empty element in the editor context.

    This method will only allow elements described by the DataSchema used to create data filter.

    Note: It modifies DataSchema so must be called before registering filtering rules.

    See source (with github icon)

    Parameters

    viewName : string

    String or regular expression matching view name.

    Returns

    void
  • Chevron-right icon

    bind( bindProperties ) → ObservableMultiBindChain
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will 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' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    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 );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) 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 );
    Copy code
    See source (with github icon)

    Parameters

    bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'allowAttributes' | 'disallowAttributes' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loadAllowedConfig' | 'loadDisallowedConfig' | 'loadAllowedEmptyElementsConfig' | 'allowElement' | 'disallowElement' | 'allowEmptyElement' | 'processViewAttributes'>

    Observable properties that will be bound to other observable(s).

    Returns

    ObservableMultiBindChain

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, DataFilter[ K1 ], K2, DataFilter[ K2 ]>
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will 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' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    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 );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) 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 );
    Copy code
    See source (with github icon)

    Type parameters

    K1
    K2

    Parameters

    bindProperty1 : K1

    Observable property that will be bound to other observable(s).

    bindProperty2 : K2

    Observable property that will be bound to other observable(s).

    Returns

    ObservableDualBindChain<K1, DataFilter[ K1 ], K2, DataFilter[ K2 ]>

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    bind( bindProperty ) → ObservableSingleBindChain<K, DataFilter[ K ]>
    inherited

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );
    Copy code

    or even shorter:

    button.bind( 'isEnabled' ).to( command );
    Copy code

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will 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' );
    Copy code

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );
    Copy code

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
    Copy code

    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 );
    Copy code

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
    Copy code

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) 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 );
    Copy code
    See source (with github icon)

    Type parameters

    K

    Parameters

    bindProperty : K

    Observable property that will be bound to other observable(s).

    Returns

    ObservableSingleBindChain<K, DataFilter[ K ]>

    The bind chain with the to() and toMany() methods.

  • Chevron-right icon

    clearForceDisabled( id ) → void
    inherited

    Clears forced disable previously set through forceDisabled. See forceDisabled.

    See source (with github icon)

    Parameters

    id : string

    Unique identifier, equal to the one passed in forceDisabled call.

    Returns

    void
  • Chevron-right icon

    decorate( methodName ) → void
    inherited

    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.
    Copy code

    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'
    Copy code

    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'
    Copy code
    See source (with github icon)

    Parameters

    methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'allowAttributes' | 'disallowAttributes' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loadAllowedConfig' | 'loadDisallowedConfig' | 'loadAllowedEmptyElementsConfig' | 'allowElement' | 'disallowElement' | 'allowEmptyElement' | 'processViewAttributes'

    Name of the method to decorate.

    Returns

    void
  • Chevron-right icon

    delegate( events ) → EmitterMixinDelegateChain
    inherited

    Delegates selected events to another Emitter. For instance:

    emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
    Copy code

    then eventX is delegated (fired by) emitterB and emitterC along with data:

    emitterA.fire( 'eventX', data );
    Copy code

    and eventY is delegated (fired by) emitterC along with data:

    emitterA.fire( 'eventY', data );
    Copy code
    See source (with github icon)

    Parameters

    events : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • Chevron-right icon

    destroy() → void
    inherited

    Destroys the plugin.

    Note: This method is optional. A plugin instance does not need to have it defined.

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    disallowAttributes( config ) → void

    Disallow the given attributes for view element allowed by allowElement method.

    See source (with github icon)

    Parameters

    config : MatcherPattern

    Pattern matching all attributes which should be disallowed.

    Returns

    void
  • Chevron-right icon

    disallowElement( viewName ) → void

    Disallow the given element in the editor context.

    This method will only disallow elements described by the DataSchema used to create data filter.

    See source (with github icon)

    Parameters

    viewName : string | RegExp

    String or regular expression matching view name.

    Returns

    void
  • Chevron-right icon

    fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
    inherited

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

    The name of the event or EventInfo object 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 the evt.return's property (the event info is the first param of every callback).

  • Chevron-right icon

    forceDisabled( id ) → void
    inherited

    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; // -> true
    Copy code

    Plugin disabled by multiple features:

    plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
    Copy code

    Multiple disabling with the same identifier is redundant:

    plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
    Copy code

    Note: 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 clearForceDisabled was used.

    See source (with github icon)

    Parameters

    id : string

    Unique identifier for disabling. Use the same id when enabling back the plugin.

    Returns

    void
  • Chevron-right icon

    listenTo( emitter, event, callback, [ options ] ) → void
    inherited

    Registers 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' );
    Copy code

    An event callback can stop the event and set the return value of the fire method.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The 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
  • Chevron-right icon

    loadAllowedConfig( config ) → void

    Load a configuration of one or many elements, where their attributes should be allowed.

    Note: Rules will be applied just before next data pipeline data init or set.

    See source (with github icon)

    Parameters

    config : Array<MatcherObjectPattern>

    Configuration of elements that should have their attributes accepted in the editor.

    Returns

    void
  • Chevron-right icon

    loadAllowedEmptyElementsConfig( config ) → void

    Load a configuration of one or many elements, where when empty should be allowed.

    Note: It modifies DataSchema so must be loaded before registering filtering rules.

    See source (with github icon)

    Parameters

    config : Array<string>

    Configuration of elements that should be preserved even if empty.

    Returns

    void
  • Chevron-right icon

    loadDisallowedConfig( config ) → void

    Load a configuration of one or many elements, where their attributes should be disallowed.

    Note: Rules will be applied just before next data pipeline data init or set.

    See source (with github icon)

    Parameters

    config : Array<MatcherObjectPattern>

    Configuration of elements that should have their attributes rejected from the editor.

    Returns

    void
  • Chevron-right icon

    off( event, callback ) → void
    inherited

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    See source (with github icon)

    Parameters

    event : string

    The name of the event.

    callback : Function

    The function to stop being called.

    Returns

    void
  • Chevron-right icon

    on( event, callback, [ options ] ) → void
    inherited

    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).

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    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
  • Chevron-right icon

    once( event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    See source (with github icon)

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    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
  • Chevron-right icon

    processViewAttributes( viewElement, conversionApi ) → null | GHSViewAttributes

    Processes all allowed and disallowed attributes on the view element by consuming them and returning the allowed ones.

    This method applies the configuration set up by allowAttributes() and disallowAttributes() over the given view element by consuming relevant attributes. It returns the allowed attributes that were found on the given view element for further processing by integration code.

    dispatcher.on( 'element:myElement', ( evt, data, conversionApi ) => {
	// Get rid of disallowed and extract all allowed attributes from a viewElement.
	const viewAttributes = dataFilter.processViewAttributes( data.viewItem, conversionApi );
	// Do something with them, i.e. store inside a model as a dictionary.
	if ( viewAttributes ) {
		conversionApi.writer.setAttribute( 'htmlAttributesOfMyElement', viewAttributes, data.modelRange );
	}
} );
    Copy code
    See source (with github icon)

    Parameters

    viewElement : ViewElement
    conversionApi : UpcastConversionApi

    Returns

    null | GHSViewAttributes

    Object with following properties:

    • attributes Set with matched attribute names.
    • styles Set with matched style names.
    • classes Set with matched class names.

    Related:

  • Chevron-right icon

    set( values ) → void
    inherited

    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-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}
    Copy code
    See source (with github icon)

    Parameters

    values : object

    An object with name=>value pairs.

    Returns

    void
  • Chevron-right icon

    set( name, value ) → void
    inherited

    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-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}
    Copy code
    See source (with github icon)

    Type parameters

    K

    Parameters

    name : K

    The property's name.

    value : DataFilter[ K ]

    The property's value.

    Returns

    void
  • Chevron-right icon

    stopDelegating( [ event ], [ emitter ] ) → void
    inherited

    Stops 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.
    See source (with github icon)

    Parameters

    [ event ] : string

    The 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 of event to all emitters.

    Returns

    void
  • Chevron-right icon

    stopListening( [ emitter ], [ event ], [ callback ] ) → void
    inherited

    Stops 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.
    See source (with github icon)

    Parameters

    [ emitter ] : Emitter

    The 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 from emitter.

    [ callback ] : Function

    (Requires the event) The function to be removed from the call list for the given event.

    Returns

    void
  • Chevron-right icon

    unbind( unbindProperties ) → void
    inherited

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
    Copy code
    See source (with github icon)

    Parameters

    unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'allowAttributes' | 'disallowAttributes' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | 'loadAllowedConfig' | 'loadDisallowedConfig' | 'loadAllowedEmptyElementsConfig' | 'allowElement' | 'disallowElement' | 'allowEmptyElement' | 'processViewAttributes'>

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

    Returns

    void
  • Chevron-right icon

    _addAllowedElement( definition ) → void
    Lock icon private

    Adds allowed element definition and fires registration event.

    See source (with github icon)

    Parameters

    definition : HtmlSupportDataSchemaDefinition

    Returns

    void
  • Chevron-right icon

    _fireRegisterEvent( definition ) → void
    Lock icon private

    Fires register event for the given element definition.

    See source (with github icon)

    Parameters

    definition : HtmlSupportDataSchemaDefinition

    Returns

    void
  • Chevron-right icon

    _getCoupledAttributesMap() → Map<string, Array<string>>
    Lock icon private

    Collects the map of coupled attributes. The returned map is keyed by the feature attribute name and coupled GHS attribute names are stored in the value array.

    See source (with github icon)

    Returns

    Map<string, Array<string>>
  • Chevron-right icon

    _registerAssociatedHtmlAttributesPostFixer() → void
    Lock icon private

    Removes html*Attributes attributes from incompatible elements.

    For example, consider the following HTML:

    <heading2 htmlH2Attributes="...">foobar[]</heading2>
    Copy code

    Pressing enter creates a new paragraph element that inherits the htmlH2Attributes attribute from heading2.

    <heading2 htmlH2Attributes="...">foobar</heading2>
<paragraph htmlH2Attributes="...">[]</paragraph>
    Copy code

    This postfixer ensures that this doesn't happen, and that elements can only have html*Attributes associated with them, e.g.: htmlPAttributes for <p>, htmlDivAttributes for <div>, etc.

    With it enabled, pressing enter at the end of <heading2> will create a new paragraph without the htmlH2Attributes attribute.

    <heading2 htmlH2Attributes="...">foobar</heading2>
<paragraph>[]</paragraph>
    Copy code
    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    _registerBlockElement( definition ) → void
    Lock icon private

    Registers block element and attribute converters for the given data schema definition.

    See source (with github icon)

    Parameters

    definition : HtmlSupportDataSchemaBlockElementDefinition

    Returns

    void
  • Chevron-right icon

    _registerCoupledAttributesPostFixer() → void
    Lock icon private

    Registers a model post-fixer that is removing coupled GHS attributes of inline elements. Those attributes are removed if a coupled feature attribute is removed.

    For example, consider following HTML:

    <a href="foo.html" id="myId">bar</a>
    Copy code

    Which would be upcasted to following text node in the model:

    <$text linkHref="foo.html" htmlA="{ attributes: { id: 'myId' } }">bar</$text>
    Copy code

    When the user removes the link from that text (using UI), only linkHref attribute would be removed:

    <$text htmlA="{ attributes: { id: 'myId' } }">bar</$text>
    Copy code

    The htmlA attribute would stay in the model and would cause GHS to generate an <a> element. This is incorrect from UX point of view, as the user wanted to remove the whole link (not only href).

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    _registerElementHandlers() → void
    Lock icon private

    Registers default element handlers.

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    _registerElementsAfterInit() → void
    Lock icon private

    Registers elements allowed by allowElement method once editor's data controller is initialized.

    See source (with github icon)

    Returns

    void
  • Chevron-right icon

    _registerInlineElement( definition ) → void
    Lock icon private

    Registers inline element and attribute converters for the given data schema definition.

    Extends $text model schema to allow the given definition model attribute and its properties.

    See source (with github icon)

    Parameters

    definition : HtmlSupportDataSchemaInlineElementDefinition

    Returns

    void
  • Chevron-right icon

    _registerObjectElement( definition ) → void
    Lock icon private

    Registers object element and attribute converters for the given data schema definition.

    See source (with github icon)

    Parameters

    definition : HtmlSupportDataSchemaDefinition

    Returns

    void

Events

  • Chevron-right icon

    change:isEnabled( eventInfo, name, value, oldValue )
    inherited

    Fired when the isEnabled property changed value.

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isEnabled).

    value : boolean

    New value of the isEnabled property with given key or null, if operation should remove property.

    oldValue : boolean

    Old value of the isEnabled property with given key or null, if property was not set before.

  • Chevron-right icon

    change:{property}( eventInfo, name, value, oldValue )
    inherited

    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'
    Copy code
    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • Chevron-right icon

    set:isEnabled( eventInfo, name, value, oldValue )
    inherited

    Fired when the isEnabled property is going to be set but is not set yet (before the change event is fired).

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isEnabled).

    value : boolean

    New value of the isEnabled property with given key or null, if operation should remove property.

    oldValue : boolean

    Old value of the isEnabled property with given key or null, if property was not set before.

  • Chevron-right icon

    set:{property}( eventInfo, name, value, oldValue )
    inherited

    Fired when a property value is going to be set but is not set yet (before the change event is fired).

    You can control the final value of the property by using the event's return property.

    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'
    Copy code

    Note: The event is fired even when the new value is the same as the old value.

    See source (with github icon)

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

Was this page helpful?

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.

GitHubSupportContact Us

© 2003 - 2025  CKSource. All rights reserved.