Skip to main content

Module: lexical

Classes

Interfaces

Type Aliases

CommandListener

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

Type parameters

Name
P

Type declaration

▸ (payload, editor): boolean

Parameters
NameType
payloadP
editorLexicalEditor
Returns

boolean

Defined in

packages/lexical/src/LexicalEditor.ts:243


CommandListenerPriority

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

Defined in

packages/lexical/src/LexicalEditor.ts:247


CommandPayloadType

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

Type helper for extracting the payload type from a command.

Example

const MY_COMMAND = createCommand<SomeType>();

// ...

editor.registerCommand(MY_COMMAND, payload => {
// Type of `payload` is inferred here. But lets say we want to extract a function to delegate to
handleMyCommand(editor, payload);
return true;
});

function handleMyCommand(editor: LexicalEditor, payload: CommandPayloadType<typeof MY_COMMAND>) {
// `payload` is of type `SomeType`, extracted from the command.
}

Type parameters

NameType
TCommandextends LexicalCommand<unknown>

Defined in

packages/lexical/src/LexicalEditor.ts:280


CreateEditorArgs

Ƭ CreateEditorArgs: Object

Type declaration

NameType
disableEvents?boolean
editable?boolean
editorState?EditorState
html?HTMLConfig
namespace?string
nodes?ReadonlyArray<Klass<LexicalNode> | LexicalNodeReplacement>
onError?ErrorHandler
parentEditor?LexicalEditor
theme?EditorThemeClasses

Defined in

packages/lexical/src/LexicalEditor.ts:179


DOMChildConversion

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

Type declaration

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

Parameters
NameType
lexicalNodeLexicalNode
parentLexicalNodeLexicalNode | null | undefined
Returns

LexicalNode | null | undefined

Defined in

packages/lexical/src/LexicalNode.ts:132


DOMConversion

Ƭ DOMConversion<T>: Object

Type parameters

NameType
Textends HTMLElement = HTMLElement

Type declaration

NameType
conversionDOMConversionFn<T>
priority?0 | 1 | 2 | 3 | 4

Defined in

packages/lexical/src/LexicalNode.ts:123


DOMConversionFn

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

Type parameters

NameType
Textends HTMLElement = HTMLElement

Type declaration

▸ (element): DOMConversionOutput | null

Parameters
NameType
elementT
Returns

DOMConversionOutput | null

Defined in

packages/lexical/src/LexicalNode.ts:128


DOMConversionMap

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

Type parameters

NameType
Textends HTMLElement = HTMLElement

Defined in

packages/lexical/src/LexicalNode.ts:137


DOMConversionOutput

Ƭ DOMConversionOutput: Object

Type declaration

NameType
after?(childLexicalNodes: LexicalNode[]) => LexicalNode[]
forChild?DOMChildConversion
nodenull | LexicalNode | LexicalNode[]

Defined in

packages/lexical/src/LexicalNode.ts:143


DOMExportOutput

Ƭ DOMExportOutput: Object

Type declaration

NameType
after?(generatedElement: HTMLElement | Text | null | undefined) => HTMLElement | Text | null | undefined
elementHTMLElement | Text | null

Defined in

packages/lexical/src/LexicalNode.ts:149


EditableListener

Ƭ EditableListener: (editable: boolean) => void

Type declaration

▸ (editable): void

Parameters
NameType
editableboolean
Returns

void

Defined in

packages/lexical/src/LexicalEditor.ts:245


EditorConfig

Ƭ EditorConfig: Object

Type declaration

NameType
disableEvents?boolean
namespacestring
themeEditorThemeClasses

Defined in

packages/lexical/src/LexicalEditor.ts:156


EditorSetOptions

Ƭ EditorSetOptions: Object

Type declaration

NameType
tag?string

Defined in

packages/lexical/src/LexicalEditor.ts:85


EditorThemeClassName

Ƭ EditorThemeClassName: string

Defined in

packages/lexical/src/LexicalEditor.ts:62


EditorThemeClasses

Ƭ EditorThemeClasses: Object

Index signature

▪ [key: string]: any

Type declaration

NameType
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
tableCellPrimarySelected?EditorThemeClassName
tableCellResizer?EditorThemeClassName
tableCellSelected?EditorThemeClassName
tableCellSortedIndicator?EditorThemeClassName
tableResizeRuler?EditorThemeClassName
tableRow?EditorThemeClassName
tableSelected?EditorThemeClassName
text?TextNodeThemeClasses

