Class: TextNode

lexical.TextNode

Hierarchy

• LexicalNode

  ↳ TextNode

  ↳↳ CodeHighlightNode

  ↳↳ HashtagNode

Constructors

constructor

• new TextNode(text, key?)

Parameters

Name	Type
text	string
key?	string

Overrides

LexicalNode.constructor

Defined in

lexical/src/nodes/LexicalTextNode.ts:292

Properties

__text

• __text: string

Defined in

lexical/src/nodes/LexicalTextNode.ts:274

Methods

canContainTabs

▸ canContainTabs(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:706

---

canInsertTextAfter

▸ canInsertTextAfter(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:702

---

canInsertTextBefore

▸ canInsertTextBefore(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:698

---

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

LexicalNode.createDOM

Defined in

lexical/src/nodes/LexicalTextNode.ts:367

---

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

DOMExportOutput

Overrides

LexicalNode.exportDOM

Defined in

lexical/src/nodes/LexicalTextNode.ts:519

---

exportJSON

▸ exportJSON(): SerializedTextNode

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

SerializedTextNode

Overrides

LexicalNode.exportJSON

Defined in

lexical/src/nodes/LexicalTextNode.ts:545

---

getDetail

▸ getDetail(): number

Returns

number

Defined in

lexical/src/nodes/LexicalTextNode.ts:306

---

getFormat

▸ getFormat(): number

Returns

number

Defined in

lexical/src/nodes/LexicalTextNode.ts:301

---

getFormatFlags

▸ getFormatFlags(type, alignWithFormat): number

Parameters

Name	Type
type	TextFormatType
alignWithFormat	null | number

Returns

number

Defined in

lexical/src/nodes/LexicalTextNode.ts:359

---

getMode

▸ getMode(): TextModeType

Returns

TextModeType

Defined in

lexical/src/nodes/LexicalTextNode.ts:311

---

getStyle

▸ getStyle(): string

Returns

string

Defined in

lexical/src/nodes/LexicalTextNode.ts:316

---

getTextContent

▸ getTextContent(): string

Returns the text content of the node. Override this for custom nodes that should have a representation in plain text format (for copy + paste, for example)

Returns

string

Overrides

LexicalNode.getTextContent

Defined in

lexical/src/nodes/LexicalTextNode.ts:354

---

hasFormat

▸ hasFormat(type): boolean

Parameters

Name	Type
type	TextFormatType

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:345

---

isComposing

▸ isComposing(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:326

---

isDirectionless

▸ isDirectionless(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:335

---

isSegmented

▸ isSegmented(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:330

---

isSimpleText

▸ isSimpleText(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:350

---

isTextEntity

▸ isTextEntity(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:879

---

isToken

▸ isToken(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:321

---

isUnmergeable

▸ isUnmergeable(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:340

---

mergeWithSibling

▸ mergeWithSibling(target): TextNode

Parameters

Name	Type
target	TextNode

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:829

---

select

▸ select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

Name	Type
_anchorOffset?	number
_focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/nodes/LexicalTextNode.ts:623

---

selectionTransform

▸ selectionTransform(prevSelection, nextSelection): void

Parameters

Name	Type
prevSelection	null | RangeSelection | NodeSelection | GridSelection
nextSelection	RangeSelection

Returns

void

Defined in

lexical/src/nodes/LexicalTextNode.ts:558

---

setDetail

▸ setDetail(detail): TextNode

Parameters

Name	Type
detail	number | TextDetailType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:574

---

setFormat

▸ setFormat(format): TextNode

Parameters

Name	Type
format	number | TextFormatType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:566

---

setMode

▸ setMode(type): TextNode

Parameters

Name	Type
type	TextModeType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:604

---

setStyle

▸ setStyle(style): TextNode

Parameters

Name	Type
style	string

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:581

---

setTextContent

▸ setTextContent(text): TextNode

Parameters

Name	Type
text	string

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:614

---

spliceText

▸ spliceText(offset, delCount, newText, moveSelection?): TextNode

Parameters

Name	Type
offset	number
delCount	number
newText	string
moveSelection?	boolean

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:664

---

splitText

▸ splitText(...splitOffsets): TextNode[]

Parameters

Name	Type
...splitOffsets	number[]

Returns

TextNode[]

Defined in

lexical/src/nodes/LexicalTextNode.ts:710

---

toggleDirectionless

▸ toggleDirectionless(): TextNode

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:592

---

toggleFormat

▸ toggleFormat(type): TextNode

Parameters

Name	Type
type	TextFormatType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:587

---

toggleUnmergeable

▸ toggleUnmergeable(): TextNode

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:598

---

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	TextNode
dom	HTMLElement
config	EditorConfig

Returns

boolean

Overrides

LexicalNode.updateDOM

Defined in

lexical/src/nodes/LexicalTextNode.ts:387

---

clone

▸ Static clone(node): TextNode

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	TextNode

Returns

TextNode

Overrides

LexicalNode.clone

Defined in

lexical/src/nodes/LexicalTextNode.ts:288

---

getType

▸ Static 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

LexicalNode.getType

Defined in

lexical/src/nodes/LexicalTextNode.ts:284

---

importDOM

▸ Static importDOM(): null | DOMConversionMap<HTMLElement>

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical/src/nodes/LexicalTextNode.ts:454

---

importJSON

▸ Static importJSON(serializedNode): TextNode

Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction betweent he node implementation and serialized interfaec 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	SerializedTextNode

Returns

TextNode

Overrides

LexicalNode.importJSON

Defined in

lexical/src/nodes/LexicalTextNode.ts:507