跳至主要内容

Class: ArtificialNode__DO_NOT_USE

lexical.ArtificialNode__DO_NOT_USE

階層結構​

建構函式​

constructor​

• new ArtificialNode__DO_NOT_USE(key?): ArtificialNode__DO_NOT_USE

參數​

名稱類型
key?string

回傳值​

ArtificialNode__DO_NOT_USE

繼承自​

ElementNode.constructor

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:85

屬性​

constructor​

• constructor: KlassConstructor<typeof ElementNode>

繼承自​

ElementNode.constructor

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:69

importDOM​

▪ Static Optional importDOM: () => null | DOMConversionMap<any>

類型宣告​

▸ (): null | DOMConversionMap<any>

回傳值​

null | DOMConversionMap<any>

繼承自​

ElementNode.importDOM

定義於​

packages/lexical/src/LexicalNode.ts:265

函式​

afterCloneFrom​

▸ afterCloneFrom(prevNode): void

對 prevNode 的克隆進行任何狀態更新，這些更新不會被靜態克隆函式中的建構函式處理。如果你的克隆中有狀態需要更新，而這些狀態並沒有被建構函式直接處理，建議覆寫此函式，但在你的實現中必須包含對 super.afterCloneFrom(prevNode) 的調用。此函式僅應由 $cloneWithProperties 函式或通過 super 調用來呼叫。

參數​

名稱類型
prevNodethis

回傳值​

void

範例

class ClassesTextNode extends TextNode {
  // 未顯示: static getType, static importJSON, exportJSON, createDOM, updateDOM
  __classes = new Set<string>();
  static clone(node: ClassesTextNode): ClassesTextNode {
    // 在這裡使用了繼承的 TextNode 建構函式，因此
    // classes 不會被此函式設置。
    return new ClassesTextNode(node.__text, node.__key);
  }
  afterCloneFrom(node: this): void {
    // 這會調用 TextNode.afterCloneFrom 和 LexicalNode.afterCloneFrom
    // 以進行必要的狀態更新
    super.afterCloneFrom(node);
    this.__addClasses(node.__classes);
  }
  // 此函式為私有實現細節，不適用於公開 API，因為它不會調用 getWritable
  __addClasses(classNames: Iterable<string>): this {
    for (const className of classNames) {
      this.__classes.add(className);
    }
    return this;
  }
  addClass(...classNames: string[]): this {
    return this.getWritable().__addClasses(classNames);
  }
  removeClass(...classNames: string[]): this {
    const node = this.getWritable();
    for (const className of classNames) {
      this.__classes.delete(className);
    }
    return this;
  }
  getClasses(): Set<string> {
    return this.getLatest().__classes;
  }
}

繼承自​

ElementNode.afterCloneFrom

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:96

append​

▸ append(...nodesToAppend): this

參數​

名稱類型
...nodesToAppendLexicalNode[]

回傳值​

this

繼承自​

ElementNode.append

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:373

canBeEmpty​

▸ canBeEmpty(): boolean

回傳值​

boolean

繼承自​

ElementNode.canBeEmpty

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:566

canIndent​

▸ canIndent(): boolean

回傳值​

boolean

繼承自​

ElementNode.canIndent

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:544

canInsertTextAfter​

▸ canInsertTextAfter(): boolean

回傳值​

boolean

繼承自​

ElementNode.canInsertTextAfter

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:572

canInsertTextBefore​

▸ canInsertTextBefore(): boolean

回傳值​

boolean

繼承自​

ElementNode.canInsertTextBefore

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:569

canMergeWhenEmpty​

▸ canMergeWhenEmpty(): boolean

確定當此節點為空時，是否可以與插入的第一個節點區塊合併。

此函式專門在 RangeSelection.insertNodes 中調用，以確定在插入節點過程中的合併行為。

回傳值​

boolean

範例

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

繼承自​

ElementNode.canMergeWhenEmpty

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:610

clear​

▸ clear(): this

回傳值​

this

繼承自​

ElementNode.clear

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:367

collapseAtStart​

▸ collapseAtStart(selection): boolean

參數​

名稱類型
selectionRangeSelection

回傳值​

boolean

繼承自​

ElementNode.collapseAtStart

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:552

createDOM​