Defined in

packages/lexical/src/LexicalEditor.ts:93


ElementFormatType

Ƭ ElementFormatType: "left" | "start" | "center" | "right" | "end" | "justify" | ""

Defined in

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


ElementPoint

Ƭ ElementPoint: Object

Type declaration

NameType
_selectionBaseSelection
getNode() => ElementNode
is(point: PointType) => boolean
isBefore(point: PointType) => boolean
keyNodeKey
offsetnumber
set(key: NodeKey, offset: number, type: "text" | "element") => void
type"element"

Defined in

packages/lexical/src/LexicalSelection.ts:78


EventHandler

Ƭ EventHandler: (event: Event, editor: LexicalEditor) => void

Type declaration

▸ (event, editor): void

Parameters
NameType
eventEvent
editorLexicalEditor
Returns

void

Defined in

packages/lexical/src/LexicalEvents.ts:1204


HTMLConfig

Ƭ HTMLConfig: Object

Type declaration

NameType
export?Map<Klass<LexicalNode>, (editor: LexicalEditor, target: LexicalNode) => DOMExportOutput>
import?DOMConversionMap

Defined in

packages/lexical/src/LexicalEditor.ts:171


Klass

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

Type parameters

NameType
Textends LexicalNode

Defined in

packages/lexical/src/LexicalEditor.ts:56


KlassConstructor

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

Type parameters

NameType
Clsextends GenericConstructor<any>

Defined in

packages/lexical/src/LexicalEditor.ts:51


LexicalCommand

Ƭ LexicalCommand<TPayload>: Object

Type parameters

Name
TPayload

Type declaration

NameType
type?string

Defined in

packages/lexical/src/LexicalEditor.ts:256


LexicalNodeReplacement

Ƭ LexicalNodeReplacement: Object

Type declaration

NameType
replaceKlass<LexicalNode>
with<T>(node: InstanceType<T>) => LexicalNode
withKlass?Klass<LexicalNode>

Defined in

packages/lexical/src/LexicalEditor.ts:162


MutationListener

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

Type declaration

▸ (nodes, payload): void

Parameters
NameType
nodesMap<NodeKey, NodeMutation>
payloadObject
payload.dirtyLeavesSet<string>
payload.prevEditorStateEditorState
payload.updateTagsSet<string>
Returns

void

Defined in

packages/lexical/src/LexicalEditor.ts:234


NodeKey

Ƭ NodeKey: string

Defined in

packages/lexical/src/LexicalNode.ts:156


NodeMap

Ƭ NodeMap: Map<NodeKey, LexicalNode>

Defined in

packages/lexical/src/LexicalNode.ts:50


NodeMutation

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

Defined in

packages/lexical/src/LexicalEditor.ts:212


PasteCommandType

Ƭ PasteCommandType: ClipboardEvent | InputEvent | KeyboardEvent

Defined in

packages/lexical/src/LexicalCommands.ts:17


PointType

Ƭ PointType: TextPoint | ElementPoint

Defined in

packages/lexical/src/LexicalSelection.ts:89


SerializedEditor

Ƭ SerializedEditor: Object

Type declaration

NameType
editorStateSerializedEditorState

Defined in

packages/lexical/src/LexicalEditor.ts:321


SerializedElementNode

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

Type parameters

NameType
Textends SerializedLexicalNode = SerializedLexicalNode

Defined in

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


SerializedLexicalNode

Ƭ SerializedLexicalNode: Object

Type declaration

NameType
typestring
versionnumber

Defined in

packages/lexical/src/LexicalNode.ts:52


SerializedLineBreakNode

Ƭ SerializedLineBreakNode: SerializedLexicalNode

Defined in

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


SerializedParagraphNode

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

Defined in

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


SerializedRootNode

Ƭ SerializedRootNode<T>: SerializedElementNode<T>

Type parameters

NameType
Textends SerializedLexicalNode = SerializedLexicalNode

Defined in

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


SerializedTabNode

Ƭ SerializedTabNode: SerializedTextNode

Defined in

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


SerializedTextNode

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

Defined in

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


Spread

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

Type parameters

Name
T1
T2

Defined in

packages/lexical/src/LexicalEditor.ts:47


TextFormatType

Ƭ TextFormatType: "bold" | "underline" | "strikethrough" | "italic" | "highlight" | "code" | "subscript" | "superscript"

