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

Properties

  • inherited

    domConverter : DomConverter

    See source

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

  • inherited

    domParser : DOMParser

    See source

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

  • inherited

    htmlWriter : HtmlWriter

    See source

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

  • inherited

    skipComments : boolean

    See source

    If false, comment nodes will be converted to $comment. Otherwise comment nodes are ignored.

Methods

  • inherited

    constructor( document )

    See source

    Creates a new instance of the HTML data processor class.

    Parameters

    document : Document

    The view document instance.

  • inherited

    registerRawContentMatcher( pattern ) → void

    See source

    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.

    Returns

    void

  • toData( viewFragment ) → string

    See source

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

    Parameters

    viewFragment : DocumentFragment

    Returns

    string

    HTML string.

  • toView( data ) → DocumentFragment

    See source

    Converts the provided HTML string to a view tree.

    Parameters

    data : string

    An HTML string.

    Returns

    DocumentFragment

    A converted view element.

  • inherited

    useFillerType( type ) → void

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

    Returns

    void

  • protected inherited

    _toDom( data ) → DocumentFragment

    See source

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

    Parameters

    data : string

    Returns

    DocumentFragment