Class: ListNode
@lexical/list.ListNode
Hierarchy
-
↳
ListNode
Constructors
constructor
• new ListNode(listType, start, key?): ListNode
Parameters
| Name | Type |
|---|---|
listType | ListType |
start | number |
key? | string |
Returns
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:72
Methods
append
▸ append(...nodesToAppend): this
Parameters
| Name | Type |
|---|---|
...nodesToAppend | LexicalNode[] |
Returns
this
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:191
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:183
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:187
createDOM
▸ createDOM(config, _editor?): HTMLElement
Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.
This method must return exactly one HTMLElement. Nested elements are not supported.
Do not attempt to update the Lexical EditorState during this phase of the update lifecyle.
Parameters
| Name | Type | Description |
|---|---|---|
config | EditorConfig | allows access to things like the EditorTheme (to apply classes) during reconciliation. |
_editor? | LexicalEditor | allows access to the editor for context during reconciliation. |
Returns
HTMLElement
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:100
exportDOM
▸ exportDOM(editor): DOMExportOutput
Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:157
exportJSON
▸ exportJSON(): SerializedListNode
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
packages/lexical-list/src/LexicalListNode.ts:172
extractWithChild
▸ extractWithChild(child): boolean
Parameters
| Name | Type |
|---|---|
child | LexicalNode |
Returns
boolean
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:214
getListType
▸ getListType(): ListType
Returns
Defined in
packages/lexical-list/src/LexicalListNode.ts:90
getStart
▸ getStart(): number
Returns
number
Defined in
packages/lexical-list/src/LexicalListNode.ts:94
getTag
▸ getTag(): ListNodeTagType
Returns
ListNodeTagType
Defined in
packages/lexical-list/src/LexicalListNode.ts:80
setListType
▸ setListType(type): void
Parameters
| Name | Type |
|---|---|
type | ListType |
Returns
void
Defined in
packages/lexical-list/src/LexicalListNode.ts:84
updateDOM
▸ updateDOM(prevNode, dom, config): boolean
Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.
Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.
Parameters
| Name | Type |
|---|---|
prevNode | ListNode |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:114
clone
▸ clone(node): ListNode
Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.
Parameters
| Name | Type |
|---|---|
node | ListNode |
Returns
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:66
getType
▸ getType(): string
Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.
Returns
string
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:62
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-list/src/LexicalListNode.ts:136
importJSON
▸ importJSON(serializedNode): ListNode
Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.
Parameters
| Name | Type |
|---|---|
serializedNode | SerializedListNode |
Returns
Overrides
Defined in
packages/lexical-list/src/LexicalListNode.ts:149
transform
▸ transform(): (node: LexicalNode) => void
Registers the returned function as a transform on the node during Editor initialization. Most such use cases should be addressed via the LexicalEditor.registerNodeTransform API.
Experimental - use at your own risk.
Returns
fn
▸ (node): void
Parameters
| Name | Type |
|---|---|
node | LexicalNode |
Returns
void