Class: ListItemNode
lexical-list/src.ListItemNode
Hierarchy
↳
ListItemNode
Constructors
constructor
• new ListItemNode(value?
, checked?
, key?
)
Parameters
Name | Type |
---|---|
value? | number |
checked? | boolean |
key? | string |
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:70
Methods
append
▸ append(...nodes
): ListItemNode
Parameters
Name | Type |
---|---|
...nodes | LexicalNode [] |
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:136
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:361
canInsertAfter
▸ canInsertAfter(node
): boolean
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:380
canMergeWith
▸ canMergeWith(node
): boolean
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:388
canReplaceWith
▸ canReplaceWith(replacement
): boolean
Parameters
Name | Type |
---|---|
replacement | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:384
collapseAtStart
▸ collapseAtStart(selection
): true
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
true
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:265
createDOM
▸ createDOM(config
): HTMLElement
Parameters
Name | Type |
---|---|
config | EditorConfig |
Returns
HTMLElement
Overrides
ElementNode.createDOM
Defined in
lexical-list/src/LexicalListItemNode.ts:76
exportJSON
▸ exportJSON(): SerializedListItemNode
Returns
SerializedListItemNode
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:126
extractWithChild
▸ extractWithChild(child
, selection
): boolean
Parameters
Name | Type |
---|---|
child | LexicalNode |
selection | RangeSelection | NodeSelection | GridSelection |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:392
getChecked
▸ getChecked(): undefined
| boolean
Returns
undefined
| boolean
Defined in
lexical-list/src/LexicalListItemNode.ts:314
getIndent
▸ getIndent(): number
Returns
number
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:329
getValue
▸ getValue(): number
Returns
number
Defined in
lexical-list/src/LexicalListItemNode.ts:303
insertAfter
▸ insertAfter(node
): LexicalNode
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
Overrides
ElementNode.insertAfter
Defined in
lexical-list/src/LexicalListItemNode.ts:190
insertBefore
▸ insertBefore(nodeToInsert
): LexicalNode
Parameters
Name | Type |
---|---|
nodeToInsert | LexicalNode |
Returns
Overrides
ElementNode.insertBefore
Defined in
lexical-list/src/LexicalListItemNode.ts:367
insertNewAfter
▸ insertNewAfter(): ParagraphNode
| ListItemNode
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:256
remove
▸ remove(preserveEmptyParent?
): void
Parameters
Name | Type |
---|---|
preserveEmptyParent? | boolean |
Returns
void
Overrides
ElementNode.remove
Defined in
lexical-list/src/LexicalListItemNode.ts:243
replace
▸ replace<N
>(replaceWithNode
): N
Type parameters
Name | Type |
---|---|
N | extends LexicalNode <N > |
Parameters
Name | Type |
---|---|
replaceWithNode | N |
Returns
N
Overrides
ElementNode.replace
Defined in
lexical-list/src/LexicalListItemNode.ts:152
setChecked
▸ setChecked(checked?
): void
Parameters
Name | Type |
---|---|
checked? | boolean |
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:320
setIndent
▸ setIndent(indent
): ListItemNode
Parameters
Name | Type |
---|---|
indent | number |
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:346
setValue
▸ setValue(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:309
toggleChecked
▸ toggleChecked(): void
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:325
updateDOM
▸ updateDOM(prevNode
, dom
, config
): boolean
Parameters
Name | Type |
---|---|
prevNode | ListItemNode |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
ElementNode.updateDOM
Defined in
lexical-list/src/LexicalListItemNode.ts:90
clone
▸ Static
clone(node
): ListItemNode
Parameters
Name | Type |
---|---|
node | ListItemNode |
Returns
Overrides
ElementNode.clone
Defined in
lexical-list/src/LexicalListItemNode.ts:66
getType
▸ Static
getType(): string
Returns
string
Overrides
ElementNode.getType
Defined in
lexical-list/src/LexicalListItemNode.ts:62
importDOM
▸ Static
importDOM(): null
| DOMConversionMap
<HTMLElement
>
Returns
null
| DOMConversionMap
<HTMLElement
>
Defined in
lexical-list/src/LexicalListItemNode.ts:109
importJSON
▸ Static
importJSON(serializedNode
): ListItemNode
Parameters
Name | Type |
---|---|
serializedNode | SerializedListItemNode |
Returns
Overrides
ElementNode.importJSON
Defined in
lexical-list/src/LexicalListItemNode.ts:118