Skip to main content

Class: TabNode

lexical.TabNode

Hierarchy

Constructors

constructor

new TabNode(key?): TabNode

Parameters

NameType
key?string

Returns

TabNode

Overrides

TextNode.constructor

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:40

Methods

canInsertTextAfter

canInsertTextAfter(): boolean

This method is meant to be overriden by TextNode subclasses to control the behavior of those nodes when a user event would cause text to be inserted after them in the editor. If true, Lexical will attempt to insert text into this node. If false, it will insert the text in a new sibling node.

Returns

boolean

true if text can be inserted after the node, false otherwise.

Overrides

TextNode.canInsertTextAfter

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:80


canInsertTextBefore

canInsertTextBefore(): boolean

This method is meant to be overriden by TextNode subclasses to control the behavior of those nodes when a user event would cause text to be inserted before them in the editor. If true, Lexical will attempt to insert text into this node. If false, it will insert the text in a new sibling node.

Returns

boolean

true if text can be inserted before the node, false otherwise.

Overrides

TextNode.canInsertTextBefore

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:76


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

TextNode.exportJSON

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:56


setDetail

setDetail(_detail): this

Sets the node detail to the provided TextDetailType or 32-bit integer. Note that the TextDetailType version of the argument can only specify one detail value and doing so will remove all other detail values that may be applied to the node. For toggling behavior, consider using TextNode.toggleDirectionless or TextNode.togglerUnmergeable

Parameters

NameTypeDescription
_detailnumber | TextDetailTypeTextDetailType or 32-bit integer representing the node detail.

Returns

this

this TextNode. // TODO 0.12 This should just be a string.

Overrides

TextNode.setDetail

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:68


setMode

setMode(_type): this

Sets the mode of the node.

Parameters

NameType
_typeTextModeType

Returns

this

this TextNode.

Overrides

TextNode.setMode

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:72


setTextContent

setTextContent(_text): this

Sets the text content of the node.

Parameters

NameTypeDescription
_textstringthe string to set as the text value of the node.

Returns

this

this TextNode.

Overrides

TextNode.setTextContent

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:64


clone

clone(node): TabNode

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

NameType
nodeTabNode

Returns

TabNode

Overrides

TextNode.clone

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:31


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

TextNode.getType

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:27


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

TextNode.importDOM

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:45


importJSON

importJSON(serializedTabNode): TabNode

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

NameType
serializedTabNodeSerializedTextNode

Returns

TabNode

Overrides

TextNode.importJSON

Defined in

packages/lexical/src/nodes/LexicalTabNode.ts:49