▸ createDOM(config): HTMLElement

在重新調解過程中調用以確定要插入到 DOM 中的節點。

此函式必須返回正確的 HTMLElement。不支援嵌套元素。

在此更新生命週期階段中，不要嘗試更新 Lexical EditorState。

參數​

名稱類型描述
configEditorConfig允許在重新調解過程中訪問例如 EditorTheme（應用類別）等內容。

回傳值​

HTMLElement

覆寫自​

ElementNode.createDOM

定義於​

packages/lexical/src/nodes/ArtificialNode.ts:18

createParentElementNode​

▸ createParentElementNode(): ElementNode

創建任何所需父元素的邏輯。如果 isParentRequired 返回 true，應實現此函式。

回傳值​

ElementNode

繼承自​

ElementNode.createParentElementNode

定義於​

packages/lexical/src/LexicalNode.ts:1094

excludeFromCopy​

▸ excludeFromCopy(destination?): boolean

參數​

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

回傳值​

boolean

繼承自​

ElementNode.excludeFromCopy

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:555

exportDOM​

▸ exportDOM(editor): DOMExportOutput

控制如何將此節點序列化為 HTML。這對於 Lexical 和非 Lexical 編輯器之間的複製和粘貼，或不同命名空間的 Lexical 編輯器之間的複製和粘貼很重要。在這種情況下，主要的轉移格式是 HTML。如果你正在通過 $generateHtmlFromNodes 將其序列化為 HTML，這也很重要。你也可以使用此函式來構建自己的 HTML 渲染器。

參數​

名稱類型
editorLexicalEditor

回傳值​

DOMExportOutput

繼承自​

ElementNode.exportDOM

定義於​

packages/lexical/src/LexicalNode.ts:845

exportJSON​

▸ exportJSON(): SerializedElementNode<SerializedLexicalNode>

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

回傳值​

SerializedElementNode<SerializedLexicalNode>

繼承自​

ElementNode.exportJSON

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:527

extractWithChild​

▸ extractWithChild(child, selection, destination): boolean

參數​

名稱類型
childLexicalNode
selectionnull | BaseSelection
destination"clone" | "html"

回傳值​

boolean

繼承自​

ElementNode.extractWithChild

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:589

getAllTextNodes​

▸ getAllTextNodes(): TextNode[]

回傳值​

TextNode[]

繼承自​

ElementNode.getAllTextNodes

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:158

getChildAtIndex​

▸ getChildAtIndex<T>(index): null | T

類型參數​

名稱類型
T擴展 LexicalNode

參數​

名稱類型
indexnumber

回傳值​

null | T

繼承自​

ElementNode.getChildAtIndex

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:239

getChildren​

▸ getChildren<T>(): T[]

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

T[]

繼承自​

ElementNode.getChildren

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:123

getChildrenKeys​

▸ getChildrenKeys(): string[]

回傳值​

string[]

繼承自​

ElementNode.getChildrenKeys

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:132

getChildrenSize​

▸ getChildrenSize(): number

回傳值​

number

繼承自​

ElementNode.getChildrenSize

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:141

getCommonAncestor​

▸ getCommonAncestor<T>(node): null | T

返回此節點和提供的節點之間最近的共同祖先，如果找不到則返回 null。

類型參數​

名稱類型
T擴展 ElementNode = ElementNode

參數​

名稱類型描述
nodeLexicalNode要找到共同祖先的另一個節點。

回傳值​

null | T

繼承自​

ElementNode.getCommonAncestor

定義於​

packages/lexical/src/LexicalNode.ts:553

getDescendantByIndex​

▸ getDescendantByIndex<T>(index): null | T

類型參數​

名稱類型
T擴展 LexicalNode

參數​

名稱類型
indexnumber

回傳值​

null | T

繼承自​

ElementNode.getDescendantByIndex

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:195

getDirection​

▸ getDirection(): null | "ltr" | "rtl"

回傳值​

null | "ltr" | "rtl"

繼承自​

ElementNode.getDirection

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:300

getFirstChild​

▸ getFirstChild<T>(): null | T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getFirstChild

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:215

getFirstChildOrThrow​

▸ getFirstChildOrThrow<T>(): T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

T

繼承自​

ElementNode.getFirstChildOrThrow

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:220

