Class: TabNode
lexical.TabNode
Hierarchy
↳
TabNode
Constructors
constructor
• new TabNode(key?)
Parameters
| Name | Type |
|---|---|
key? | string |
Overrides
Defined in
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
Defined in
lexical/src/nodes/LexicalTabNode.ts:89
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
Defined in
lexical/src/nodes/LexicalTabNode.ts:85
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
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:56
setDetail
▸ setDetail(_detail): TabNode
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 toggleDirectionless or TextNode.togglerUnmergeable
Parameters
| Name | Type | Description |
|---|---|---|
_detail | number | TextDetailType | TextDetailType or 32-bit integer representing the node detail. |
Returns
this TextNode.
// TODO 0.12 This should just be a string.
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:77
setMode
▸ setMode(_type): TabNode
Sets the mode of the node.
Parameters
| Name | Type |
|---|---|
_type | TextModeType |
Returns
this TextNode.
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:81
setTextContent
▸ setTextContent(_text): TabNode
Sets the text content of the node.
Parameters
| Name | Type | Description |
|---|---|---|
_text | string | the string to set as the text value of the node. |
Returns
this TextNode.
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:64
spliceText
▸ spliceText(_offset, _delCount, _newText, _moveSelection?): TextNode
Inserts the provided text into this TextNode at the provided offset, deleting the number of characters specified. Can optionally calculate a new selection after the operation is complete.
Parameters
| Name | Type | Description |
|---|---|---|
_offset | number | the offset at which the splice operation should begin. |
_delCount | number | the number of characters to delete, starting from the offset. |
_newText | string | the text to insert into the TextNode at the offset. |
_moveSelection? | boolean | optional, whether or not to move selection to the end of the inserted substring. |
Returns
this TextNode.
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:68
clone
▸ Static 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
| Name | Type |
|---|---|
node | TabNode |
Returns
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:31
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
Defined in
lexical/src/nodes/LexicalTabNode.ts:27
importDOM
▸ Static importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:45
importJSON
▸ Static 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
| Name | Type |
|---|---|
serializedTabNode | SerializedTextNode |
Returns
Overrides
Defined in
lexical/src/nodes/LexicalTabNode.ts:49