Module list/list/utils/model | CKEditor 5 API docs

`canBecomeSimpleListItem( block, schema ) → boolean`
internal

module:list/list/utils/model~canBecomeSimpleListItem

Checks whether the given block can be replaced by a listItem.

Note that this is possible only when multiBlock = false option is set in feature config.

See source

Parameters

block : ModelElement: A block to be tested.
schema : ModelSchema: The schema of the document.

Returns

boolean

`expandListBlocksToCompleteItems( blocks, options = { [options.withNested] } ) → Array<ListElement>`
internal

module:list/list/utils/model~expandListBlocksToCompleteItems

Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items.

See source

Parameters

blocks : ArrayOrItem<ModelElement>

The list of selected blocks.

options : object

Properties

[ options.withNested ] : boolean: Whether should include nested list items.

Defaults to {}

Returns

Array<ListElement>

`expandListBlocksToCompleteList( blocks ) → Array<ListElement>`
internal

module:list/list/utils/model~expandListBlocksToCompleteList

Expands the given list of selected blocks to include all the items of the lists they're in.

See source

Parameters

blocks : ArrayOrItem<ModelElement>: The list of selected blocks.

Returns

Array<ListElement>

`getAllListItemBlocks( listItem, options = { [options.higherIndent] } ) → Array<ListElement>`
internal

module:list/list/utils/model~getAllListItemBlocks

Returns an array with all elements that represents the same list item.

It means that values for listIndent, and listItemId for all items are equal.

See source

Parameters

listItem : ModelNode

Starting list item element.

options : object

Properties

[ options.higherIndent ] : boolean: Whether blocks with a higher indent level than the start block should be included in the result.

Defaults to {}

Returns

Array<ListElement>

`getListItemBlocks( listItem, options = { [options.direction], [options.higherIndent] } ) → Array<ListElement>`
internal

module:list/list/utils/model~getListItemBlocks

Returns an array with elements that represents the same list item in the specified direction.

It means that values for listIndent and listItemId for all items are equal.

Note: For backward search the provided item is not included, but for forward search it is included in the result.

See source

Parameters

listItem : ModelNode

Starting list item element.

options : object

Properties

[ options.direction ] : 'forward' | 'backward': Walking direction.
[ options.higherIndent ] : boolean: Whether blocks with a higher indent level than the start block should be included in the result.

Defaults to {}

Returns

Array<ListElement>

`getListItems( listItem, [ options ] ) → Array<ListElement>`
internal

module:list/list/utils/model~getListItems

Returns array of all blocks/items of the same list as given block (same indent, same type and properties).

See source

Parameters

listItem : ModelElement: Starting list item element.
[ options ] : ListWalkerOptions: Additional list walker options to modify the range of returned list items.

Returns

Array<ListElement>

`getNestedListBlocks( listItem ) → Array<ListElement>`
internal

module:list/list/utils/model~getNestedListBlocks

Returns a list items nested inside the given list item.

See source

Parameters

listItem : ModelElement

Returns

Array<ListElement>

`getSelectedBlockObject( model ) → null | ModelElement`
internal

module:list/list/utils/model~getSelectedBlockObject

Returns a selected block object. If a selected object is inline or when there is no selected object, null is returned.

See source

Parameters

model : Model: The instance of editor model.

Returns

null | ModelElement: Selected block object or null.

`indentBlocks( blocks, writer, options = { [options.expand], [options.indentBy] } ) → Array<ListElement>`
internal

module:list/list/utils/model~indentBlocks

Increases indentation of given list blocks.

See source

Parameters

blocks : ArrayOrItem<ListElement>

The block or iterable of blocks.

writer : ModelWriter

The model writer.

options : object

Additional options.

Properties

[ options.expand ] : boolean

Whether should expand the list of blocks to include complete list items.

[ options.indentBy ] : number

The number of levels the indentation should change (could be negative).

Defaults to 1

Defaults to {}

Returns

Array<ListElement>

`isFirstBlockOfListItem( listBlock ) → boolean`
internal

module:list/list/utils/model~isFirstBlockOfListItem

Check if the given block is the first in the list item.

See source

Parameters

listBlock : ModelNode: The list block element.

Returns

boolean

`isLastBlockOfListItem( listBlock ) → boolean`
internal

module:list/list/utils/model~isLastBlockOfListItem

Check if the given block is the last in the list item.

See source

Parameters

listBlock : ModelElement

Returns

boolean

`isListItemBlock( node ) → node is ListElement`
internal

module:list/list/utils/model~isListItemBlock

Returns true if the given model node is a list item block.

See source

Parameters

node : null | ModelDocumentFragment | ModelItem

Returns

node is ListElement

`isNumberedListType( listType ) → boolean`
internal

module:list/list/utils/model~isNumberedListType

Returns true if listType is of type numbered or customNumbered.

See source

Parameters

listType : ListType

Returns

boolean

`isSingleListItem( blocks ) → boolean`
internal

module:list/list/utils/model~isSingleListItem

Checks whether the given blocks are related to a single list item.

See source

Parameters

blocks : Array<ModelNode>: The list block elements.

Returns

boolean

`mergeListItemBefore( listBlock, parentBlock, writer ) → Array<ListElement>`
internal

module:list/list/utils/model~mergeListItemBefore

Merges the list item with the parent list item.

See source

Parameters

listBlock : ModelNode: The list block element.
parentBlock : ModelElement: The list block element to merge with.
writer : ModelWriter: The model writer.

Returns

Array<ListElement>: The array of updated blocks.

`outdentBlocksWithMerge( blocks, writer ) → Array<ListElement>`
internal

