# list/list/utils/model module ## Classes ### [ListItemUid](module_list_list_utils_model-ListItemUid.md) _(internal)_ ## Interfaces ### `ListElement` ## Functions ### `canBecomeSimpleListItem( block, schema ) → boolean` _(internal)_ 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](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L589) #### Parameters * `block: ModelElement` A block to be tested. * `schema: ModelSchema` The schema of the document. #### Returns * `boolean` ### `expandListBlocksToCompleteItems( blocks, options = { options.withNested? } ) → Array` _(internal)_ Expands the given list of selected blocks to include the leading and tailing blocks of partially selected list items. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L201) #### Parameters * `blocks: ArrayOrItem` The list of selected blocks. * `options: object` Properties * `options.withNested?: boolean` Whether should include nested list items. Defaults to `{}` #### Returns * `Array` ### `expandListBlocksToCompleteList( blocks ) → Array` _(internal)_ Expands the given list of selected blocks to include all the items of the lists they're in. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L225) #### Parameters * `blocks: ArrayOrItem` The list of selected blocks. #### Returns * `Array` ### `getAllListItemBlocks( listItem, options = { options.higherIndent? } ) → Array` _(internal)_ 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](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L73) #### 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` ### `getListItemBlocks( listItem, options = { options.direction?, options.higherIndent? } ) → Array` _(internal)_ 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](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L97) #### 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` ### `getListItems( listItem, options? ) → Array` _(internal)_ Returns array of all blocks/items of the same list as given block (same indent, same type and properties). [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L135) #### Parameters * `listItem: ModelElement` Starting list item element. * `options?: ListWalkerOptions` Additional list walker options to modify the range of returned list items. #### Returns * `Array` ### `getNestedListBlocks( listItem ) → Array` _(internal)_ Returns a list items nested inside the given list item. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L121) #### Parameters * `listItem: ModelElement` #### Returns * `Array` ### `getSelectedBlockObject( model ) → ModelElement | null` _(internal)_ Returns a selected block object. If a selected object is inline or when there is no selected object, `null` is returned. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L566) #### Parameters * `model: Model` The instance of editor model. #### Returns * `ModelElement | null` Selected block object or `null`. ### `indentBlocks( blocks, writer, options = { options.attributeNames, options.expand?, options.indentBy? } ) → Array` _(internal)_ Increases indentation of given list blocks. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L303) #### Parameters * `blocks: ArrayOrItem` The block or iterable of blocks. * `writer: ModelWriter` The model writer. * `options: object` Additional options. Properties * `options.attributeNames: Array` 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` ### `isFirstBlockOfListItem( listBlock ) → boolean` _(internal)_ Check if the given block is the first in the list item. [See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-list/src/list/utils/model.ts#L162) #### Parameters * `listBlock: ModelNode` The list block element. #### Returns * `boolean` ### `isFirstListItemInList( listItem ) → 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 `

` 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: ```html

1. aaa
bbb