Module: @lexical/list
Classes
Type Aliases
ListType
Ƭ ListType: "number" | "bullet" | "check"
Defined in
lexical-list/src/LexicalListNode.ts:43
SerializedListItemNode
Ƭ SerializedListItemNode: Spread<{ checked: boolean | undefined ; type: "listitem" ; value: number ; version: 1 }, SerializedElementNode>
Defined in
lexical-list/src/LexicalListItemNode.ts:46
SerializedListNode
Ƭ SerializedListNode: Spread<{ listType: ListType ; start: number ; tag: ListNodeTagType ; type: "list" ; version: 1 }, SerializedElementNode>
Defined in
lexical-list/src/LexicalListNode.ts:32
Variables
INSERT_CHECK_LIST_COMMAND
• Const INSERT_CHECK_LIST_COMMAND: LexicalCommand<void>
Defined in
lexical-list/src/index.ts:54
INSERT_ORDERED_LIST_COMMAND
• Const INSERT_ORDERED_LIST_COMMAND: LexicalCommand<void>
Defined in
lexical-list/src/index.ts:51
INSERT_UNORDERED_LIST_COMMAND
• Const INSERT_UNORDERED_LIST_COMMAND: LexicalCommand<void>
Defined in
lexical-list/src/index.ts:49
REMOVE_LIST_COMMAND
• Const REMOVE_LIST_COMMAND: LexicalCommand<void>
Defined in
lexical-list/src/index.ts:57
Functions
$createListItemNode
▸ $createListItemNode(checked?): ListItemNode
Parameters
| Name | Type |
|---|---|
checked? | boolean |
Returns
Defined in
lexical-list/src/LexicalListItemNode.ts:524
$createListNode
▸ $createListNode(listType, start?): ListNode
Parameters
| Name | Type | Default value |
|---|---|---|
listType | ListType | undefined |
start | number | 1 |
Returns
Defined in
lexical-list/src/LexicalListNode.ts:285
$getListDepth
▸ $getListDepth(listNode): number
Parameters
| Name | Type |
|---|---|
listNode | ListNode |
Returns
number
Defined in
lexical-list/src/utils.ts:21
$handleListInsertParagraph
▸ $handleListInsertParagraph(): boolean
Returns
boolean
Defined in
lexical-list/src/formatList.ts:473
$isListItemNode
▸ $isListItemNode(node): node is ListItemNode
Parameters
| Name | Type |
|---|---|
node | undefined | null | LexicalNode |
Returns
node is ListItemNode
Defined in
lexical-list/src/LexicalListItemNode.ts:528
$isListNode
▸ $isListNode(node): node is ListNode
Parameters
| Name | Type |
|---|---|
node | undefined | null | LexicalNode |
Returns
node is ListNode
Defined in
lexical-list/src/LexicalListNode.ts:289
indentList
▸ indentList(): void
Returns
void
Defined in
lexical-list/src/formatList.ts:465
insertList
▸ insertList(editor, listType): void
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
listType | ListType |
Returns
void
Defined in
lexical-list/src/formatList.ts:85
outdentList
▸ outdentList(): void
Returns
void
Defined in
lexical-list/src/formatList.ts:469
removeList
▸ removeList(editor): void
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
void
Defined in
lexical-list/src/formatList.ts:212