getFirstDescendant​

▸ getFirstDescendant<T>(): null | T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getFirstDescendant

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:173

getFormat​

▸ getFormat(): number

回傳值​

number

繼承自​

ElementNode.getFormat

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:107

getFormatType​

▸ getFormatType(): ElementFormatType

回傳值​

ElementFormatType

繼承自​

ElementNode.getFormatType

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:111

getIndent​

▸ getIndent(): number

回傳值​

number

繼承自​

ElementNode.getIndent

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:119

getIndexWithinParent​

▸ getIndexWithinParent(): number

返回此節點在父節點中的零基索引。

回傳值​

number

繼承自​

ElementNode.getIndexWithinParent

定義於​

packages/lexical/src/LexicalNode.ts:381

getKey​

▸ getKey(): string

返回此節點的鍵。

回傳值​

string

繼承自​

ElementNode.getKey

定義於​

packages/lexical/src/LexicalNode.ts:373

getLastChild​

▸ getLastChild<T>(): null | T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getLastChild

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:227

getLastChildOrThrow​

▸ getLastChildOrThrow<T>(): T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

T

繼承自​

ElementNode.getLastChildOrThrow

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:232

getLastDescendant​

▸ getLastDescendant<T>(): null | T

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getLastDescendant

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:184

getLatest​

▸ getLatest(): this

返回來自當前 EditorState 的節點的最新版本。這樣可以避免從過時的節點引用中獲取值。

回傳值​

this

繼承自​

ElementNode.getLatest

定義於​

packages/lexical/src/LexicalNode.ts:739

getNextSibling​

▸ getNextSibling<T>(): null | T

返回「下一個」兄弟節點，即在相同父節點中，該節點後面的節點。

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getNextSibling

定義於​

packages/lexical/src/LexicalNode.ts:526

getNextSiblings​

▸ getNextSiblings<T>(): T[]

返回所有「下一個」兄弟節點，即該節點到其父節點的最後一個子節點之間的所有節點（包括最後一個子節點）。

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

T[]

繼承自​

ElementNode.getNextSiblings

定義於​

packages/lexical/src/LexicalNode.ts:537

getNodesBetween​

▸ getNodesBetween(targetNode): LexicalNode[]

返回一個節點列表，這些節點位於此節點和目標節點之間的 EditorState 中。

參數​

名稱類型描述
targetNodeLexicalNode標記範圍另一端的節點。

回傳值​

LexicalNode[]

繼承自​

ElementNode.getNodesBetween

定義於​

packages/lexical/src/LexicalNode.ts:658

getParent​

▸ getParent<T>(): null | T

返回此節點的父節點，如果找不到則返回 null。

類型參數​

名稱類型
T擴展 ElementNode

回傳值​

null | T

繼承自​

ElementNode.getParent

定義於​

packages/lexical/src/LexicalNode.ts:401

getParentKeys​

▸ getParentKeys(): string[]

返回此節點的所有祖先節點的鍵列表，直到 RootNode。

回傳值​

string[]

繼承自​

ElementNode.getParentKeys

定義於​

packages/lexical/src/LexicalNode.ts:478

getParentOrThrow​

▸ getParentOrThrow<T>(): T

返回此節點的父節點，如果找不到則拋出異常。

類型參數​

名稱類型
T擴展 ElementNode

回傳值​

T

繼承自​

ElementNode.getParentOrThrow

定義於​

packages/lexical/src/LexicalNode.ts:412

getParents​

▸ getParents(): ElementNode[]

返回此節點的所有祖先節點列表，直到 RootNode。

回傳值​

ElementNode[]

繼承自​

ElementNode.getParents

定義於​

packages/lexical/src/LexicalNode.ts:463

getPreviousSibling​

▸ getPreviousSibling<T>(): null | T

返回「前一個」兄弟節點，即在相同父節點中，此節點之前的節點。

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

null | T

繼承自​

ElementNode.getPreviousSibling

定義於​

packages/lexical/src/LexicalNode.ts:493

getPreviousSiblings​

▸ getPreviousSiblings<T>(): T[]

返回「前一個」兄弟節點，即此節點和其父節點的第一個子節點之間的所有節點（包括第一個子節點）。

類型參數​

