Class: ListItemNode
@lexical/list.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:74
Methods
append
▸ append(...nodes
): ListItemNode
Parameters
Name | Type |
---|---|
...nodes | LexicalNode [] |
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:168
canInsertAfter
▸ canInsertAfter(node
): boolean
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:423
canMergeWith
▸ canMergeWith(node
): boolean
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:431
canReplaceWith
▸ canReplaceWith(replacement
): boolean
Parameters
Name | Type |
---|---|
replacement | LexicalNode |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:427
collapseAtStart
▸ collapseAtStart(selection
): true
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
true
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:309
createDOM
▸ createDOM(config
): HTMLElement
Parameters
Name | Type |
---|---|
config | EditorConfig |
Returns
HTMLElement
Overrides
ElementNode.createDOM
Defined in
lexical-list/src/LexicalListItemNode.ts:80
createParentElementNode
▸ createParentElementNode(): ElementNode
Returns
Overrides
ElementNode.createParentElementNode
Defined in
lexical-list/src/LexicalListItemNode.ts:457
exportDOM
▸ exportDOM(editor
): DOMExportOutput
Parameters
Name | Type |
---|---|
editor | LexicalEditor |
Returns
Overrides
ElementNode.exportDOM
Defined in
lexical-list/src/LexicalListItemNode.ts:128
exportJSON
▸ exportJSON(): SerializedListItemNode
Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:158
extractWithChild
▸ extractWithChild(child
, selection
): boolean
Parameters
Name | Type |
---|---|
child | LexicalNode |
selection | RangeSelection | NodeSelection | GridSelection |
Returns
boolean
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:435
getChecked
▸ getChecked(): undefined
| boolean
Returns
undefined
| boolean
Defined in
lexical-list/src/LexicalListItemNode.ts:359
getIndent
▸ getIndent(): number
Returns
number
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:374
getValue
▸ getValue(): number
Returns
number
Defined in
lexical-list/src/LexicalListItemNode.ts:348
insertAfter
▸ insertAfter(node
, restoreSelection?
): LexicalNode
Parameters
Name | Type | Default value |
---|---|---|
node | LexicalNode | undefined |
restoreSelection | boolean | true |
Returns
Overrides
ElementNode.insertAfter
Defined in
lexical-list/src/LexicalListItemNode.ts:222
insertBefore
▸ insertBefore(nodeToInsert
): LexicalNode
Parameters
Name | Type |
---|---|
nodeToInsert | LexicalNode |
Returns
Overrides
ElementNode.insertBefore
Defined in
lexical-list/src/LexicalListItemNode.ts:410
insertNewAfter
▸ insertNewAfter(_
, restoreSelection?
): ParagraphNode
| ListItemNode
Parameters
Name | Type | Default value |
---|---|---|
_ | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:297
isParentRequired
▸ isParentRequired(): true
Returns
true
Overrides
ElementNode.isParentRequired
Defined in
lexical-list/src/LexicalListItemNode.ts:453
remove
▸ remove(preserveEmptyParent?
): void
Parameters
Name | Type |
---|---|
preserveEmptyParent? | boolean |
Returns
void
Overrides
ElementNode.remove
Defined in
lexical-list/src/LexicalListItemNode.ts:275
replace
▸ replace<N
>(replaceWithNode
, includeChildren?
): N
Type parameters
Name | Type |
---|---|
N | extends LexicalNode <N > |
Parameters
Name | Type |
---|---|
replaceWithNode | N |
includeChildren? | boolean |
Returns
N
Overrides
ElementNode.replace
Defined in
lexical-list/src/LexicalListItemNode.ts:184
setChecked
▸ setChecked(checked?
): void
Parameters
Name | Type |
---|---|
checked? | boolean |
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:365
setIndent
▸ setIndent(indent
): ListItemNode
Parameters
Name | Type |
---|---|
indent | number |
Returns
Overrides
Defined in
lexical-list/src/LexicalListItemNode.ts:391
setValue
▸ setValue(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:354
toggleChecked
▸ toggleChecked(): void
Returns
void
Defined in
lexical-list/src/LexicalListItemNode.ts:370
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:91
clone
▸ Static
clone(node
): ListItemNode
Parameters
Name | Type |
---|---|
node | ListItemNode |
Returns
Overrides
ElementNode.clone
Defined in
lexical-list/src/LexicalListItemNode.ts:70
getType
▸ Static
getType(): string
Returns
string
Overrides
ElementNode.getType
Defined in
lexical-list/src/LexicalListItemNode.ts:66
importDOM
▸ Static
importDOM(): null
| DOMConversionMap
<HTMLElement
>
Returns
null
| DOMConversionMap
<HTMLElement
>
Defined in
lexical-list/src/LexicalListItemNode.ts:119
importJSON
▸ Static
importJSON(serializedNode
): ListItemNode
Parameters
Name | Type |
---|---|
serializedNode | SerializedListItemNode |
Returns
Overrides
ElementNode.importJSON
Defined in
lexical-list/src/LexicalListItemNode.ts:151
transform
▸ Static
transform(): (node
: LexicalNode
) => void
Returns
fn
▸ (node
): void
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
void
Overrides
ElementNode.transform
Defined in
lexical-list/src/LexicalListItemNode.ts:107