模組: lexical

類別

介面

型別別名

CommandListener

Ƭ CommandListener<P>: (payload: P, editor: LexicalEditor) => boolean

型別參數

名稱
`P`

型別宣告

▸ (payload, editor): boolean

參數

名稱	型別
`payload`	`P`
`editor`	`LexicalEditor`

回傳值

boolean

定義於

packages/lexical/src/LexicalEditor.ts:256

CommandListenerPriority

Ƭ CommandListenerPriority: 0 | 1 | 2 | 3 | 4

定義於

packages/lexical/src/LexicalEditor.ts:260

CommandPayloadType

Ƭ CommandPayloadType<TCommand>: TCommand extends LexicalCommand<infer TPayload> ? TPayload : never

型別助手，用於從命令中提取有效負載型別。

範例

const MY_COMMAND = createCommand<SomeType>();

// ...

editor.registerCommand(MY_COMMAND, (payload) => {
  // `payload` 的型別在這裡被推斷出來。但假設我們想提取一個函數來委派給
  handleMyCommand(editor, payload);
  return true;
});

function handleMyCommand(
  editor: LexicalEditor,
  payload: CommandPayloadType<typeof MY_COMMAND>,
) {
  // `payload` 是從命令中提取的 `SomeType` 型別。
}

型別參數

名稱	型別
`TCommand`	extends `LexicalCommand`<`unknown`>

定義於

packages/lexical/src/LexicalEditor.ts:293

CreateEditorArgs

Ƭ CreateEditorArgs: Object

型別宣告

名稱	型別
`disableEvents?`	`boolean`
`editable?`	`boolean`
`editorState?`	`EditorState`
`html?`	`HTMLConfig`
`namespace?`	`string`
`nodes?`	`ReadonlyArray`<`Klass`<`LexicalNode`> \| `LexicalNodeReplacement`>
`onError?`	`ErrorHandler`
`parentEditor?`	`LexicalEditor`
`theme?`	`EditorThemeClasses`

定義於

packages/lexical/src/LexicalEditor.ts:180

DOMChildConversion

Ƭ DOMChildConversion: (lexicalNode: LexicalNode, parentLexicalNode: LexicalNode | null | undefined) => LexicalNode | null | undefined

型別宣告

▸ (lexicalNode, parentLexicalNode): LexicalNode | null | undefined

參數

名稱	型別
`lexicalNode`	`LexicalNode`
`parentLexicalNode`	`LexicalNode` \| `null` \| `undefined`

回傳值

LexicalNode | null | undefined

定義於

packages/lexical/src/LexicalNode.ts:134

DOMConversion

Ƭ DOMConversion<T>: Object

型別參數

名稱	型別
`T`	extends `HTMLElement` = `HTMLElement`

型別宣告

名稱	型別
`conversion`	`DOMConversionFn`<`T`>
`priority?`	`0` \| `1` \| `2` \| `3` \| `4`

定義於

packages/lexical/src/LexicalNode.ts:125

DOMConversionFn

Ƭ DOMConversionFn<T>: (element: T) => DOMConversionOutput | null

型別參數

名稱	型別
`T`	extends `HTMLElement` = `HTMLElement`

型別宣告

▸ (element): DOMConversionOutput | null

參數

名稱	型別
`element`	`T`

回傳值

DOMConversionOutput | null

定義於

packages/lexical/src/LexicalNode.ts:130

DOMConversionMap

Ƭ DOMConversionMap<T>: Record<NodeName, (node: T) => DOMConversion<T> | null>

型別參數

名稱	型別
`T`	extends `HTMLElement` = `HTMLElement`

定義於

packages/lexical/src/LexicalNode.ts:139

DOMConversionOutput

Ƭ DOMConversionOutput: Object

型別宣告

名稱	型別
`after?`	(`childLexicalNodes`: `LexicalNode`[]) => `LexicalNode`[]
`forChild?`	`DOMChildConversion`
`node`	`null` \| [`LexicalNode`](../classes/lex

ical.LexicalNode.md) | LexicalNode[] |

定義於

packages/lexical/src/LexicalNode.ts:145

DOMExportOutput

Ƭ DOMExportOutput: Object

型別宣告

名稱	型別
`after?`	(`generatedElement`: `HTMLElement` \| `Text` \| `null` \| `undefined`) => `HTMLElement` \| `Text` \| `null` \| `undefined`
`element`	`HTMLElement` \| `Text` \| `null`

定義於

packages/lexical/src/LexicalNode.ts:151

EditableListener

Ƭ EditableListener: (editable: boolean) => void

型別宣告

▸ (editable): void

參數

名稱	型別
`editable`	`boolean`

回傳

void

定義於

packages/lexical/src/LexicalEditor.ts:258

EditorConfig

Ƭ EditorConfig: Object

型別宣告

名稱	型別
`disableEvents?`	`boolean`
`namespace`	`string`
`theme`	`EditorThemeClasses`

定義於

packages/lexical/src/LexicalEditor.ts:157

EditorSetOptions

Ƭ EditorSetOptions: Object

型別宣告

名稱	型別
`tag?`	`string`

定義於

packages/lexical/src/LexicalEditor.ts:86

EditorThemeClassName

Ƭ EditorThemeClassName: string

定義於