名稱類型
T擴展 LexicalNode

回傳值​

T[]

繼承自​

ElementNode.getPreviousSiblings

定義於​

packages/lexical/src/LexicalNode.ts:504

getStyle​

▸ getStyle(): string

回傳值​

string

繼承自​

ElementNode.getStyle

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:115

getTextContent​

▸ getTextContent(): string

返回節點的文本內容。對於應該以純文本格式表示的自定義節點（例如用於複製和粘貼），應覆蓋此函式。

回傳值​

string

繼承自​

ElementNode.getTextContent

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:266

getTextContentSize​

▸ getTextContentSize(): number

返回通過調用 getTextContent 函式獲得的字符串的長度。

回傳值​

number

繼承自​

ElementNode.getTextContentSize

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:283

getTopLevelElement​

▸ getTopLevelElement(): null | ElementNode

返回此節點在 EditorState 樹中最高層（非根）祖先節點，如果找不到則返回 null。請參閱 $isRootOrShadowRoot 以獲取更多有關哪些元素構成「根」的信息。

回傳值​

null | ElementNode

繼承自​

ElementNode.getTopLevelElement

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:62

getTopLevelElementOrThrow​

▸ getTopLevelElementOrThrow(): ElementNode

返回此節點在 EditorState 樹中最高層（非根）祖先節點，如果找不到則拋出異常。請參閱 $isRootOrShadowRoot 以獲取更多有關哪些元素構成「根」的信息。

回傳值​

ElementNode

繼承自​

ElementNode.getTopLevelElementOrThrow

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:63

getType​

▸ getType(): string

返回此節點的字符串類型。

回傳值​

string

繼承自​

ElementNode.getType

定義於​

packages/lexical/src/LexicalNode.ts:286

getWritable​

▸ getWritable(): this

返回節點的可變版本，如有必要可使用 $cloneWithProperties。如果在 Lexical 編輯器 LexicalEditor.update 回調外調用此函式，將會拋出錯誤。

回傳值​

this

繼承自​

ElementNode.getWritable

定義於​

packages/lexical/src/LexicalNode.ts:756

hasFormat​

▸ hasFormat(type): boolean

參數​

名稱類型
typeElementFormatType

回傳值​

boolean

繼承自​

ElementNode.hasFormat

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:304

insertAfter​

▸ insertAfter(nodeToInsert, restoreSelection?): LexicalNode

在此 LexicalNode 後插入一個節點（作為下一個兄弟節點）。

參數​

名稱類型預設值描述
nodeToInsertLexicalNodeundefined要在此節點後插入的節點。
restoreSelectionbooleantrue是否在操作完成後嘗試將選擇恢復到適當的位置。

回傳值​

LexicalNode

繼承自​

ElementNode.insertAfter

定義於​

packages/lexical/src/LexicalNode.ts:979

insertBefore​

▸ insertBefore(nodeToInsert, restoreSelection?): LexicalNode

在此 LexicalNode 前插入一個節點（作為上一個兄弟節點）。

參數​

名稱類型預設值描述
nodeToInsertLexicalNodeundefined要在此節點前插入的節點。
restoreSelectionbooleantrue是否在操作完成後嘗試將選擇恢復到適當的位置。

回傳值​

LexicalNode

繼承自​

ElementNode.insertBefore

定義於​

packages/lexical/src/LexicalNode.ts:1046

insertNewAfter​

▸ insertNewAfter(selection, restoreSelection?): null | LexicalNode

參數​

名稱類型
selectionRangeSelection
restoreSelection?boolean

回傳值​

null | LexicalNode

繼承自​

ElementNode.insertNewAfter

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:538

is​

▸ is(object): boolean

如果提供的節點與此節點在 Lexical 的視角下完全相同，則返回 true。始終使用此函式來檢查等同性，而不是引用等同性。

參數​

名稱類型描述
objectundefined | null | LexicalNode要進行等同性比較的節點。

回傳值​

boolean

繼承自​

ElementNode.is

定義於​

packages/lexical/src/LexicalNode.ts:585

isAttached​

▸ isAttached(): boolean

如果存在從此節點到 RootNode 的路徑，則返回 true，否則返回 false。這是一種確定節點是否「附加」到 EditorState 的函式。未附加的節點不會被重新合併，最終會被 Lexical 垃圾回收器清理。

