Trilium Frontend API
    Preparing search index...

    Class HtmlDataProcessor

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

    Implements

    Index

    Constructors

    • Creates a new instance of the HTML data processor class.

      Parameters

      Returns HtmlDataProcessor

    Properties

    domConverter: ViewDomConverter

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

    domParser: DOMParser

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

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

    skipComments: boolean

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

    Methods

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

      Parameters

      • data: string

      Returns DocumentFragment

    • Registers a module:engine/view/matcher~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 module:engine/view/element~ViewElement#getCustomProperty 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

    • Converts a provided module:engine/view/documentfragment~ViewDocumentFragment document fragment to data format – in this case to an HTML string.

      Parameters

      Returns string

      HTML string.

    • Converts the provided HTML string to a view tree.

      Parameters

      • data: string

        An HTML string.

      Returns ViewDocumentFragment

      A converted view element.

    • 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