跳至主要内容

模組: @lexical/history

類型別名

HistoryState

Ƭ HistoryState: Object

類型聲明

名稱類型
currentnull | HistoryStateEntry
redoStackHistoryStateEntry[]
undoStackHistoryStateEntry[]

定義於

packages/lexical-history/src/index.ts:41


HistoryStateEntry

Ƭ HistoryStateEntry: Object

類型聲明

名稱類型
editorLexicalEditor
editorStateEditorState

定義於

packages/lexical-history/src/index.ts:37

函數

createEmptyHistoryState

createEmptyHistoryState(): HistoryState

創建一個空的歷史狀態。

返回值

HistoryState

  • 空的歷史狀態,作為一個物件。

定義於

packages/lexical-history/src/index.ts:495


registerHistory

registerHistory(editor, historyState, delay): () => void

註冊必要的監聽器來管理撤銷/重做歷史堆疊和相關的編輯器命令。 它返回一個 unregister 回調函數,用來清理所有監聽器,並應在編輯器卸載時調用。

參數

名稱類型說明
editorLexicalEditorLexical 編輯器。
historyStateHistoryState歷史狀態,包含當前狀態和撤銷/重做堆疊。
delaynumber編輯器應延遲生成新歷史堆疊的時間(以毫秒為單位),而不是將當前更改合併到當前堆疊中。

返回值

fn

監聽器清理回調函數。

▸ (): void

返回值

void

定義於

packages/lexical-history/src/index.ts:389