CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

TreeWalkerOptions (engine/view)

@ckeditor/ckeditor5-engine/src/view/treewalker

interface
See source

The configuration of TreeWalker.

Filtering

Properties

  • boundaries : null | Range | undefined

    See source

    Range to define boundaries of the iterator.

  • direction : TreeWalkerDirection | undefined

    See source

    Walking direction.

    Defaults to 'forward'

  • ignoreElementEnd : boolean | undefined

    See source

    Flag indicating whether iterator should ignore elementEnd tags. If the option is true walker will not return a parent node of start position. If this option is true each Element will be returned once, while if the option is false they might be returned twice: for 'elementStart' and 'elementEnd'.

  • shallow : boolean | undefined

    See source

    Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any iterated node will not be returned along with elementEnd tag.

  • singleCharacters : boolean | undefined

    See source

    Flag indicating whether all characters from Text should be returned as one Text (false) or one by one as TextProxy (true).

  • startPosition : Position | undefined

    See source

    Starting position.