@lexical/code.CodeHighlightNode
Hierarchy↳ CodeHighlightNode
• new CodeHighlightNode(text?, highlightType?, key?): CodeHighlightNode
text string '' highlightType? null | string undefined key? string undefined Returns
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:39
Methods canHaveFormat▸ canHaveFormat(): boolean
boolean
true if the text node supports font styling, false otherwise.
Overrides Defined inpackages/lexical-code/src/CodeHighlightNode.ts:71
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 lifecycle.
Parameters Name Type Descriptionconfig EditorConfig allows access to things like the EditorTheme (to apply classes) during reconciliation. Returns
HTMLElement
packages/lexical-code/src/CodeHighlightNode.ts:75
createParentElementNode▸ createParentElementNode(): ElementNode
The creation logic for any required parent. Should be implemented if isParentRequired returns true.
Returns OverridesTextNode.createParentElementNode
Defined inpackages/lexical-code/src/CodeHighlightNode.ts:136
exportJSON▸ exportJSON(): SerializedCodeHighlightNode
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.
ReturnsSerializedCodeHighlightNode
packages/lexical-code/src/CodeHighlightNode.ts:120
getHighlightType▸ getHighlightType(): undefined | null | string
undefined | null | string
packages/lexical-code/src/CodeHighlightNode.ts:60
isParentRequired▸ isParentRequired(): true
Whether or not this node has a required parent. Used during copy + paste operations to normalize nodes that would otherwise be orphaned. For example, ListItemNodes without a ListNode parent or TextNodes with a ParagraphNode parent.
Returnstrue
packages/lexical-code/src/CodeHighlightNode.ts:132
setFormat▸ setFormat(format): this
Sets the node format to the provided TextFormatType or 32-bit integer. Note that the TextFormatType version of the argument can only specify one format and doing so will remove all other formats that may be applied to the node. For toggling behavior, consider using TextNode.toggleFormat
Parameters Name Type Descriptionformat number TextFormatType or 32-bit integer representing the node format. Returns
this
this TextNode. // TODO 0.12 This should just be a string.
packages/lexical-code/src/CodeHighlightNode.ts:128
setHighlightType▸ setHighlightType(highlightType?): this
highlightType? null | string Returns
this
packages/lexical-code/src/CodeHighlightNode.ts:65
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 Returnsboolean
packages/lexical-code/src/CodeHighlightNode.ts:85
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 Returnsthis
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);
}
}
packages/lexical-code/src/CodeHighlightNode.ts:112
clone▸ clone(node): CodeHighlightNode
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 Returns Overrides Defined inpackages/lexical-code/src/CodeHighlightNode.ts:52
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.
Returnsstring
packages/lexical-code/src/CodeHighlightNode.ts:48
importJSON▸ importJSON(serializedNode): CodeHighlightNode
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 TypeserializedNode SerializedCodeHighlightNode Returns
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:106
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4