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:697

---

canInsertTextAfter

▸ canInsertTextAfter(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:693

---

canInsertTextBefore

▸ canInsertTextBefore(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalTextNode.ts:689

---

createDOM

▸ createDOM(config): HTMLElement

Parameters

Name	Type
config	EditorConfig

Returns

HTMLElement

Overrides

LexicalNode.createDOM

Defined in

lexical/src/nodes/LexicalTextNode.ts:367

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Overrides

LexicalNode.exportDOM

Defined in

lexical/src/nodes/LexicalTextNode.ts:510

---

exportJSON

▸ exportJSON(): SerializedTextNode

Returns

SerializedTextNode

Overrides

LexicalNode.exportJSON

Defined in

lexical/src/nodes/LexicalTextNode.ts:536

---

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

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:870

---

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:820

---

select

▸ select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

Name	Type
_anchorOffset?	number
_focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/nodes/LexicalTextNode.ts:614

---

selectionTransform

▸ selectionTransform(prevSelection, nextSelection): void

Parameters

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

Returns

void

Defined in

lexical/src/nodes/LexicalTextNode.ts:549

---

setDetail

▸ setDetail(detail): TextNode

Parameters

Name	Type
detail	number | TextDetailType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:565

---

setFormat

▸ setFormat(format): TextNode

Parameters

Name	Type
format	number | TextFormatType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:557

---

setMode

▸ setMode(type): TextNode

Parameters

Name	Type
type	TextModeType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:595

---

setStyle

▸ setStyle(style): TextNode

Parameters

Name	Type
style	string

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:572

---

setTextContent

▸ setTextContent(text): TextNode

Parameters

Name	Type
text	string

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:605

---

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:655

---

splitText

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

Parameters

Name	Type
...splitOffsets	number[]

Returns

TextNode[]

Defined in

lexical/src/nodes/LexicalTextNode.ts:701

---

toggleDirectionless

▸ toggleDirectionless(): TextNode

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:583

---

toggleFormat

▸ toggleFormat(type): TextNode

Parameters

Name	Type
type	TextFormatType

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:578

---

toggleUnmergeable

▸ toggleUnmergeable(): TextNode

Returns

TextNode

Defined in

lexical/src/nodes/LexicalTextNode.ts:589

---

updateDOM

▸ updateDOM(prevNode, dom, config): boolean

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

Parameters

Name	Type
node	TextNode

Returns

TextNode

Overrides

LexicalNode.clone

Defined in

lexical/src/nodes/LexicalTextNode.ts:288

---

getType

▸ Static getType(): string

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