Defined in

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


TextModeType

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

Defined in

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


TextPoint

Ƭ TextPoint: Object

Type declaration

NameType
_selectionBaseSelection
getNode() => TextNode
is(point: PointType) => boolean
isBefore(point: PointType) => boolean
keyNodeKey
offsetnumber
set(key: NodeKey, offset: number, type: "text" | "element") => void
type"text"

Defined in

packages/lexical/src/LexicalSelection.ts:67


Transform

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

Type parameters

NameType
Textends LexicalNode

Type declaration

▸ (node): void

Parameters
NameType
nodeT
Returns

void

Defined in

packages/lexical/src/LexicalEditor.ts:204

Variables

BLUR_COMMAND

Const BLUR_COMMAND: LexicalCommand<FocusEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:122


CAN_REDO_COMMAND

Const CAN_REDO_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:116


CAN_UNDO_COMMAND

Const CAN_UNDO_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:118


CLEAR_EDITOR_COMMAND

Const CLEAR_EDITOR_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:110


CLEAR_HISTORY_COMMAND

Const CLEAR_HISTORY_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:113


CLICK_COMMAND

Const CLICK_COMMAND: LexicalCommand<MouseEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:30


COMMAND_PRIORITY_CRITICAL

Const COMMAND_PRIORITY_CRITICAL: 4

Defined in

packages/lexical/src/LexicalEditor.ts:253


COMMAND_PRIORITY_EDITOR

Const COMMAND_PRIORITY_EDITOR: 0

Defined in

packages/lexical/src/LexicalEditor.ts:249


COMMAND_PRIORITY_HIGH

Const COMMAND_PRIORITY_HIGH: 3

Defined in

packages/lexical/src/LexicalEditor.ts:252


COMMAND_PRIORITY_LOW

Const COMMAND_PRIORITY_LOW: 1

Defined in

packages/lexical/src/LexicalEditor.ts:250


COMMAND_PRIORITY_NORMAL

Const COMMAND_PRIORITY_NORMAL: 2

Defined in

packages/lexical/src/LexicalEditor.ts:251


CONTROLLED_TEXT_INSERTION_COMMAND

Const CONTROLLED_TEXT_INSERTION_COMMAND: LexicalCommand<InputEvent | string>

Defined in

packages/lexical/src/LexicalCommands.ts:41


COPY_COMMAND

Const COPY_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>

Defined in

packages/lexical/src/LexicalCommands.ts:102


CUT_COMMAND

Const CUT_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>

Defined in

packages/lexical/src/LexicalCommands.ts:105


DELETE_CHARACTER_COMMAND

Const DELETE_CHARACTER_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:32


DELETE_LINE_COMMAND

Const DELETE_LINE_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:51


DELETE_WORD_COMMAND

Const DELETE_WORD_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:48


DRAGEND_COMMAND

Const DRAGEND_COMMAND: LexicalCommand<DragEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:100


DRAGOVER_COMMAND

Const DRAGOVER_COMMAND: LexicalCommand<DragEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:98


DRAGSTART_COMMAND

Const DRAGSTART_COMMAND: LexicalCommand<DragEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:96


DROP_COMMAND

Const DROP_COMMAND: LexicalCommand<DragEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:92


FOCUS_COMMAND

Const FOCUS_COMMAND: LexicalCommand<FocusEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:120


FORMAT_ELEMENT_COMMAND

Const FORMAT_ELEMENT_COMMAND: LexicalCommand<ElementFormatType>

Defined in

packages/lexical/src/LexicalCommands.ts:94


FORMAT_TEXT_COMMAND

Const FORMAT_TEXT_COMMAND: LexicalCommand<TextFormatType>

Defined in

packages/lexical/src/LexicalCommands.ts:54


INDENT_CONTENT_COMMAND

Const INDENT_CONTENT_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:86


INSERT_LINE_BREAK_COMMAND

Const INSERT_LINE_BREAK_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical/src/LexicalCommands.ts:35


INSERT_PARAGRAPH_COMMAND

Const INSERT_PARAGRAPH_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:38


INSERT_TAB_COMMAND

Const INSERT_TAB_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:84


KEY_ARROW_DOWN_COMMAND

Const KEY_ARROW_DOWN_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:70


KEY_ARROW_LEFT_COMMAND

Const KEY_ARROW_LEFT_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:64


KEY_ARROW_RIGHT_COMMAND

