Class: HashtagNode
@lexical/hashtag.HashtagNode
Hierarchy
↳
HashtagNode
Constructors
constructor
• new HashtagNode(text, key?)
Parameters
| Name | Type |
|---|---|
text | string |
key? | string |
Overrides
Defined in
packages/lexical-hashtag/src/LexicalHashtagNode.ts:29
Methods
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
packages/lexical-hashtag/src/LexicalHashtagNode.ts:55
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
Defined in
packages/lexical-hashtag/src/LexicalHashtagNode.ts:33
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
packages/lexical-hashtag/src/LexicalHashtagNode.ts:48
isTextEntity
▸ isTextEntity(): true
This method is meant to be overriden by TextNode subclasses to control the behavior of those nodes when used with the registerLexicalTextEntity function. If you're using registerLexicalTextEntity, the node class that you create and replace matched text with should return true from this method.
Returns
true
true if the node is to be treated as a "text entity", false otherwise.
Overrides
Defined in
packages/lexical-hashtag/src/LexicalHashtagNode.ts:59
clone
▸ Static clone(node): HashtagNode
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 | HashtagNode |
Returns
Overrides
Defined in
packages/lexical-hashtag/src/LexicalHashtagNode.ts:25
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
packages/lexical-hashtag/src/LexicalHashtagNode.ts:21
importJSON
▸ Static importJSON(serializedNode): HashtagNode
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 |
|---|---|
serializedNode | SerializedTextNode |
Returns
Overrides
Defined in
packages/lexical-hashtag/src/LexicalHashtagNode.ts:39