Class: OverflowNode
@lexical/overflow.OverflowNode
繼承結構
-
↳
OverflowNode
建構子
constructor
• new OverflowNode(key?): OverflowNode
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
key? | string | (選擇性) 節點的鍵值 |
返回
覆寫
定義於
packages/lexical-overflow/src/index.ts:39
函式
createDOM
▸ createDOM(config): HTMLElement
在重新和諧處理過程中被調用，以決定要將哪些節點插入到此 Lexical 節點的 DOM 中。
此函式必須返回一個 HTMLElement。不支持嵌套元素。
在此更新生命周期階段，請勿嘗試更新 Lexical EditorState。
參數
| 名稱 | 類型 | 描述 |
|---|---|---|
config | EditorConfig | 允許在重新和諧過程中訪問編輯器主題等設置（例如應用類別）。 |
返回
HTMLElement
覆寫
定義於
packages/lexical-overflow/src/index.ts:51
excludeFromCopy
▸ excludeFromCopy(): boolean
返回
boolean
覆寫
定義於
packages/lexical-overflow/src/index.ts:72
exportJSON
▸ exportJSON(): SerializedElementNode
控制此節點如何序列化為 JSON。這對於在共享相同命名空間的 Lexical 編輯器之間進行複製和粘貼非常重要。如果你將 JSON 用於持久存儲，也非常重要。 參見 序列化與反序列化。
返回
覆寫
定義於
packages/lexical-overflow/src/index.ts:44
insertNewAfter
▸ insertNewAfter(selection, restoreSelection?): null | LexicalNode
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
selection | RangeSelection | undefined |
restoreSelection | boolean | true |
返回
null | LexicalNode
覆寫
定義於
packages/lexical-overflow/src/index.ts:64
updateDOM
▸ updateDOM(prevNode, dom): boolean
當節點發生變化時調用此函式，並應更新 DOM 以使其與更新期間可能發生的任何變化對齊。
返回 "true" 會導致 lexical 卸載並重新創建 DOM 節點（通過調用 createDOM）。例如，當元素標籤發生變化時，你需要這樣做。
參數
| 名稱 | 類型 |
|---|---|
prevNode | OverflowNode |
dom | HTMLElement |
返回
boolean
覆寫
定義於
packages/lexical-overflow/src/index.ts:60
clone
▸ clone(node): OverflowNode
克隆此節點，創建一個具有不同鍵的新節點，並將其添加到 EditorState（但不附加到任何地方！）。所有節點都必須實現此函式。
參數
| 名稱 | 類型 |
|---|---|
node | OverflowNode |
返回
覆寫
定義於
packages/lexical-overflow/src/index.ts:27
getType
▸ getType(): string
返回此節點的字符串類型。每個節點必須實現此函式，且必須在編輯器中註冊的節點之間唯一。
返回
string
覆寫
定義於
packages/lexical-overflow/src/index.ts:23
importDOM
▸ importDOM(): null
返回
null
覆寫
ElementNode.importDOM
定義於
packages/lexical-overflow/src/index.ts:35
importJSON
▸ importJSON(serializedNode): OverflowNode
控制此節點如何從 JSON 反序列化。這通常是模板代碼，但提供了節點實現和序列化介面之間的抽象，這在你進行破壞性變更（例如添加或移除屬性）時可能很重要。 參見 序列化與反序列化。
參數
| 名稱 | 類型 |
|---|---|
serializedNode | SerializedOverflowNode |