Const KEY_ARROW_RIGHT_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:60


KEY_ARROW_UP_COMMAND

Const KEY_ARROW_UP_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:68


KEY_BACKSPACE_COMMAND

Const KEY_BACKSPACE_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:76


KEY_DELETE_COMMAND

Const KEY_DELETE_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:80


KEY_DOWN_COMMAND

Const KEY_DOWN_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:58


KEY_ENTER_COMMAND

Const KEY_ENTER_COMMAND: LexicalCommand<KeyboardEvent | null>

Defined in

packages/lexical/src/LexicalCommands.ts:72


KEY_ESCAPE_COMMAND

Const KEY_ESCAPE_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:78


KEY_MODIFIER_COMMAND

Const KEY_MODIFIER_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:124


KEY_SPACE_COMMAND

Const KEY_SPACE_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:74


KEY_TAB_COMMAND

Const KEY_TAB_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:82


MOVE_TO_END

Const MOVE_TO_END: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:62


MOVE_TO_START

Const MOVE_TO_START: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:66


OUTDENT_CONTENT_COMMAND

Const OUTDENT_CONTENT_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:89


PASTE_COMMAND

Const PASTE_COMMAND: LexicalCommand<PasteCommandType>

Defined in

packages/lexical/src/LexicalCommands.ts:44


REDO_COMMAND

Const REDO_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:57


REMOVE_TEXT_COMMAND

Const REMOVE_TEXT_COMMAND: LexicalCommand<InputEvent | null>

Defined in

packages/lexical/src/LexicalCommands.ts:46


SELECTION_CHANGE_COMMAND

Const SELECTION_CHANGE_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:23


SELECTION_INSERT_CLIPBOARD_NODES_COMMAND

Const SELECTION_INSERT_CLIPBOARD_NODES_COMMAND: LexicalCommand<{ nodes: LexicalNode[] ; selection: BaseSelection }>

Defined in

packages/lexical/src/LexicalCommands.ts:26


SELECT_ALL_COMMAND

Const SELECT_ALL_COMMAND: LexicalCommand<KeyboardEvent>

Defined in

packages/lexical/src/LexicalCommands.ts:108


UNDO_COMMAND

Const UNDO_COMMAND: LexicalCommand<void>

Defined in

packages/lexical/src/LexicalCommands.ts:56

Functions

$addUpdateTag

$addUpdateTag(tag): void

Parameters

NameType
tagstring

Returns

void

Defined in

packages/lexical/src/LexicalUtils.ts:1294


$applyNodeReplacement

$applyNodeReplacement<N>(node): N

Type parameters

NameType
Nextends LexicalNode

Parameters

NameType
nodeLexicalNode

Returns

N

Defined in

packages/lexical/src/LexicalUtils.ts:1386


$copyNode

$copyNode<T>(node): T

Type parameters

NameType
Textends LexicalNode

Parameters

NameType
nodeT

Returns

T

Defined in

packages/lexical/src/LexicalUtils.ts:1379


$createLineBreakNode

$createLineBreakNode(): LineBreakNode

Returns

LineBreakNode

Defined in

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


$createNodeSelection

$createNodeSelection(): NodeSelection

Returns

NodeSelection

Defined in

packages/lexical/src/LexicalSelection.ts:2207


$createParagraphNode

$createParagraphNode(): ParagraphNode

Returns

ParagraphNode

Defined in

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


$createPoint

$createPoint(key, offset, type): PointType

Parameters

NameType
keystring
offsetnumber
type"text" | "element"

Returns

PointType

Defined in

packages/lexical/src/LexicalSelection.ts:159


$createRangeSelection

$createRangeSelection(): RangeSelection

Returns

RangeSelection

Defined in

packages/lexical/src/LexicalSelection.ts:2201


$createRangeSelectionFromDom

$createRangeSelectionFromDom(domSelection, editor): null | RangeSelection

Parameters

NameType
domSelectionnull | Selection
editorLexicalEditor

Returns

null | RangeSelection

Defined in

packages/lexical/src/LexicalSelection.ts:2229


$createTabNode

$createTabNode(): TabNode

Returns

TabNode

Defined in

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


$createTextNode

$createTextNode(text?): TextNode

Parameters

NameTypeDefault value
textstring''

Returns

TextNode

Defined in

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


$getAdjacentNode

$getAdjacentNode(focus, isBackward): null | LexicalNode

Parameters

