@lexical/code

ElementNode.constructor

Overrides

Methods

afterCloneFrom()

afterCloneFrom(prevNode): void

Defined in: packages/lexical-code/src/CodeNode.ts:92

Perform any state updates on the clone of prevNode that are not already handled by the constructor call in the static clone method. If you have state to update in your clone that is not handled directly by the constructor, it is advisable to override this method but it is required to include a call to super.afterCloneFrom(prevNode) in your implementation. This is only intended to be called by $cloneWithProperties function or via a super call.

Parameters

prevNode

this

Returns

void

Example

class ClassesTextNode extends TextNode {
  // Not shown: static getType, static importJSON, exportJSON, createDOM, updateDOM
  __classes = new Set<string>();
  static clone(node: ClassesTextNode): ClassesTextNode {
    // The inherited TextNode constructor is used here, so
    // classes is not set by this method.
    return new ClassesTextNode(node.__text, node.__key);
  }
  afterCloneFrom(node: this): void {
    // This calls TextNode.afterCloneFrom and LexicalNode.afterCloneFrom
    // for necessary state updates
    super.afterCloneFrom(node);
    this.__addClasses(node.__classes);
  }
  // This method is a private implementation detail, it is not
  // suitable for the public API because it does not call getWritable
  __addClasses(classNames: Iterable<string>): this {
    for (const className of classNames) {
      this.__classes.add(className);
    }
    return this;
  }
  addClass(...classNames: string[]): this {
    return this.getWritable().__addClasses(classNames);
  }
  removeClass(...classNames: string[]): this {
    const node = this.getWritable();
    for (const className of classNames) {
      this.__classes.delete(className);
    }
    return this;
  }
  getClasses(): Set<string> {
    return this.getLatest().__classes;
  }
}

Overrides

ElementNode.afterCloneFrom

canIndent()

canIndent(): false

Defined in: packages/lexical-code/src/CodeNode.ts:366

Returns

false

Overrides

ElementNode.canIndent

collapseAtStart()

collapseAtStart(): boolean

Defined in: packages/lexical-code/src/CodeNode.ts:370

Returns

boolean

Overrides

ElementNode.collapseAtStart

createDOM()

createDOM(config): HTMLElement

Defined in: packages/lexical-code/src/CodeNode.ts:100

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

config

EditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

exportDOM()

exportDOM(editor): DOMExportOutput

Defined in: packages/lexical-code/src/CodeNode.ts:175

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

editor

LexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

exportJSON()

exportJSON(): SerializedCodeNode

Defined in: packages/lexical-code/src/CodeNode.ts:278

Returns

SerializedCodeNode

Overrides

ElementNode.exportJSON

getIsSyntaxHighlightSupported()

getIsSyntaxHighlightSupported(): boolean

Defined in: packages/lexical-code/src/CodeNode.ts:394

Returns

boolean

getLanguage()

getLanguage(): undefined | null | string

Defined in: packages/lexical-code/src/CodeNode.ts:384

Returns

undefined | null | string

getTheme()

getTheme(): undefined | string

Defined in: packages/lexical-code/src/CodeNode.ts:404

Returns

undefined | string

insertNewAfter()

insertNewAfter(selection, restoreSelection): null | TabNode | ParagraphNode | CodeHighlightNode

Defined in: packages/lexical-code/src/CodeNode.ts:287

Parameters

selection

RangeSelection

restoreSelection

boolean = true

Returns

null | TabNode | ParagraphNode | CodeHighlightNode

Overrides

ElementNode.insertNewAfter

setIsSyntaxHighlightSupported()

setIsSyntaxHighlightSupported(isSupported): this

Defined in: packages/lexical-code/src/CodeNode.ts:388

Parameters

isSupported

boolean

Returns

this

setLanguage()

setLanguage(language): this

Defined in: packages/lexical-code/src/CodeNode.ts:378

Parameters

language

undefined | null | string

Returns

this

setTheme()

setTheme(theme): this

Defined in: packages/lexical-code/src/CodeNode.ts:398

Parameters

theme

undefined | null | string

Returns

this

updateDOM()

updateDOM(prevNode, dom, config): boolean

Defined in: packages/lexical-code/src/CodeNode.ts:123

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

prevNode

this

dom

HTMLElement

config

EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

updateFromJSON()

updateFromJSON(serializedNode): this

Defined in: packages/lexical-code/src/CodeNode.ts:271

If overridden, this method must call super.

Parameters

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

ElementNode.updateFromJSON

clone()

static clone(node): CodeNode

Defined in: packages/lexical-code/src/CodeNode.ts:81

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

node

Returns

Overrides

ElementNode.clone

