跳至主要内容

Class: MarkNode

@lexical/mark.MarkNode

繼承結構

建構函式

constructor

new MarkNode(ids, key?): MarkNode

參數

名稱類型
idsstring[]
key?string

返回

MarkNode

重寫自

ElementNode.constructor

定義於

packages/lexical-mark/src/MarkNode.ts:66

函式

addID

addID(id): void

參數

名稱類型
idstring

返回

void

定義於

packages/lexical-mark/src/MarkNode.ts:118


canBeEmpty

canBeEmpty(): false

返回

false

重寫自

ElementNode.canBeEmpty

定義於

packages/lexical-mark/src/MarkNode.ts:164


canInsertTextAfter

canInsertTextAfter(): false

返回

false

重寫自

ElementNode.canInsertTextAfter

定義於

packages/lexical-mark/src/MarkNode.ts:160


canInsertTextBefore

canInsertTextBefore(): false

返回

false

重寫自

ElementNode.canInsertTextBefore

定義於

packages/lexical-mark/src/MarkNode.ts:156


createDOM

createDOM(config): HTMLElement

在和解過程中調用此函式,以確定將哪些節點插入 DOM 以表示這個 Lexical 節點。

此函式必須返回一個 HTMLElement。嵌套元素不受支持。

在更新生命周期的這一階段,不要嘗試更新 Lexical EditorState。

參數

名稱類型描述
configEditorConfig允許在和解期間訪問編輯器主題(以應用類別)。

返回

HTMLElement

重寫自

ElementNode.createDOM

定義於

packages/lexical-mark/src/MarkNode.ts:71


deleteID

deleteID(id): void

參數

名稱類型
idstring

返回

void

定義於

packages/lexical-mark/src/MarkNode.ts:133


excludeFromCopy

excludeFromCopy(destination): boolean

參數

名稱類型
destination"clone" | "html"

返回

boolean

重寫自

ElementNode.excludeFromCopy

定義於

packages/lexical-mark/src/MarkNode.ts:195


exportJSON

exportJSON(): SerializedMarkNode

控制此節點如何序列化為 JSON。這對於在共享相同命名空間的 Lexical 編輯器之間進行複製和粘貼非常重要。如果你將 JSON 序列化以便持久儲存在某處,也很重要。參見 Serialization & Deserialization

返回

SerializedMarkNode

重寫自

ElementNode.exportJSON

定義於

packages/lexical-mark/src/MarkNode.ts:57


extractWithChild

extractWithChild(child, selection, destination): boolean

參數

名稱類型
childLexicalNode
selectionBaseSelection
destination"clone" | "html"

返回

boolean

重寫自

ElementNode.extractWithChild

定義於

packages/lexical-mark/src/MarkNode.ts:172


getIDs

getIDs(): string[]

返回

string[]

定義於

packages/lexical-mark/src/MarkNode.ts:113 以下是翻譯成繁體中文的內容:

hasID

hasID(id): boolean

參數

名稱類型
idstring

返回

boolean

定義於

packages/lexical-mark/src/MarkNode.ts:103


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | ElementNode

參數

名稱類型預設值
selectionRangeSelectionundefined
restoreSelectionbooleantrue

返回

null | ElementNode

重寫自

ElementNode.insertNewAfter

定義於

packages/lexical-mark/src/MarkNode.ts:147


isInline

isInline(): true

返回

true

重寫自

ElementNode.isInline

定義於

packages/lexical-mark/src/MarkNode.ts:168


updateDOM

updateDOM(prevNode, element, config): boolean

當節點發生變化時調用此函式,應根據需要更新 DOM,使其與更新期間可能發生的任何變化保持一致。

在此處返回 "true" 會導致 Lexical 卸載並重新創建 DOM 節點(通過調用 createDOM)。如果元素標籤發生變化,您需要這樣做。

參數

名稱類型
prevNodeMarkNode
elementHTMLElement
configEditorConfig

返回

boolean

重寫自

ElementNode.updateDOM

定義於

packages/lexical-mark/src/MarkNode.ts:80


clone

clone(node): MarkNode

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

參數

名稱類型
nodeMarkNode

返回

MarkNode

重寫自

ElementNode.clone

定義於

packages/lexical-mark/src/MarkNode.ts:41


getType

getType(): string

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

返回

string

重寫自

ElementNode.getType

定義於

packages/lexical-mark/src/MarkNode.ts:37


importDOM

importDOM(): null

返回

null

重寫自

ElementNode.importDOM

定義於

packages/lexical-mark/src/MarkNode.ts:45


importJSON

importJSON(serializedNode): MarkNode

控制此節點如何從 JSON 反序列化。這通常是樣板代碼,但提供了節點實現與序列化介面之間的抽象,如果你曾經對節點模式進行重大更改(通過添加或刪除屬性),這會變得很重要。參見 Serialization & Deserialization

參數

名稱類型
serializedNodeSerializedMarkNode

返回

MarkNode

重寫自

ElementNode.importJSON

定義於

packages/lexical-mark/src/MarkNode.ts:49