CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

HtmlPageDataProcessor (html-support)

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

class
See source

The full page HTML data processor class. This data processor implementation uses HTML as input and output data.

Filtering

Methods

  • registerRawContentMatcher( pattern )

    See source

    Registers a MatcherPattern for view elements whose content should be treated as raw data and its content should be converted to a custom property of a view element called "$rawContent" while converting to view.

    Parameters

    pattern : MatcherPattern

    Pattern matching all view elements whose content should be treated as plain text.

  • toData( fragment ) → *

    See source

    Converts a document fragment to data.

    Parameters

    fragment : DocumentFragment

    The document fragment to be processed.

    Returns

    *

  • toView( data ) → DocumentFragment

    See source

    Converts the data to a document fragment.

    Parameters

    data : *

    The data to be processed.

    Returns

    DocumentFragment

  • useFillerType( type )

    See source

    If the processor is set to use marked fillers, it will insert &nbsp; fillers wrapped in <span> elements (<span data-cke-filler="true">&nbsp;</span>) instead of regular &nbsp; characters.

    This mode allows for more precise handling of block fillers (so they do not leak into the editor content) but bloats the editor data with additional markup.

    This mode may be required by some features and will be turned on by them automatically.

    Parameters

    type : 'default' | 'marked'

    Whether to use the default or marked &nbsp; block fillers.