getType()

static getType(): string

Defined in: packages/lexical-code/src/CodeNode.ts:77

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

ElementNode.getType

importDOM()

static importDOM(): null | DOMConversionMap

Defined in: packages/lexical-code/src/CodeNode.ts:200

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

importJSON()

static importJSON(serializedNode): CodeNode

Defined in: packages/lexical-code/src/CodeNode.ts:267

Parameters

serializedNode

SerializedCodeNode

Returns

ElementNode.importJSON

Overrides

Type Aliases

SerializedCodeNode

SerializedCodeNode = Spread<{ language: string | null | undefined; theme?: string; }, SerializedElementNode>

Defined in: packages/lexical-code/src/CodeNode.ts:43

Variables

CODE_LANGUAGE_FRIENDLY_NAME_MAP

const CODE_LANGUAGE_FRIENDLY_NAME_MAP: Record<string, string>

Defined in: packages/lexical-code/src/FacadePrism.ts:45

CODE_LANGUAGE_MAP

const CODE_LANGUAGE_MAP: Record<string, string>

Defined in: packages/lexical-code/src/FacadePrism.ts:65

DEFAULT_CODE_LANGUAGE

const DEFAULT_CODE_LANGUAGE: "javascript" = 'javascript'

Defined in: packages/lexical-code/src/CodeNode.ts:51

getEndOfCodeInLine()

const getEndOfCodeInLine: (anchor) => TabNode | CodeHighlightNode = $getEndOfCodeInLine

Defined in: packages/lexical-code/src/index.ts:52

Parameters

anchor

Returns

Deprecated

renamed to $getEndOfCodeInLine by @lexical/eslint-plugin rules-of-lexical

getFirstCodeNodeOfLine()

const getFirstCodeNodeOfLine: (anchor) => LineBreakNode | TabNode | CodeHighlightNode = $getFirstCodeNodeOfLine

Defined in: packages/lexical-code/src/index.ts:48

Parameters

anchor

Returns

Deprecated

renamed to $getFirstCodeNodeOfLine by @lexical/eslint-plugin rules-of-lexical

getLastCodeNodeOfLine()

const getLastCodeNodeOfLine: (anchor) => LineBreakNode | TabNode | CodeHighlightNode = $getLastCodeNodeOfLine

Defined in: packages/lexical-code/src/index.ts:50

Parameters

anchor

Returns

Deprecated

renamed to $getLastCodeNodeOfLine by @lexical/eslint-plugin rules-of-lexical

getStartOfCodeInLine()

const getStartOfCodeInLine: (anchor, offset) => null | { node: LineBreakNode | TabNode | CodeHighlightNode; offset: number; } = $getStartOfCodeInLine

Defined in: packages/lexical-code/src/index.ts:54

Parameters

anchor

offset

number

Returns

null | { node: LineBreakNode | TabNode | CodeHighlightNode; offset: number; }

Deprecated

renamed to $getStartOfCodeInLine by @lexical/eslint-plugin rules-of-lexical

PrismTokenizer

const PrismTokenizer: Tokenizer

Defined in: packages/lexical-code/src/CodeHighlighterPrism.ts:81

Functions

$createCodeHighlightNode()

$createCodeHighlightNode(text, highlightType?): CodeHighlightNode

Defined in: packages/lexical-code/src/CodeHighlightNode.ts:153

Parameters

text

string = ''

highlightType?

null | string

Returns

CodeHighlightNode

$createCodeNode()

$createCodeNode(language?, theme?): CodeNode

Defined in: packages/lexical-code/src/CodeNode.ts:409

Parameters

language?

null | string

theme?

null | string

Returns

$getEndOfCodeInLine()

$getEndOfCodeInLine(anchor): TabNode | CodeHighlightNode

Defined in: packages/lexical-code/src/FlatStructureUtils.ts:167

Parameters

anchor

Returns

$getFirstCodeNodeOfLine()

$getFirstCodeNodeOfLine(anchor): LineBreakNode | TabNode | CodeHighlightNode

Defined in: packages/lexical-code/src/FlatStructureUtils.ts:42

Parameters

anchor

Returns

$getLastCodeNodeOfLine()

$getLastCodeNodeOfLine(anchor): LineBreakNode | TabNode | CodeHighlightNode

Defined in: packages/lexical-code/src/FlatStructureUtils.ts:48

Parameters

anchor

Returns

$getStartOfCodeInLine()

$getStartOfCodeInLine(anchor, offset): null | { node: LineBreakNode | TabNode | CodeHighlightNode; offset: number; }

Defined in: packages/lexical-code/src/FlatStructureUtils.ts:54

Parameters

anchor