回傳值​

boolean

繼承自​

ElementNode.isAttached

定義於​

packages/lexical/src/LexicalNode.ts:303

isBefore​

▸ isBefore(targetNode): boolean

如果此節點在編輯器狀態中邏輯上位於目標節點之前，則返回 true。

參數​

名稱類型描述
targetNodeLexicalNode要測試是否在此節點之後的節點。

回傳值​

boolean

繼承自​

ElementNode.isBefore

定義於​

packages/lexical/src/LexicalNode.ts:597

isDirty​

▸ isDirty(): boolean

如果此節點在此次更新週期中被標記為「髒」，則返回 true。

回傳值​

boolean

繼承自​

ElementNode.isDirty

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:148

isEmpty​

▸ isEmpty(): boolean

回傳值​

boolean

繼承自​

ElementNode.isEmpty

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:145

isInline​

▸ isInline(): boolean

回傳值​

boolean

繼承自​

ElementNode.isInline

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:575

isLastChild​

▸ isLastChild(): boolean

回傳值​

boolean

繼承自​

ElementNode.isLastChild

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:153

isParentOf​

▸ isParentOf(targetNode): boolean

如果此節點是目標節點的父節點，則返回 true，否則返回 false。

參數​

名稱類型描述
targetNodeLexicalNode潛在的子節點。

回傳值​

boolean

繼承自​

ElementNode.isParentOf

定義於​

packages/lexical/src/LexicalNode.ts:636

isParentRequired​

▸ isParentRequired(): boolean

此節點是否需要父節點。用於複製和粘貼操作，以標準化那些否則會變成孤立的節點。例如，沒有 ListNode 父節點的 ListItemNodes 或有 ParagraphNode 父節點的 TextNodes。

回傳值​

boolean

繼承自​

ElementNode.isParentRequired

定義於​

packages/lexical/src/LexicalNode.ts:1086

isSelected​

▸ isSelected(selection?): boolean

如果此節點包含在提供的選擇範圍內，則返回 true，否則返回 false。依賴於 BaseSelection.getNodes 實現的算法來確定包含的內容。

參數​

名稱類型描述
selection?null | BaseSelection我們想要確定節點是否在其中的選擇範圍。

回傳值​

boolean

繼承自​

ElementNode.isSelected

定義於​

packages/lexical/src/LexicalNode.ts:327

isShadowRoot​

▸ isShadowRoot(): boolean

回傳值​

boolean

繼承自​

ElementNode.isShadowRoot

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:582

markDirty​

▸ markDirty(): void

將節點標記為「髒」，觸發變換並強制在更新週期內重新合併。

回傳值​

void

繼承自​

ElementNode.markDirty

定義於​

packages/lexical/src/LexicalNode.ts:1155

remove​

▸ remove(preserveEmptyParent?): void

從 EditorState 中移除此 LexicalNode。如果節點未重新插入到其他位置，Lexical 垃圾回收器最終會清理它。

參數​

名稱類型描述
preserveEmptyParent?boolean如果為 falsy，則在移除操作後，如果節點的父節點為空，將會移除該父節點。這是預設行為，但會受到其他節點啟發式算法（例如 ElementNode#canBeEmpty）的影響。

回傳值​

void

繼承自​

ElementNode.remove

定義於​

packages/lexical/src/LexicalNode.ts:898

replace​

▸ replace<N>(replaceWith, includeChildren?): N

用提供的節點替換此 LexicalNode，並可選擇將被替換節點的子節點轉移到替換節點。

類型參數​

名稱類型
N擴展 LexicalNode

參數​

名稱類型描述
replaceWithN要替換此節點的節點。
includeChildren?boolean是否將此節點的子節點轉移到替換節點。

回傳值​

N

繼承自​

ElementNode.replace

定義於​

packages/lexical/src/LexicalNode.ts:909

select​

▸ select(_anchorOffset?, _focusOffset?): RangeSelection

參數​

名稱類型
_anchorOffset?number
_focusOffset?number

回傳值​

RangeSelection

繼承自​

ElementNode.select

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:314

selectEnd​

▸ selectEnd(): RangeSelection

回傳值​

