Skip to main content

Module: @lexical/list

Classes

Type Aliases

ListType

Ƭ ListType: "number" | "bullet" | "check"

Defined in

lexical-list/src/LexicalListNode.ts:45


SerializedListItemNode

Ƭ SerializedListItemNode: Spread<{ checked: boolean | undefined ; type: "listitem" ; value: number ; version: 1 }, SerializedElementNode>

Defined in

lexical-list/src/LexicalListItemNode.ts:47


SerializedListNode

Ƭ SerializedListNode: Spread<{ listType: ListType ; start: number ; tag: ListNodeTagType ; type: "list" ; version: 1 }, SerializedElementNode>

Defined in

lexical-list/src/LexicalListNode.ts:34

Variables

INSERT_CHECK_LIST_COMMAND

Const INSERT_CHECK_LIST_COMMAND: LexicalCommand<void>

Defined in

lexical-list/src/index.ts:46


INSERT_ORDERED_LIST_COMMAND

Const INSERT_ORDERED_LIST_COMMAND: LexicalCommand<void>

Defined in

lexical-list/src/index.ts:43


INSERT_UNORDERED_LIST_COMMAND

Const INSERT_UNORDERED_LIST_COMMAND: LexicalCommand<void>

Defined in

lexical-list/src/index.ts:41


REMOVE_LIST_COMMAND

Const REMOVE_LIST_COMMAND: LexicalCommand<void>

Defined in

lexical-list/src/index.ts:49

Functions

$createListItemNode

$createListItemNode(checked?): ListItemNode

Parameters

NameType
checked?boolean

Returns

ListItemNode

Defined in

lexical-list/src/LexicalListItemNode.ts:521


$createListNode

$createListNode(listType, start?): ListNode

Parameters

NameTypeDefault value
listTypeListTypeundefined
startnumber1

Returns

ListNode

Defined in

lexical-list/src/LexicalListNode.ts:311


$getListDepth

$getListDepth(listNode): number

Parameters

NameType
listNodeListNode

Returns

number

Defined in

lexical-list/src/utils.ts:21


$handleListInsertParagraph

$handleListInsertParagraph(): boolean

Returns

boolean

Defined in

lexical-list/src/formatList.ts:425


$isListItemNode

$isListItemNode(node): node is ListItemNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is ListItemNode

Defined in

lexical-list/src/LexicalListItemNode.ts:525


$isListNode

$isListNode(node): node is ListNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is ListNode

Defined in

lexical-list/src/LexicalListNode.ts:315


insertList

insertList(editor, listType): void

Parameters

NameType
editorLexicalEditor
listTypeListType

Returns

void

Defined in

lexical-list/src/formatList.ts:83


removeList

removeList(editor): void

Parameters

NameType
editorLexicalEditor

Returns

void

Defined in

lexical-list/src/formatList.ts:210