CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Module

list/documentlist/utils/listwalker

@ckeditor/ckeditor5-list/src/documentlist/utils/listwalker

module

Filtering

Classes

  • ListBlocksIterable

    protected

    The iterable protocol over the list elements.

    See source

  • ListWalker

    Document list blocks iterator.

    See source

Type Definitions

  • ListIteratorValue

    protected

    Object returned by iterateSiblingListBlocks() when traversing a list.

    See source

Functions

  • iterateSiblingListBlocks( node, [ direction ] ) → Iterator.<ListIteratorValue>

    protected

    Iterates sibling list blocks starting from the given node.

    See source

    Parameters

    node : Node

    The model node.

    [ direction ] : 'backward' | 'forward'

    Iteration direction.

    Defaults to 'forward'

    Returns

    Iterator.<ListIteratorValue>

    The object with node and previous blocks.