RangeSelection

繼承自​

ElementNode.selectEnd

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:363

selectNext​

▸ selectNext(anchorOffset?, focusOffset?): RangeSelection

將選擇範圍移至此節點的下一個兄弟節點，並設置指定的偏移量。

參數​

名稱類型描述
anchorOffset?number選擇範圍的錨點偏移量。
focusOffset?number選擇範圍的焦點偏移量。

回傳值​

RangeSelection

繼承自​

ElementNode.selectNext

定義於​

packages/lexical/src/LexicalNode.ts:1134

selectPrevious​

▸ selectPrevious(anchorOffset?, focusOffset?): RangeSelection

將選擇範圍移至此節點的前一個兄弟節點，並設置指定的偏移量。

參數​

名稱類型描述
anchorOffset?number選擇範圍的錨點偏移量。
focusOffset?number選擇範圍的焦點偏移量。

回傳值​

RangeSelection

繼承自​

ElementNode.selectPrevious

定義於​

packages/lexical/src/LexicalNode.ts:1112

selectStart​

▸ selectStart(): RangeSelection

回傳值​

RangeSelection

繼承自​

ElementNode.selectStart

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:359

setDirection​

▸ setDirection(direction): this

參數​

名稱類型
directionnull | "ltr" | "rtl"

回傳值​

this

繼承自​

ElementNode.setDirection

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:376

setFormat​

▸ setFormat(type): this

參數​

名稱類型
typeElementFormatType

回傳值​

this

繼承自​

ElementNode.setFormat

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:381

setIndent​

▸ setIndent(indentLevel): this

參數​

名稱類型
indentLevelnumber

回傳值​

this

繼承自​

ElementNode.setIndent

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:391

setStyle​

▸ setStyle(style): this

參數​

名稱類型
stylestring

回傳值​

this

繼承自​

ElementNode.setStyle

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:386

splice​

▸ splice(start, deleteCount, nodesToInsert): this

參數​

名稱類型
startnumber
deleteCountnumber
nodesToInsertLexicalNode[]

回傳值​

this

繼承自​

ElementNode.splice

定義於​

packages/lexical/src/nodes/LexicalElementNode.ts:396

updateDOM​

▸ updateDOM(_prevNode, _dom, _config): boolean

當節點發生變化並且需要更新 DOM 以使其與更新期間可能發生的變化對齊時，會調用此函式。

如果返回「true」，則會導致 lexical 卸載並重新創建 DOM 節點（通過調用 createDOM）。例如，如果元素標籤發生變化，你需要這樣做。

參數​

名稱類型描述
_prevNodeunknown前一節點。
_domHTMLElementDOM 元素。
_configEditorConfig編輯器配置。

回傳值​

boolean

繼承自​

ElementNode.updateDOM

定義於​

packages/lexical/src/LexicalNode.ts:829

clone​

▸ clone(_data): LexicalNode

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

參數​

名稱類型描述
_dataunknown需要克隆的數據。

回傳值​

LexicalNode

繼承自​

ElementNode.clone

定義於​

packages/lexical/src/LexicalNode.ts:200

getType​

▸ getType(): string

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

回傳值​

string

重寫​

ElementNode.getType

定義於​

packages/lexical/src/nodes/ArtificialNode.ts:14

importJSON​

▸ importJSON(_serializedNode): LexicalNode

控制如何從 JSON 反序列化此節點。這通常是模板代碼，但提供了節點實現和序列化接口之間的抽象，如果你在節點架構中進行重大更改（通過添加或移除屬性），這可能非常重要。參見 Serialization & Deserialization。

參數​

名稱類型描述
_serializedNodeSerializedLexicalNode序列化的節點。

回傳值​

LexicalNode

繼承自​

ElementNode.importJSON

定義於​

packages/lexical/src/LexicalNode.ts:868

transform​

▸ transform(): null | (node: LexicalNode) => void

在編輯器初始化期間將返回的函式註冊為節點的變換。大多數此類用例應通過 LexicalEditor.registerNodeTransform API 來處理。

實驗性功能 - 使用需謹慎。

回傳值​

null | (node: LexicalNode) => void

繼承自​

ElementNode.transform

定義於​

packages/lexical/src/LexicalNode.ts:884