跳至主要内容

Class: HashtagNode

@lexical/hashtag.HashtagNode

階層結構

建構子

constructor

new HashtagNode(text, key?): HashtagNode

參數

名稱類型
textstring
key?string

回傳值

HashtagNode

覆寫自

TextNode.constructor

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:29

函式

canInsertTextBefore

canInsertTextBefore(): boolean

此函式應由 TextNode 子類別覆寫,以控制在使用者事件發生時,文字插入此節點之前的行為。如果回傳 true,Lexical 將嘗試將文字插入此節點。如果回傳 false,則會將文字插入新的兄弟節點。

回傳值

boolean

如果可以在節點之前插入文字,則回傳 true,否則回傳 false

覆寫自

TextNode.canInsertTextBefore

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:55


createDOM

createDOM(config): HTMLElement

在對此 Lexical 節點進行對比時調用,以決定插入 DOM 的節點。

此函式必須回傳一個 HTMLElement。嵌套元素不支援。

請勿在此更新生命週期階段中嘗試更新 Lexical EditorState。

參數

名稱類型描述
configEditorConfig允許在對比過程中訪問像是 EditorTheme 的東西(用於應用類別)。

回傳值

HTMLElement

覆寫自

TextNode.createDOM

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:33


exportJSON

exportJSON(): SerializedTextNode

控制此節點如何序列化為 JSON。這對於在共享相同命名空間的 Lexical 編輯器之間的複製和粘貼非常重要。對於持久性存儲來說,也很重要。 參見序列化與反序列化

回傳值

SerializedTextNode

覆寫自

TextNode.exportJSON

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:48


isTextEntity

isTextEntity(): true

此函式應由 TextNode 子類別覆寫,以控制在使用 registerLexicalTextEntity 函式時,這些節點的行為。如果使用 registerLexicalTextEntity,則您創建並替換匹配文字的節點類別應回傳 true

回傳值

true

如果節點應被視為「文字實體」,則回傳 true,否則回傳 false

覆寫自

TextNode.isTextEntity

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:59


clone

clone(node): HashtagNode

複製此節點,創建一個具有不同 key 的新節點,並將其添加到 EditorState 中(但不附加到任何位置)。所有節點都必須實現此函式。

參數

名稱類型
nodeHashtagNode

回傳值

HashtagNode

覆寫自

TextNode.clone

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:25


getType

getType(): string

回傳此節點的字串類型。每個節點必須實現此函式,並且在編輯器中註冊的節點之間必須唯一。

回傳值

string

覆寫自

TextNode.getType

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:21


importJSON

importJSON(serializedNode): HashtagNode

控制此節點如何從 JSON 反序列化。這通常是樣板,但為節點實現與序列化介面之間提供了抽象,這在您需要對節點架構進行破壞性更改(例如添加或移除屬性)時可能很重要。 參見序列化與反序列化

參數

名稱類型
serializedNodeSerializedTextNode

回傳值

HashtagNode

覆寫自

TextNode.importJSON

定義於

packages/lexical-hashtag/src/LexicalHashtagNode.ts:39