Interface

DataFilterRegisterEvent (html-support)

@ckeditor/ckeditor5-html-support/src/datafilter

interface

Fired when DataFilter is registering element and attribute converters for the element definition.

The event also accepts view value as an event namespace, e.g. register:span.

dataFilter.on( 'register', ( evt, definition ) => {
	editor.model.schema.register( definition.model, definition.modelSchema );
	editor.conversion.elementToElement( { model: definition.model, view: definition.view } );

	evt.stop();
} );

dataFilter.on( 'register:span', ( evt, definition ) => {
	editor.model.schema.extend( '$text', { allowAttributes: 'htmlSpan' } );

	editor.conversion.for( 'upcast' ).elementToAttribute( { view: 'span', model: 'htmlSpan' } );
	editor.conversion.for( 'downcast' ).attributeToElement( { view: 'span', model: 'htmlSpan' } );

	evt.stop();
}, { priority: 'high' } )

Filtering

Properties

  • args : tuple

  • name : 'register' | `register:${ string }`