list/list/utils/model

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.

Parameters

block: ModelElement

A block to be tested.

schema: ModelSchema

The schema of the document.

Returns

boolean

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

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>

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

Parameters

blocks: ArrayOrItem<ModelElement>

The list of selected blocks.

Returns

Array<ListElement>

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.

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>

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.

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>

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

Parameters

listItem: ModelElement

Starting list item element.

options?: ListWalkerOptions

Additional list walker options to modify the range of returned list items.

Returns

Array<ListElement>

Returns a list items nested inside the given list item.

Parameters

listItem: ModelElement

Returns

Array<ListElement>

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

Parameters

model: Model

The instance of editor model.

Returns

ModelElement | null

Selected block object or null.

Increases indentation of given list blocks.

Parameters

blocks: ArrayOrItem<ListElement>

The block or iterable of blocks.

writer: ModelWriter

The model writer.

options: object

Additional options.

Properties

options.attributeNames: Array<string>

List of attribute names to remove when a block leaves the list (when blockIndent < 0).

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

Returns

Array<ListElement>

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

Parameters

listBlock: ModelNode

The list block element.

Returns

boolean

Checks if the given list item block is the first block of the first item in its list at the given indent.

Walks back over previous siblings and returns:

• true if it reaches a non-list block or a list block at a lower indent (a new list begins here),
• false if it finds a same-indent block of the same listItemId (a continuation of the current item) or of the same listType (the visible list already has earlier items),
• true if it finds a same-indent block of a different listType and a different listItemId (a different list ends; ours starts here),
• false if the loop ends (it reaches the first non-list-item block, or no more previous siblings) while passing only higher-indent blocks (those blocks live inside an intermediate skip-level <li style="list-style-type:none"> wrapper at our indent).

For example, in the model:

'  # aaa'
'# bbb'

bbb is preceded by a higher-indent block aaa, which in the view is rendered inside an intermediate skip-level wrapper at indent 0:

<ol>
  <li style="list-style-type:none">
	<ol>
	  <li>aaa</li>
	</ol>
  </li>
  <li>bbb</li>
</ol>

So bbb is the second visible item in the outer list and the function returns false.

Parameters

listItem: ModelElement

Returns

boolean

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

Parameters

listBlock: ModelElement

Returns

boolean

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

Parameters

node: ModelDocumentFragment | ModelItem | null

Returns

node is ListElement

Returns true if listType is of type numbered or customNumbered.

Parameters

listType: ListType

Returns

boolean

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

Parameters

blocks: Array<ModelNode>

The list block elements.

Returns

boolean

Merges the list item with the parent list item.

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.

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

Parameters

blocks: ArrayOrItem<ListElement>

The block or iterable of blocks.

writer: ModelWriter

The model writer.

options: object

Additional options.

Properties

options.attributeNames: Array<string>

List of attribute names to remove when a block leaves the list (when blockIndent < 0).

Returns

Array<ListElement>

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.

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.

Removes all list attributes from the given blocks.

Parameters

blocks: ArrayOrItem<ModelElement>

The block or iterable of blocks.

writer: ModelWriter

The model writer.

attributeNames: Array<string>

List of attribute names to remove.

Returns

Array<ModelElement>

Array of altered blocks.

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

Type parameters

T: extends ModelElement

Parameters

blocks: Iterable<T>

Returns

Array<T>

Splits the list item just before the provided list block.

Parameters

listBlock: ModelElement

The list block element.

writer: ModelWriter

The model writer.

Returns

Array<ListElement>

The array of updated blocks.