NameType
focusPointType
isBackwardboolean

Returns

null | LexicalNode

Defined in

packages/lexical/src/LexicalUtils.ts:1158


$getCharacterOffsets

$getCharacterOffsets(selection): [number, number]

Parameters

NameType
selectionBaseSelection

Returns

[number, number]

Defined in

packages/lexical/src/LexicalSelection.ts:1762


$getEditor

$getEditor(): LexicalEditor

Utility function for accessing current active editor instance.

Returns

LexicalEditor

Current active editor

Defined in

packages/lexical/src/LexicalUtils.ts:1691


$getNearestNodeFromDOMNode

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

Parameters

NameType
startingDOMNode
editorState?EditorState

Returns

LexicalNode | null

Defined in

packages/lexical/src/LexicalUtils.ts:440


$getNearestRootOrShadowRoot

$getNearestRootOrShadowRoot(node): RootNode | ElementNode

Parameters

NameType
nodeLexicalNode

Returns

RootNode | ElementNode

Defined in

packages/lexical/src/LexicalUtils.ts:1353


$getNodeByKey

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

Type parameters

NameType
Textends LexicalNode

Parameters

NameType
keystring
_editorState?EditorState

Returns

T | null

Defined in

packages/lexical/src/LexicalUtils.ts:415


$getPreviousSelection

$getPreviousSelection(): null | BaseSelection

Returns

null | BaseSelection

Defined in

packages/lexical/src/LexicalSelection.ts:2321


$getRoot

$getRoot(): RootNode

Returns

RootNode

Defined in

packages/lexical/src/LexicalUtils.ts:494


$getSelection

$getSelection(): null | BaseSelection

Returns

null | BaseSelection

Defined in

packages/lexical/src/LexicalSelection.ts:2316


$getTextContent

$getTextContent(): string

Returns

string

Defined in

packages/lexical/src/LexicalSelection.ts:2703


$hasAncestor

$hasAncestor(child, targetNode): boolean

Parameters

NameType
childLexicalNode
targetNodeLexicalNode

Returns

boolean

Defined in

packages/lexical/src/LexicalUtils.ts:1319


$hasUpdateTag

$hasUpdateTag(tag): boolean

Parameters

NameType
tagstring

Returns

boolean

Defined in

packages/lexical/src/LexicalUtils.ts:1289


$insertNodes

$insertNodes(nodes): void

Parameters

NameType
nodesLexicalNode[]

Returns

void

Defined in

packages/lexical/src/LexicalSelection.ts:2694


$isBlockElementNode

$isBlockElementNode(node): node is ElementNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is ElementNode

Defined in

packages/lexical/src/LexicalSelection.ts:2171


$isDecoratorNode

$isDecoratorNode<T>(node): node is DecoratorNode<T>

Type parameters

Name
T

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is DecoratorNode<T>

Defined in

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


$isElementNode

$isElementNode(node): node is ElementNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is ElementNode

Defined in

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


$isInlineElementOrDecoratorNode

