Class: CodeNode
@lexical/code.CodeNode
Hierarchy
-
↳
CodeNode
Constructors
constructor
• new CodeNode(language?, key?): CodeNode
Parameters
| Name | Type |
|---|---|
language? | null | string |
key? | string |
Returns
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:90
Methods
canIndent
▸ canIndent(): false
Returns
false
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:311
collapseAtStart
▸ collapseAtStart(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:315
createDOM
▸ createDOM(config): 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. |
Returns
HTMLElement
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:97
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-code/src/CodeNode.ts:133
exportJSON
▸ exportJSON(): SerializedCodeNode
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-code/src/CodeNode.ts:225
getIsSyntaxHighlightSupported
▸ getIsSyntaxHighlightSupported(): boolean
Returns
boolean
Defined in
packages/lexical-code/src/CodeNode.ts:335
getLanguage
▸ getLanguage(): undefined | null | string
Returns
undefined | null | string
Defined in
packages/lexical-code/src/CodeNode.ts:331
insertNewAfter
▸ insertNewAfter(selection, restoreSelection?): null | TabNode | ParagraphNode | CodeHighlightNode
Parameters
| Name | Type | Default value |
|---|---|---|
selection | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
null | TabNode | ParagraphNode | CodeHighlightNode
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:233
setLanguage
▸ setLanguage(language): this
Parameters
| Name | Type |
|---|---|
language | undefined | null | string |
Returns
this
Defined in
packages/lexical-code/src/CodeNode.ts:323
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 | this |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:111
updateFromJSON
▸ updateFromJSON(serializedNode): this
Update this LexicalNode instance from serialized JSON. It's recommended to implement as much logic as possible in this method instead of the static importJSON method, so that the functionality can be inherited in subclasses.
The LexicalUpdateJSON utility type should be used to ignore any type, version, or children properties in the JSON so that the extended JSON from subclasses are acceptable parameters for the super call.
If overridden, this method must call super.
Parameters
| Name | Type |
|---|---|
serializedNode | LexicalUpdateJSON<SerializedCodeNode> |
Returns
this
Example
class MyTextNode extends TextNode {
// ...
static importJSON(serializedNode: SerializedMyTextNode): MyTextNode {
return $createMyTextNode()
.updateFromJSON(serializedNode);
}
updateFromJSON(
serializedNode: LexicalUpdateJSON<SerializedMyTextNode>,
): this {
return super.updateFromJSON(serializedNode)
.setMyProperty(serializedNode.myProperty);
}
}
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:219
clone
▸ clone(node): CodeNode
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 | CodeNode |
Returns
Overrides
Defined in
packages/lexical-code/src/CodeNode.ts:86
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-code/src/CodeNode.ts:82
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-code/src/CodeNode.ts:148
importJSON
▸ importJSON(serializedNode): CodeNode
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 | SerializedCodeNode |