Class

HtmlDataProcessor (engine/dataprocessor)

@ckeditor/ckeditor5-engine/src/dataprocessor/htmldataprocessor

class

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

Filtering

Properties

  • _domConverter : DomConverter

    private

    A DOM converter used to convert DOM elements to view elements.

  • _domParser : DOMParser

    private

    A DOM parser instance used to parse an HTML string to an HTML document.

  • _htmlWriter : BasicHtmlWriter

    private

    A basic HTML writer instance used to convert DOM elements to an HTML string.

Methods

  • constructor( document )

    Creates a new instance of the HTML data processor class.

    Parameters

    document : Document

    The view document instance.

  • registerRawContentMatcher( pattern )

    Registers a MatcherPattern for view elements whose content should be treated as raw data and not processed during the conversion from the DOM to the view elements.

    The raw data can be later accessed by a custom property of a view element called "$rawContent".

    Parameters

    pattern : MatcherPattern

    Pattern matching all view elements whose content should be treated as raw data.

  • toData( viewFragment ) → String

    Converts a provided document fragment to data format — in this case to an HTML string.

    Parameters

    viewFragment : DocumentFragment

    Returns

    String

    HTML string.

  • toView( data ) → Node | DocumentFragment | null

    Converts the provided HTML string to a view tree.

    Parameters

    data : String

    An HTML string.

    Returns

    Node | DocumentFragment | null

    A converted view element.

  • useFillerType( type )

    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 a more precise handling of the 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 the marked &nbsp; block fillers.

  • _toDom( data ) → DocumentFragment

    private

    Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from the provided data.

    Parameters

    data : String

    Returns

    DocumentFragment