$isInlineElementOrDecoratorNode(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Defined in

packages/lexical/src/LexicalUtils.ts:1346


$isLeafNode

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

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is TextNode | DecoratorNode<unknown> | LineBreakNode

Defined in

packages/lexical/src/LexicalUtils.ts:216


$isLineBreakNode

$isLineBreakNode(node): node is LineBreakNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is LineBreakNode

Defined in

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


$isNodeSelection

$isNodeSelection(x): x is NodeSelection

Parameters

NameType
xunknown

Returns

x is NodeSelection

Defined in

packages/lexical/src/LexicalSelection.ts:1746


$isParagraphNode

$isParagraphNode(node): node is ParagraphNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is ParagraphNode

Defined in

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


$isRangeSelection

$isRangeSelection(x): x is RangeSelection

Parameters

NameType
xunknown

Returns

x is RangeSelection

Defined in

packages/lexical/src/LexicalSelection.ts:393


$isRootNode

$isRootNode(node): node is RootNode

Parameters

NameType
nodeundefined | null | LexicalNode | RootNode

Returns

node is RootNode

Defined in

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


$isRootOrShadowRoot

$isRootOrShadowRoot(node): node is RootNode | ShadowRootNode

Parameters

NameType
nodenull | LexicalNode

Returns

node is RootNode | ShadowRootNode

Defined in

packages/lexical/src/LexicalUtils.ts:1373


$isTabNode

$isTabNode(node): node is TabNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is TabNode

Defined in

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


$isTextNode

$isTextNode(node): node is TextNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is TextNode

Defined in

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


$nodesOfType

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

Type parameters

NameType
Textends LexicalNode

Parameters

NameType
klassKlass<T>

Returns

T[]

Defined in

packages/lexical/src/LexicalUtils.ts:1120


$normalizeSelection__EXPERIMENTAL

$normalizeSelection__EXPERIMENTAL(selection): RangeSelection

Parameters

NameType
selectionRangeSelection

Returns

RangeSelection

Defined in

packages/lexical/src/LexicalNormalization.ts:89


$parseSerializedNode

$parseSerializedNode(serializedNode): LexicalNode

Parameters

NameType
serializedNodeSerializedLexicalNode

Returns

LexicalNode

Defined in

packages/lexical/src/LexicalUpdates.ts:293


$selectAll

$selectAll(): void

Returns

void

Defined in

packages/lexical/src/LexicalUtils.ts:1055


$setCompositionKey

$setCompositionKey(compositionKey): void

Parameters

NameType
compositionKeynull | string

Returns

void

Defined in

packages/lexical/src/LexicalUtils.ts:386


$setSelection

$setSelection(selection): void

Parameters

NameType
selectionnull | BaseSelection

Returns

void

Defined in

packages/lexical/src/LexicalUtils.ts:502


$splitNode

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

Parameters

NameType
nodeElementNode
offsetnumber

Returns

[ElementNode | null, ElementNode]

Defined in

packages/lexical/src/LexicalUtils.ts:1544


createCommand

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

Type parameters

Name
T

Parameters

NameType
type?string

Returns

LexicalCommand<T>

Defined in

packages/lexical/src/LexicalCommands.ts:19


createEditor

createEditor(editorConfig?): LexicalEditor

Creates a new LexicalEditor attached to a single contentEditable (provided in the config). This is the lowest-level initialization API for a LexicalEditor. If you're using React or another framework, consider using the appropriate abstractions, such as LexicalComposer

Parameters

NameTypeDescription
editorConfig?CreateEditorArgsthe editor configuration.

Returns

LexicalEditor

a LexicalEditor instance

Defined in

packages/lexical/src/LexicalEditor.ts:408


getNearestEditorFromDOMNode

getNearestEditorFromDOMNode(node): LexicalEditor | null

Parameters

NameType
nodenull | Node

Returns

LexicalEditor | null

Defined in

packages/lexical/src/LexicalUtils.ts:151


isBlockDomNode

isBlockDomNode(node): boolean

Parameters

NameTypeDescription
nodeNodethe Dom Node to check

Returns

boolean

if the Dom Node is a block node

Defined in

packages/lexical/src/LexicalUtils.ts:1644


isCurrentlyReadOnlyMode

isCurrentlyReadOnlyMode(): boolean

Returns

boolean

Defined in

packages/lexical/src/LexicalUpdates.ts:70


isHTMLAnchorElement

isHTMLAnchorElement(x): x is HTMLAnchorElement

Parameters

NameTypeDescription
xNodeThe element being tested

Returns

x is HTMLAnchorElement

Returns true if x is an HTML anchor tag, false otherwise

Defined in

packages/lexical/src/LexicalUtils.ts:1613


isHTMLElement

isHTMLElement(x): x is HTMLElement

Parameters

NameTypeDescription
xEventTarget | NodeThe element being testing

Returns

x is HTMLElement

Returns true if x is an HTML element, false otherwise.

Defined in

packages/lexical/src/LexicalUtils.ts:1621


isInlineDomNode

isInlineDomNode(node): boolean

Parameters

NameTypeDescription
nodeNodethe Dom Node to check

Returns

boolean

if the Dom Node is an inline node

Defined in

packages/lexical/src/LexicalUtils.ts:1631


isSelectionCapturedInDecoratorInput

isSelectionCapturedInDecoratorInput(anchorDOM): boolean

Parameters

NameType
anchorDOMNode

Returns

boolean

Defined in

packages/lexical/src/LexicalUtils.ts:112


isSelectionWithinEditor

isSelectionWithinEditor(editor, anchorDOM, focusDOM): boolean

Parameters

NameType
editorLexicalEditor
anchorDOMnull | Node
focusDOMnull | Node

Returns

boolean

Defined in

packages/lexical/src/LexicalUtils.ts:130