跳至主要内容

Class: QuoteNode

@lexical/rich-text.QuoteNode

繼承結構

建構子

建構子

new QuoteNode(key?): QuoteNode

參數

名稱類型
key?string

回傳值

QuoteNode

覆寫

ElementNode.constructor

定義於

packages/lexical-rich-text/src/index.ts:127

函式

canMergeWhenEmpty

canMergeWhenEmpty(): true

確定當此節點為空時,是否可以與正在插入的節點合併。

此函式在 RangeSelection.insertNodes 中被特別呼叫,以確定節點插入期間的合併行為。

回傳值

true

範例

// 在 ListItemNode 或 QuoteNode 實作中:
canMergeWhenEmpty(): true {
return true;
}

覆寫

ElementNode.canMergeWhenEmpty

定義於

packages/lexical-rich-text/src/index.ts:206


collapseAtStart

collapseAtStart(): true

回傳值

true

覆寫

ElementNode.collapseAtStart

定義於

packages/lexical-rich-text/src/index.ts:198


createDOM

createDOM(config): HTMLElement

在對此 Lexical 節點進行對比過程中,決定要插入 DOM 的節點。

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

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

參數

名稱類型說明
configEditorConfig允許在對比過程中訪問 EditorTheme 等內容(用於應用類別)。

回傳值

HTMLElement

覆寫

ElementNode.createDOM

定義於

packages/lexical-rich-text/src/index.ts:133


exportDOM

exportDOM(editor): DOMExportOutput

控制此節點如何序列化為 HTML。這對於在 Lexical 與非 Lexical 編輯器之間進行複製和粘貼,或不同命名空間的 Lexical 編輯器之間進行複製和粘貼非常重要,此時主要的傳輸格式是 HTML。如果您以其他原因序列化為 HTML(例如通過 $generateHtmlFromNodes),這也很重要。您還可以使用此函式構建自己的 HTML 渲染器。

參數

名稱類型
editorLexicalEditor

回傳值

DOMExportOutput

覆寫

ElementNode.exportDOM

定義於

packages/lexical-rich-text/src/index.ts:151


exportJSON

exportJSON(): SerializedElementNode

控制此節點如何序列化為 JSON。這對於在共享相同命名空間的 Lexical 編輯器之間進行複製和粘貼非常重要。如果您將 JSON 序列化到某處的持久性儲存中,這也很重要。請參閱 序列化與反序列化

回傳值

SerializedElementNode

覆寫

ElementNode.exportJSON

定義於

packages/lexical-rich-text/src/index.ts:181


insertNewAfter

insertNewAfter(_, restoreSelection?): ParagraphNode

參數

名稱類型
_RangeSelection
restoreSelection?boolean

回傳值

ParagraphNode

覆寫

ElementNode.insertNewAfter

定義於

packages/lexical-rich-text/src/index.ts:190

updateDOM

updateDOM(prevNode, dom): boolean

當節點發生變化時會呼叫此函式,應根據需要更新 DOM,以使其與更新過程中發生的任何變更保持一致。

如果此函式返回 "true",Lexical 將解除掛載並重新創建 DOM 節點(通過調用 createDOM)。例如,如果元素標籤發生更改,則需要這樣做。

參數

名稱類型
prevNodeQuoteNode
domHTMLElement

回傳值

boolean

覆寫

ElementNode.updateDOM

定義於

packages/lexical-rich-text/src/index.ts:138


clone

clone(node): QuoteNode

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

參數

名稱類型
nodeQuoteNode

回傳值

QuoteNode

覆寫

ElementNode.clone

定義於

packages/lexical-rich-text/src/index.ts:123


getType

getType(): string

返回此節點的字符串類型。每個節點都必須實現此函式,且它必須在編輯器中註冊的節點中保持唯一。

回傳值

string

覆寫

ElementNode.getType

定義於

packages/lexical-rich-text/src/index.ts:119


importDOM

importDOM(): null | DOMConversionMap

回傳值

null | DOMConversionMap

覆寫

ElementNode.importDOM

定義於

packages/lexical-rich-text/src/index.ts:142


importJSON

importJSON(serializedNode): QuoteNode

控制此節點如何從 JSON 反序列化。這通常是樣板程式碼,但提供了節點實作與序列化介面之間的抽象,在您對節點結構進行重大更改時(例如添加或移除屬性)可能會很重要。請參閱 序列化與反序列化

參數

名稱類型
serializedNodeSerializedQuoteNode

回傳值

QuoteNode

覆寫

ElementNode.importJSON

定義於

packages/lexical-rich-text/src/index.ts:173