packages/lexical/src/LexicalEditor.ts:63

EditorThemeClasses

Ƭ EditorThemeClasses: Object

索引特徵

▪ [key: string]: any

型別宣告

名稱	型別
`blockCursor?`	`EditorThemeClassName`
`characterLimit?`	`EditorThemeClassName`
`code?`	`EditorThemeClassName`
`codeHighlight?`	`Record`<`string`, `EditorThemeClassName`>
`embedBlock?`	{ `base?`: `EditorThemeClassName` ; `focus?`: `EditorThemeClassName` }
`embedBlock.base?`	`EditorThemeClassName`
`embedBlock.focus?`	`EditorThemeClassName`
`hashtag?`	`EditorThemeClassName`
`heading?`	{ `h1?`: `EditorThemeClassName` ; `h2?`: `EditorThemeClassName` ; `h3?`: `EditorThemeClassName` ; `h4?`: `EditorThemeClassName` ; `h5?`: `EditorThemeClassName` ; `h6?`: `EditorThemeClassName` }
`heading.h1?`	`EditorThemeClassName`
`heading.h2?`	`EditorThemeClassName`
`heading.h3?`	`EditorThemeClassName`
`heading.h4?`	`EditorThemeClassName`
`heading.h5?`	`EditorThemeClassName`
`heading.h6?`	`EditorThemeClassName`
`hr?`	`EditorThemeClassName`
`image?`	`EditorThemeClassName`
`indent?`	`EditorThemeClassName`
`link?`	`EditorThemeClassName`
`list?`	{ `checklist?`: `EditorThemeClassName` ; `listitem?`: `EditorThemeClassName` ; `listitemChecked?`: `EditorThemeClassName` ; `listitemUnchecked?`: `EditorThemeClassName` ; `nested?`: { `list?`: `EditorThemeClassName` ; `listitem?`: `EditorThemeClassName` } ; `ol?`: `EditorThemeClassName` ; `olDepth?`: `EditorThemeClassName`[] ; `ul?`: `EditorThemeClassName` ; `ulDepth?`: `EditorThemeClassName`[] }
`list.checklist?`	`EditorThemeClassName`
`list.listitem?`	`EditorThemeClassName`
`list.listitemChecked?`	`EditorThemeClassName`
`list.listitemUnchecked?`	`EditorThemeClassName`
`list.nested?`	{ `list?`: `EditorThemeClassName` ; `listitem?`: `EditorThemeClassName` }
`list.nested.list?`	`EditorThemeClassName`
`list.nested.listitem?`	`EditorThemeClassName`
`list.ol?`	`EditorThemeClassName`
`list.olDepth?`	`EditorThemeClassName`[]
`list.ul?`	`EditorThemeClassName`
`list.ulDepth?`	`EditorThemeClassName`[]
`ltr?`	`EditorThemeClassName`
`mark?`	`EditorThemeClassName`
`markOverlap?`	`EditorThemeClassName`
`paragraph?`	`EditorThemeClassName`
`quote?`	`EditorThemeClassName`
`root?`	`EditorThemeClassName`
`rtl?`	`EditorThemeClassName`
`table?`	`EditorThemeClassName`
`tableAddColumns?`	`EditorThemeClassName`
`tableAddRows?`	`EditorThemeClassName`
`tableCell?`	`EditorThemeClassName`
`tableCellActionButton?`	`EditorThemeClassName`
`tableCellActionButtonContainer?`	`EditorThemeClassName`
`tableCellEditing?`	`EditorThemeClassName`
`tableCellHeader?`	[`EditorThemeClassName`](lexical

.md#editorthemeclassname) | | tableCellPrimarySelected? | EditorThemeClassName | | tableCellResizer? | EditorThemeClassName | | tableCellSelected? | EditorThemeClassName | | tableResizeRuler? | EditorThemeClassName | | tableSelected? | EditorThemeClassName | | text? | { bold?: EditorThemeClassName ; code?: EditorThemeClassName ; italic?: EditorThemeClassName ; strikethrough?: EditorThemeClassName ; subscript?: EditorThemeClassName ; superscript?: EditorThemeClassName ; underline?: EditorThemeClassName } | | text.bold? | EditorThemeClassName | | text.code? | EditorThemeClassName | | text.italic? | EditorThemeClassName | | text.strikethrough? | EditorThemeClassName | | text.subscript? | EditorThemeClassName | | text.superscript? | EditorThemeClassName | | text.underline? | EditorThemeClassName |

定義於

packages/lexical/src/LexicalEditor.ts:65

EditorUpdateOptions

Ƭ EditorUpdateOptions: Object

型別宣告

名稱	型別
`onUpdate`	(`node`: `T`) => `void`

定義於

packages/lexical/src/LexicalEditor.ts:135

InsertHTMLConfig

Ƭ InsertHTMLConfig: Object

型別宣告

名稱	型別
`parse?`	(`html`: `string`, `editor`: `LexicalEditor`) => `HTMLElement`
`replace`	`boolean`

定義於

packages/lexical/src/LexicalNode.ts:153

Klass

Ƭ Klass<T>: InstanceType<T["constructor"]> extends T ? T["constructor"] : GenericConstructor<T> & T["constructor"]

型別參數

名稱	型別
`T`	extends `LexicalNode`

定義於

packages/lexical/src/LexicalEditor.ts:57

KlassConstructor

Ƭ KlassConstructor<Cls>: GenericConstructor<InstanceType<Cls>> & { [k in keyof Cls]: Cls[k] }

型別參數

名稱	型別
`Cls`	extends `GenericConstructor`<`any`>

定義於

packages/lexical/src/LexicalEditor.ts:52

LexicalCommand

Ƭ LexicalCommand<TPayload>: Object

型別參數

名稱
`TPayload`

型別聲明

名稱	型別
`type?`	`string`

定義於

packages/lexical/src/LexicalEditor.ts:269

LexicalNodeReplacement

Ƭ LexicalNodeReplacement: Object

型別聲明

名稱	型別
`replace`	`Klass`<`LexicalNode`>
`with`	<T>(`node`: `InstanceType`<`T`>) => `LexicalNode`
`withKlass?`	`Klass`<`LexicalNode`>

定義於

packages/lexical/src/LexicalEditor.ts:163

MutationListener

Ƭ MutationListener: (nodes: Map<NodeKey, NodeMutation>, payload: { dirtyLeaves: Set<string> ; prevEditorState: EditorState ; updateTags: Set<string> }) => void

型別聲明

▸ (nodes, payload): void

參數

名稱	型別
`nodes`	`Map`<`NodeKey`, `NodeMutation`>
`payload`	`Object`
`payload.dirtyLeaves`	`Set`<`string`>
`payload.prevEditorState`	`EditorState`
`payload.updateTags`	`Set`<`string`>

回傳

void

定義於

packages/lexical/src/LexicalEditor.ts:247

NodeKey

Ƭ NodeKey: string

定義於

packages/lexical/src/LexicalNode.ts:158

NodeMap

Ƭ NodeMap: Map<NodeKey, LexicalNode>

定義於

packages/lexical/src/LexicalNode.ts:52

NodeMutation

Ƭ NodeMutation: "created" | "updated" | "destroyed"

定義於

packages/lexical/src/LexicalEditor.ts:213

PasteCommandType

Ƭ PasteCommandType: ClipboardEvent | InputEvent | KeyboardEvent

SerializedEditor

Ƭ SerializedEditor: Object

型別說明

名稱	型別
`editorState`	`SerializedEditorState`

定義於

packages/lexical/src/LexicalEditor.ts:334

SerializedElementNode

Ƭ SerializedElementNode<T>: Spread<{ children: T[] ; direction: "ltr" | "rtl" | null ; format: ElementFormatType ; indent: number }, SerializedLexicalNode>

型別參數

名稱	型別
`T`	必須為 `SerializedLexicalNode` 的子類別，預設值為 `SerializedLexicalNode`

定義於

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

SerializedLexicalNode

Ƭ SerializedLexicalNode: Object

型別說明

名稱	型別
`type`	`string`
`version`	`number`

定義於

packages/lexical/src/LexicalNode.ts:54

SerializedLineBreakNode

Ƭ SerializedLineBreakNode: SerializedLexicalNode

定義於

packages/lexical/src/nodes/LexicalLineBreakNode.ts:21

SerializedParagraphNode

Ƭ SerializedParagraphNode: Spread<{ textFormat: number ; textStyle: string }, SerializedElementNode>

定義於

packages/lexical/src/nodes/LexicalParagraphNode.ts:37

SerializedRootNode

Ƭ SerializedRootNode<T>: SerializedElementNode<T>

型別參數

名稱	型別
`T`	必須為 `SerializedLexicalNode` 的子類別，預設值為 `SerializedLexicalNode`

定義於

packages/lexical/src/nodes/LexicalRootNode.ts:20

SerializedTabNode

Ƭ SerializedTabNode: SerializedTextNode

定義於

packages/lexical/src/nodes/LexicalTabNode.ts:23

SerializedTextNode

Ƭ SerializedTextNode: Spread<{ detail: number ; format: number ; mode: TextModeType ; style: string ; text: string }, SerializedLexicalNode>

定義於

packages/lexical/src/nodes/LexicalTextNode.ts:72

Spread

Ƭ Spread<T1, T2>: Omit<T2, keyof T1> & T1

型別參數

名稱
`T1`
`T2`

定義於

packages/lexical/src/LexicalEditor.ts:48

TextFormatType

定義於

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

TextModeType

Ƭ TextModeType: "normal" | "token" | "segmented"

定義於

packages/lexical/src/nodes/LexicalTextNode.ts:95

TextPoint

Ƭ TextPoint: Object

型別說明

名稱	型別
`_selection`	`BaseSelection`
`getNode`	() => `TextNode`
`is`	(`point`: `PointType`) => `boolean`
`isBefore`	(`point`: `PointType`) => `boolean`
`key`	`NodeKey`
`offset`	`number`
`set`	(`key`: `NodeKey`, `offset`: `number`, `type`: `"text"` \| `"element"`) => `void`
`type`	`"text"`

定義於

packages/lexical/src/LexicalSelection.ts:67

Transform

Ƭ Transform<T>: (node: T) => void

型別參數

名稱	型別
`T`	必須為 `LexicalNode` 的子類別

型別說明

▸ (node): void

參數

名稱	型別
`node`	`T`

回傳

void

定義於

packages/lexical/src/LexicalEditor.ts:205

變數

BLUR_COMMAND

• Const BLUR_COMMAND: LexicalCommand<FocusEvent>

定義於

packages/lexical/src/LexicalCommands.ts:122

CAN_REDO_COMMAND

• Const CAN_REDO_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:116

CAN_UNDO_COMMAND

• Const CAN_UNDO_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:118

CLEAR_EDITOR_COMMAND

• Const CLEAR_EDITOR_COMMAND: LexicalCommand<void>

定義於

[packages/lexical/src/LexicalCommands.ts:110](https://github.com/facebook/lexical/tree

/main/packages/lexical/src/LexicalCommands.ts#L110)

CLEAR_HISTORY_COMMAND

• Const CLEAR_HISTORY_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:113

CLICK_COMMAND

• Const CLICK_COMMAND: LexicalCommand<MouseEvent>

定義於

packages/lexical/src/LexicalCommands.ts:30

COMMAND_PRIORITY_CRITICAL

• 常數 COMMAND_PRIORITY_CRITICAL: 4

定義於

packages/lexical/src/LexicalEditor.ts:266

COMMAND_PRIORITY_EDITOR

• 常數 COMMAND_PRIORITY_EDITOR: 0

定義於

packages/lexical/src/LexicalEditor.ts:262

COMMAND_PRIORITY_HIGH

• 常數 COMMAND_PRIORITY_HIGH: 3

定義於

packages/lexical/src/LexicalEditor.ts:265

COMMAND_PRIORITY_LOW

• 常數 COMMAND_PRIORITY_LOW: 1

定義於

packages/lexical/src/LexicalEditor.ts:263

COMMAND_PRIORITY_NORMAL

• 常數 COMMAND_PRIORITY_NORMAL: 2

定義於

packages/lexical/src/LexicalEditor.ts:264

CONTROLLED_TEXT_INSERTION_COMMAND

• 常數 CONTROLLED_TEXT_INSERTION_COMMAND: LexicalCommand<InputEvent | string>

定義於

packages/lexical/src/LexicalCommands.ts:41

COPY_COMMAND

• 常數 COPY_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>

定義於

packages/lexical/src/LexicalCommands.ts:102

CUT_COMMAND

• 常數 CUT_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>

定義於

packages/lexical/src/LexicalCommands.ts:105

DELETE_CHARACTER_COMMAND

• 常數 DELETE_CHARACTER_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:32

DELETE_LINE_COMMAND

• 常數 DELETE_LINE_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:51

DELETE_WORD_COMMAND

• 常數 DELETE_WORD_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:48

DRAGEND_COMMAND

• 常數 DRAGEND_COMMAND: LexicalCommand<DragEvent>

定義於

packages/lexical/src/LexicalCommands.ts:100

DRAGOVER_COMMAND

• 常數 DRAGOVER_COMMAND: LexicalCommand<DragEvent>

定義於

packages/lexical/src/LexicalCommands.ts:98

DRAGSTART_COMMAND

• 常數 DRAGSTART_COMMAND: LexicalCommand<DragEvent>

定義於

packages/lexical/src/LexicalCommands.ts:96

DROP_COMMAND

• 常數 DROP_COMMAND: LexicalCommand<DragEvent>

定義於

packages/lexical/src/LexicalCommands.ts:92

FOCUS_COMMAND

• 常數 FOCUS_COMMAND: LexicalCommand<FocusEvent>

定義於

packages/lexical/src/LexicalCommands.ts:120

FORMAT_ELEMENT_COMMAND

• 常數 FORMAT_ELEMENT_COMMAND: LexicalCommand<ElementFormatType>

定義於

packages/lexical/src/LexicalCommands.ts:94

FORMAT_TEXT_COMMAND

• 常數 FORMAT_TEXT_COMMAND: LexicalCommand<TextFormatType>

定義於

packages/lexical/src/LexicalCommands.ts:54

INDENT_CONTENT_COMMAND

• 常數 INDENT_CONTENT_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:86

INSERT_LINE_BREAK_COMMAND

• 常數 INSERT_LINE_BREAK_COMMAND: LexicalCommand<boolean>

定義於

packages/lexical/src/LexicalCommands.ts:35

INSERT_PARAGRAPH_COMMAND

• 常數 INSERT_PARAGRAPH_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:38

INSERT_TAB_COMMAND

• 常數 INSERT_TAB_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:84

IS_ALL_FORMATTING

• 常數 IS_ALL_FORMATTING: number

定義於

packages/lexical/src/LexicalConstants.ts:48

IS_BOLD

• 常數 IS_BOLD: 1

定義於

[packages/lexical/src/LexicalConstants.ts:39](https://github.com/facebook/lex

ical/tree/main/packages/lexical/src/LexicalConstants.ts#L39)

IS_CODE

• 常數 IS_CODE: number

定義於

packages/lexical/src/LexicalConstants.ts:43

IS_HIGHLIGHT

• 常數 IS_HIGHLIGHT: number

定義於

packages/lexical/src/LexicalConstants.ts:46

IS_ITALIC

• 常數 IS_ITALIC: number

定義於

packages/lexical/src/LexicalConstants.ts:40

IS_STRIKETHROUGH

• 常數 IS_STRIKETHROUGH: number

定義於

packages/lexical/src/LexicalConstants.ts:41

IS_SUBSCRIPT

• 常數 IS_SUBSCRIPT: number

定義於

packages/lexical/src/LexicalConstants.ts:44

IS_SUPERSCRIPT

• 常數 IS_SUPERSCRIPT: number

定義於

packages/lexical/src/LexicalConstants.ts:45

IS_UNDERLINE

• 常數 IS_UNDERLINE: number

定義於

packages/lexical/src/LexicalConstants.ts:42

KEY_ARROW_DOWN_COMMAND

• 常數 KEY_ARROW_DOWN_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:70

KEY_ARROW_LEFT_COMMAND

• 常數 KEY_ARROW_LEFT_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:64

KEY_ARROW_RIGHT_COMMAND

• 常數 KEY_ARROW_RIGHT_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:60

KEY_ARROW_UP_COMMAND

• 常數 KEY_ARROW_UP_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:68

KEY_BACKSPACE_COMMAND

• 常數 KEY_BACKSPACE_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:76

KEY_DELETE_COMMAND

• 常數 KEY_DELETE_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:80

KEY_DOWN_COMMAND

• 常數 KEY_DOWN_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:58

KEY_ENTER_COMMAND

• 常數 KEY_ENTER_COMMAND: LexicalCommand<KeyboardEvent | null>

定義於

packages/lexical/src/LexicalCommands.ts:72

KEY_ESCAPE_COMMAND

• 常數 KEY_ESCAPE_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:78

KEY_MODIFIER_COMMAND

• 常數 KEY_MODIFIER_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:124

KEY_SPACE_COMMAND

• 常數 KEY_SPACE_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:74

KEY_TAB_COMMAND

• 常數 KEY_TAB_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:82

MOVE_TO_END

• 常數 MOVE_TO_END: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:62

MOVE_TO_START

• 常數 MOVE_TO_START: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:66

OUTDENT_CONTENT_COMMAND

• 常數 OUTDENT_CONTENT_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:89

PASTE_COMMAND

• 常數 PASTE_COMMAND: LexicalCommand<PasteCommandType>

定義於

packages/lexical/src/LexicalCommands.ts:44

REDO_COMMAND

• 常數 REDO_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:57

REMOVE_TEXT_COMMAND

• 常數 REMOVE_TEXT_COMMAND: LexicalCommand<InputEvent | null>

定義於

[packages/lexical/src/LexicalCommands.ts:46](https://github.com/facebook/lexical/tree/main/packages/lexical/src/LexicalCommands.ts

#L46)

SELECTION_CHANGE_COMMAND

• 常數 SELECTION_CHANGE_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:23

SELECTION_INSERT_CLIPBOARD_NODES_COMMAND

• 常數 SELECTION_INSERT_CLIPBOARD_NODES_COMMAND: LexicalCommand<{ nodes: LexicalNode[] ; selection: BaseSelection }>

定義於

packages/lexical/src/LexicalCommands.ts:26

SELECT_ALL_COMMAND

• 常數 SELECT_ALL_COMMAND: LexicalCommand<KeyboardEvent>

定義於

packages/lexical/src/LexicalCommands.ts:108

TEXT_TYPE_TO_FORMAT

• 常數 TEXT_TYPE_TO_FORMAT: Record<TextFormatType | string, number>

定義於

packages/lexical/src/LexicalConstants.ts:98

UNDO_COMMAND

• 常數 UNDO_COMMAND: LexicalCommand<void>

定義於

packages/lexical/src/LexicalCommands.ts:56

函式

$addUpdateTag

▸ $addUpdateTag(tag): void

參數

名稱	類型
`tag`	`string`

回傳

void

定義於

packages/lexical/src/LexicalUtils.ts:1311

$applyNodeReplacement

▸ $applyNodeReplacement<N>(node): N

類型參數

名稱	類型
`N`	擴展 `LexicalNode`

參數

名稱	類型
`node`	`LexicalNode`

回傳

N

定義於

packages/lexical/src/LexicalUtils.ts:1408

$cloneWithProperties

▸ $cloneWithProperties<T>(latestNode): T

返回一個使用 node.constructor.clone() 生成的節點克隆，接著進行 clone.afterCloneFrom(node) 操作。生成的克隆必須具有相同的鍵、父節點/下一個節點/前一個節點指針，以及其他未由 node.constructor.clone 設置的屬性（格式、樣式等）。這主要由 LexicalNode.getWritable 用於創建現有節點的可寫版本。該克隆與原節點是相同的邏輯節點，請勿嘗試使用此函數來重複或複製現有節點。

不會修改 EditorState。

類型參數

名稱	類型
`T`	擴展 `LexicalNode`

參數

名稱	類型
`latestNode`	`T`

回傳

T

節點的克隆。

定義於

packages/lexical/src/LexicalUtils.ts:1767

$copyNode

▸ $copyNode<T>(node): T

返回具有新鍵的節點的淺層克隆。

類型參數

名稱	類型
`T`	擴展 `LexicalNode`

參數

名稱	類型	描述
`node`	`T`	要複製的節點。

回傳

T

節點的副本。

定義於

packages/lexical/src/LexicalUtils.ts:1402

$createLineBreakNode

▸ $createLineBreakNode(): LineBreakNode

回傳

LineBreakNode

定義於

packages/lexical/src/nodes/LexicalLineBreakNode.ts:82

$createNodeSelection

▸ $createNodeSelection(): NodeSelection

回傳

NodeSelection

定義於

packages/lexical/src/LexicalSelection.ts:2222

$createParagraphNode

▸ $createParagraphNode(): ParagraphNode

回傳

ParagraphNode

定義於

packages/lexical/src/nodes/LexicalParagraphNode.ts:228

$createPoint

▸ $createPoint(key, offset, type): PointType

參數

名稱	類型
`key`	`string`
`offset`	`number`
`type`	`"text"` \| `"element"`

回傳

PointType

定義於

packages/lexical/src/LexicalSelection.ts:159

$createRangeSelection

▸ $createRangeSelection(): RangeSelection

回傳

RangeSelection

定義於

packages/lexical/src/LexicalSelection.ts:2216

$createRangeSelectionFromDom

▸ $createRangeSelectionFromDom(domSelection, editor): null | RangeSelection

參數

名稱	類型
`domSelection`	`null` \| `Selection`
`editor`	`LexicalEditor`

回傳

null | RangeSelection

定義於

packages/lexical/src/LexicalSelection.ts:2244

$createTabNode

▸ $createTabNode(): TabNode

回傳

TabNode

定義於

packages/lexical/src/nodes/LexicalTabNode.ts:86

$createTextNode

▸ $createTextNode(text?): TextNode

參數

名稱	類型	預設值
`text`	`string`	`''`

回傳

TextNode

定義於

packages/lexical/src/nodes/LexicalTextNode.ts:1305

$getAdjacentNode

▸ $getAdjacentNode(focus, isBackward): null | LexicalNode

參數

名稱	類型
`focus`	`PointType`
`isBackward`	`boolean`

回傳

null | LexicalNode

定義於

packages/lexical/src/LexicalUtils.ts:1175

$getCharacterOffsets

▸ $getCharacterOffsets(selection): [number, number]

參數

名稱	類型
`selection`	`BaseSelection`

回傳

[number, number]

定義於

packages/lexical/src/LexicalSelection.ts:1777

$getEditor

▸ $getEditor(): LexicalEditor

用於獲取當前活動的編輯器實例的工具函數。

回傳

LexicalEditor

當前活動的編輯器

定義於

packages/lexical/src/LexicalUtils.ts:1713

$getNearestNodeFromDOMNode

▸ $getNearestNodeFromDOMNode(startingDOM, editorState?): LexicalNode | null

參數

名稱	類型
`startingDOM`	`Node`
`editorState?`	`EditorState`

回傳

LexicalNode | null

定義於

packages/lexical/src/LexicalUtils.ts:452

$getNearestRootOrShadowRoot

▸ $getNearestRootOrShadowRoot(node): RootNode | ElementNode

參數

名稱	類型
`node`	`LexicalNode`

回傳

RootNode | ElementNode

定義於

packages/lexical/src/LexicalUtils.ts:1370

$getNodeByKey

▸ $getNodeByKey<T>(key, _editorState?): T | null

類型參數

名稱	類型
`T`	擴展 `LexicalNode`

參數

名稱	類型
`key`	`string`
`_editorState?`	`EditorState`

回傳

T | null

定義於

packages/lexical/src/LexicalUtils.ts:427

$getNodeByKeyOrThrow

▸ $getNodeByKeyOrThrow<N>(key): N

類型參數

名稱	類型
`N`	擴展 `LexicalNode`

參數

名稱	類型
`key`	`string`

回傳

N

定義於

packages/lexical/src/LexicalUtils.ts:1451

$getPreviousSelection

▸ $getPreviousSelection(): null | BaseSelection

回傳

null | BaseSelection

定義於

packages/lexical/src/LexicalSelection.ts:2336

$getRoot

▸ $getRoot(): RootNode

回傳

RootNode

定義於

packages/lexical/src/LexicalUtils.ts:506

$getSelection

▸ $getSelection(): null | BaseSelection

回傳

null | BaseSelection

定義於

packages/lexical/src/LexicalSelection.ts:2331

$getTextContent

▸ $getTextContent(): string

回傳

string

定義於

packages/lexical/src/LexicalSelection.ts:2718

$hasAncestor

▸ $hasAncestor(child, targetNode): boolean

參數

名稱	類型
`child`	`LexicalNode`
`targetNode`	`LexicalNode`

回傳

boolean

定義於

packages/lexical/src/LexicalUtils.ts:1336

$hasUpdateTag

▸ $hasUpdateTag(tag): boolean

參數

名稱	類型
`tag`	`string`

回傳

boolean

定義於

packages/lexical/src/LexicalUtils.ts:1306

$insertNodes

▸ $insertNodes(nodes): void

參數

名稱	類型
`nodes`	`LexicalNode`[]

回傳

void

定義於

packages/lexical/src/LexicalSelection.ts:2709

$isBlockElementNode

▸ $isBlockElementNode(node): node 是 ElementNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 ElementNode

定義於

packages/lexical/src/LexicalSelection.ts:2186

$isDecoratorNode

▸ $isDecoratorNode<T>(node): node 是 DecoratorNode<T>

類型參數

名稱
`T`

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 DecoratorNode<T>

定義於

packages/lexical/src/nodes/LexicalDecoratorNode.ts:52

$isElementNode

▸ $isElementNode(node): node 是 ElementNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 ElementNode

定義於

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

$isInlineElementOrDecoratorNode

▸ $isInlineElementOrDecoratorNode(node): boolean

參數

名稱	類型
`node`	`LexicalNode`

回傳

boolean

定義於

packages/lexical/src/LexicalUtils.ts:1363

$isLeafNode

▸ $isLeafNode(node): node 是 DecoratorNode<unknown> | TextNode | LineBreakNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 DecoratorNode<unknown> | TextNode | LineBreakNode

定義於

packages/lexical/src/LexicalUtils.ts:228

$isLineBreakNode

▸ $isLineBreakNode(node): node 是 LineBreakNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 LineBreakNode

定義於

packages/lexical/src/nodes/LexicalLineBreakNode.ts:86

$isNodeSelection

▸ $isNodeSelection(x): x 是 NodeSelection

參數

名稱	類型
`x`	`unknown`

回傳

x 是 NodeSelection

定義於

packages/lexical/src/LexicalSelection.ts:1761

$isParagraphNode

▸ $isParagraphNode(node): node 是 ParagraphNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

回傳

node 是 ParagraphNode

定義於

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

$isRangeSelection

▸ $isRangeSelection(x): x 是 RangeSelection

參數

名稱	類型
`x`	`unknown`

回傳

x 是 RangeSelection

定義於

packages/lexical/src/LexicalSelection.ts:393

$isRootNode

▸ $isRootNode(node): node 是 RootNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode` \| `RootNode`

node 是 RootNode

定義於

packages/lexical/src/nodes/LexicalRootNode.ts:128

$isRootOrShadowRoot

▸ $isRootOrShadowRoot(node): node 是 RootNode | ShadowRootNode

參數

名稱	類型
`node`	`null` \| `LexicalNode`

node 是 RootNode | ShadowRootNode

定義於

packages/lexical/src/LexicalUtils.ts:1390

$isTabNode

▸ $isTabNode(node): node 是 TabNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

node 是 TabNode

定義於

packages/lexical/src/nodes/LexicalTabNode.ts:90

$isTextNode

▸ $isTextNode(node): node 是 TextNode

參數

名稱	類型
`node`	`undefined` \| `null` \| `LexicalNode`

node 是 TextNode

定義於

packages/lexical/src/nodes/LexicalTextNode.ts:1309

$isTokenOrSegmented

▸ $isTokenOrSegmented(node): boolean

參數

名稱	類型
`node`	`TextNode`

boolean

定義於

packages/lexical/src/LexicalUtils.ts:188

$nodesOfType

▸ $nodesOfType<T>(klass): T[]

類型參數

名稱	類型
`T`	擴展自 `LexicalNode`

參數

名稱	類型
`klass`	`Klass`<`T`>

T[]

定義於

packages/lexical/src/LexicalUtils.ts:1132

$normalizeSelection__EXPERIMENTAL

▸ $normalizeSelection__EXPERIMENTAL(selection): RangeSelection

參數

名稱	類型
`selection`	`RangeSelection`

RangeSelection

定義於

packages/lexical/src/LexicalNormalization.ts:89

$parseSerializedNode

▸ $parseSerializedNode(serializedNode): LexicalNode

參數

名稱	類型
`serializedNode`	`SerializedLexicalNode`

LexicalNode

定義於

packages/lexical/src/LexicalUpdates.ts:329

$selectAll

▸ $selectAll(): void

void

定義於

packages/lexical/src/LexicalUtils.ts:1067

$setCompositionKey

▸ $setCompositionKey(compositionKey): void

參數

名稱	類型
`compositionKey`	`null` \| `string`

void

定義於

packages/lexical/src/LexicalUtils.ts:398

$setSelection

▸ $setSelection(selection): void

參數

名稱	類型
`selection`	`null` \| `BaseSelection`

void

定義於

packages/lexical/src/LexicalUtils.ts:514

$splitNode

▸ $splitNode(node, offset): [ElementNode | null, ElementNode]

參數

名稱	類型
`node`	`ElementNode`
`offset`	`number`

[ElementNode | null, ElementNode]

定義於

packages/lexical/src/LexicalUtils.ts:1566

createCommand

▸ createCommand<T>(type?): LexicalCommand<T>

類型參數

名稱
`T`

參數

名稱	類型
`type?`	`string`

LexicalCommand<T>

定義於

packages/lexical/src/LexicalCommands.ts:19

createEditor

▸ createEditor(editorConfig?): LexicalEditor

建立一個新的 LexicalEditor 並附加到單一的 contentEditable（由配置提供）。這是 LexicalEditor 的最低層初始化 API。如果你使用的是 React 或其他框架，考慮使用適當的抽象，如 LexicalComposer。

參數

名稱	類型	描述
`editorConfig?`	`CreateEditorArgs`	編輯器配置。

LexicalEditor

一個 LexicalEditor 實例

定義於

packages/lexical/src/LexicalEditor.ts:421

getNearestEditorFromDOMNode

▸ getNearestEditorFromDOMNode(node): LexicalEditor | null

參數

名稱	類型
`node`	`null` \| `Node`

LexicalEditor | null

定義於

packages/lexical/src/LexicalUtils.ts:158

isBlockDomNode

▸ isBlockDomNode(node): boolean

參數

名稱	類型	描述
`node`	`Node`	要檢查的 DOM 節點

boolean

如果 DOM 節點是區塊節點，則返回 true

定義於

packages/lexical/src/LexicalUtils.ts:1666

isCurrentlyReadOnlyMode

▸ isCurrentlyReadOnlyMode(): boolean

boolean

定義於

packages/lexical/src/LexicalUpdates.ts:72

isHTMLAnchorElement

▸ isHTMLAnchorElement(x): x 是 HTMLAnchorElement

參數

名稱	類型	描述
`x`	`Node`	要測試的元素

x 是 HTMLAnchorElement

如果 x 是 HTML 錨點標籤，則返回 true，否則返回 false

定義於

packages/lexical/src/LexicalUtils.ts:1635

isHTMLElement

▸ isHTMLElement(x): x 是 HTMLElement

參數

名稱	類型	描述
`x`	`EventTarget` \| `Node`	要測試的元素

x 是 HTMLElement

如果 x 是 HTML 元素，則返回 true，否則返回 false

定義於

packages/lexical/src/LexicalUtils.ts:1643

isInlineDomNode

▸ isInlineDomNode(node): boolean

參數

名稱	類型	描述
`node`	`Node`	要檢查的 DOM 節點

boolean

如果 DOM 節點是內聯節點，則返回 true

定義於

packages/lexical/src/LexicalUtils.ts:1653

isLexicalEditor

▸ isLexicalEditor(editor): editor 是 LexicalEditor

參數

名稱	類型
`editor`	`unknown`

editor 是 LexicalEditor

如果給定的參數是來自這個 Lexical 构建的 LexicalEditor 實例，則返回 true

定義於

packages/lexical/src/LexicalUtils.ts:153

isSelectionCapturedInDecoratorInput

▸ isSelectionCapturedInDecoratorInput(anchorDOM): boolean

參數

名稱	類型
`anchorDOM`	`Node`

boolean

定義於

packages/lexical/src/LexicalUtils.ts:112

isSelectionWithinEditor

▸ isSelectionWithinEditor(editor, anchorDOM, focusDOM): boolean

參數

名稱	類型
`editor`	`LexicalEditor`
`anchorDOM`	`null` \| `Node`
`focusDOM`	`null` \| `Node`

boolean

定義於

packages/lexical/src/LexicalUtils.ts:129

resetRandomKey

▸ resetRandomKey(): void

void

定義於

packages/lexical/src/LexicalUtils.ts:79

類別​

介面​

型別別名​

CommandListener​

型別參數​

型別宣告​

參數​

回傳值​

定義於​

CommandListenerPriority​

定義於​

CommandPayloadType​

型別參數​

定義於​

CreateEditorArgs​

型別宣告​

定義於​

DOMChildConversion​

型別宣告​

參數​

回傳值​

定義於​

DOMConversion​

型別參數​

型別宣告​

定義於​

DOMConversionFn​

型別參數​

型別宣告​

參數​

回傳值​

定義於​

DOMConversionMap​

型別參數​

定義於​

DOMConversionOutput​

型別宣告​

定義於​

DOMExportOutput​

型別宣告​

定義於​

EditableListener​

型別宣告​

參數​

回傳​

定義於​

EditorConfig​

型別宣告​

定義於​

EditorSetOptions​

型別宣告​

定義於​

EditorThemeClassName​

定義於​

EditorThemeClasses​

索引特徵​

型別宣告​

定義於​

EditorUpdateOptions​

型別宣告​

定義於​

InsertHTMLConfig​

型別宣告​

定義於​

Klass​

型別參數​

定義於​

KlassConstructor​

型別參數​

定義於​

LexicalCommand​

型別參數​

型別聲明​

定義於​

LexicalNodeReplacement​

型別聲明​

定義於​

MutationListener​

型別聲明​

參數​

類別

介面

型別別名

CommandListener

型別參數

型別宣告

參數

回傳值

定義於

CommandListenerPriority

定義於

CommandPayloadType

型別參數

定義於

CreateEditorArgs

型別宣告

定義於

DOMChildConversion

型別宣告

參數

回傳值

定義於

DOMConversion

型別參數

型別宣告

定義於

DOMConversionFn

型別參數

型別宣告

參數

回傳值

定義於

DOMConversionMap

型別參數

定義於

DOMConversionOutput

型別宣告

定義於

DOMExportOutput

型別宣告

定義於

EditableListener

型別宣告

參數

回傳

定義於

EditorConfig

型別宣告

定義於

EditorSetOptions

型別宣告

定義於

EditorThemeClassName

定義於

EditorThemeClasses

索引特徵

型別宣告

定義於

EditorUpdateOptions

型別宣告

定義於

InsertHTMLConfig

型別宣告

定義於

Klass

型別參數

定義於

KlassConstructor

型別參數

定義於

LexicalCommand

型別參數

型別聲明

定義於

LexicalNodeReplacement

型別聲明

定義於

MutationListener

型別聲明

參數