ListWalker (list/list/utils)
@ckeditor/ckeditor5-list/src/list/utils/listwalker
Document list blocks iterator.
Filtering
Properties
-
Whether blocks with a higher indent level than the start block should be included in the result.
-
Whether start block should be included in the result (if it's matching other criteria).
-
The iterating direction.
-
Whether blocks with a lower indent level than the start block should be included in the result.
-
The reference indent. Initialized by the indent of the start block.
-
Additional attributes that must be the same for each block.
-
Whether blocks with the same indent level as the start block should be included in the result.
-
The start list item block element.
Methods
-
constructor( startElement, options )module:list/list/utils/listwalker~ListWalker#constructorCreates a document list iterator.
Parameters
startElement : NodeThe start list item block element.
options : ListWalkerOptions
-
Symbol.iterator() → Iterator<ListElement, any, undefined>module:list/list/utils/listwalker~ListWalker#Symbol.iterator -
Static methods
-
static
first( startElement, options ) → null | ListElementmodule:list/list/utils/listwalker~ListWalker.firstPerforms only first step of iteration and returns the result.
Parameters
startElement : NodeThe start list item block element.
options : ListWalkerOptions
Returns
null | ListElement
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.