module:list/list/utils/model~outdentBlocksWithMerge

Decreases indentation of given list of blocks. If the indentation of some blocks matches the indentation of surrounding blocks, they get merged together.

See source

Parameters

blocks : ArrayOrItem<ListElement>: The block or iterable of blocks.
writer : ModelWriter: The model writer.

Returns

Array<ListElement>

`outdentFollowingItems( lastBlock, writer ) → Array<ListElement>`
internal

module:list/list/utils/model~outdentFollowingItems

Modifies the indents of list blocks following the given list block so the indentation is valid after the given block is no longer a list item.

See source

Parameters

lastBlock : ModelElement: The last list block that has become a non-list element.
writer : ModelWriter: The model writer.

Returns

Array<ListElement>: Array of altered blocks.

`removeListAttributes( blocks, writer ) → Array<ModelElement>`
internal

module:list/list/utils/model~removeListAttributes

Removes all list attributes from the given blocks.

See source

Parameters

blocks : ArrayOrItem<ModelElement>: The block or iterable of blocks.
writer : ModelWriter: The model writer.

Returns

Array<ModelElement>: Array of altered blocks.

`sortBlocks( blocks ) → Array<T>`
internal

module:list/list/utils/model~sortBlocks

Returns the array of given blocks sorted by model indexes (document order).

See source

Type parameters

T : extends ModelElement

Parameters

blocks : Iterable<T>

Returns

Array<T>

`splitListItemBefore( listBlock, writer ) → Array<ListElement>`
internal

module:list/list/utils/model~splitListItemBefore

Splits the list item just before the provided list block.

See source

Parameters

listBlock : ModelElement: The list block element.
writer : ModelWriter: The model writer.

Returns

Array<ListElement>: The array of updated blocks.

list/list/utils/model

Classes

ListItemUid internal

Interfaces

ListElement

Functions

canBecomeSimpleListItem( block, schema ) → boolean internal

Parameters

Returns

expandListBlocksToCompleteItems( blocks, options = { [options.withNested] } ) → Array<ListElement> internal

Parameters

Returns

expandListBlocksToCompleteList( blocks ) → Array<ListElement> internal

Parameters

Returns

getAllListItemBlocks( listItem, options = { [options.higherIndent] } ) → Array<ListElement> internal

Parameters

Returns

getListItemBlocks( listItem, options = { [options.direction], [options.higherIndent] } ) → Array<ListElement> internal

Parameters

Returns

getListItems( listItem, [ options ] ) → Array<ListElement> internal

Parameters

Returns

getNestedListBlocks( listItem ) → Array<ListElement> internal

Parameters

Returns

getSelectedBlockObject( model ) → null | ModelElement internal

Parameters

Returns

indentBlocks( blocks, writer, options = { [options.expand], [options.indentBy] } ) → Array<ListElement> internal

Parameters

Returns

isFirstBlockOfListItem( listBlock ) → boolean internal

Parameters

Returns

isLastBlockOfListItem( listBlock ) → boolean internal

Parameters

Returns

isListItemBlock( node ) → node is ListElement internal

Parameters

Returns

isNumberedListType( listType ) → boolean internal

Parameters

Returns

isSingleListItem( blocks ) → boolean internal

Parameters

Returns

mergeListItemBefore( listBlock, parentBlock, writer ) → Array<ListElement> internal

Parameters

Returns

outdentBlocksWithMerge( blocks, writer ) → Array<ListElement> internal

Parameters

Returns

outdentFollowingItems( lastBlock, writer ) → Array<ListElement> internal

Parameters

Returns

removeListAttributes( blocks, writer ) → Array<ModelElement> internal

Parameters

Returns

sortBlocks( blocks ) → Array<T> internal

Type parameters

Parameters

Returns

splitListItemBefore( listBlock, writer ) → Array<ListElement> internal

Parameters

Returns

`ListItemUid`
internal

`ListElement`

`canBecomeSimpleListItem( block, schema ) → boolean`
internal

`expandListBlocksToCompleteItems( blocks, options = { [options.withNested] } ) → Array<ListElement>`
internal

`expandListBlocksToCompleteList( blocks ) → Array<ListElement>`
internal

`getAllListItemBlocks( listItem, options = { [options.higherIndent] } ) → Array<ListElement>`
internal

`getListItemBlocks( listItem, options = { [options.direction], [options.higherIndent] } ) → Array<ListElement>`
internal

`getListItems( listItem, [ options ] ) → Array<ListElement>`
internal

`getNestedListBlocks( listItem ) → Array<ListElement>`
internal

`getSelectedBlockObject( model ) → null | ModelElement`
internal

`indentBlocks( blocks, writer, options = { [options.expand], [options.indentBy] } ) → Array<ListElement>`
internal

`isFirstBlockOfListItem( listBlock ) → boolean`
internal

`isLastBlockOfListItem( listBlock ) → boolean`
internal

`isListItemBlock( node ) → node is ListElement`
internal

`isNumberedListType( listType ) → boolean`
internal

`isSingleListItem( blocks ) → boolean`
internal

`mergeListItemBefore( listBlock, parentBlock, writer ) → Array<ListElement>`
internal

`outdentBlocksWithMerge( blocks, writer ) → Array<ListElement>`
internal

`outdentFollowingItems( lastBlock, writer ) → Array<ListElement>`
internal

`removeListAttributes( blocks, writer ) → Array<ModelElement>`
internal

`sortBlocks( blocks ) → Array<T>`
internal

`splitListItemBefore( listBlock, writer ) → Array<ListElement>`
internal