Skip to main content

Class: LexicalEditor

lexical.LexicalEditor

Constructors

constructor

new LexicalEditor(editorState, parentEditor, nodes, config, onError, htmlConversions, editable)

Parameters

NameType
editorStateEditorState
parentEditornull | LexicalEditor
nodesRegisteredNodes
configEditorConfig
onErrorErrorHandler
htmlConversionsDOMConversionCache
editableboolean

Defined in

lexical/src/LexicalEditor.ts:460

Properties

_cloneNotNeeded

_cloneNotNeeded: Set<string>

Defined in

lexical/src/LexicalEditor.ts:448


_commands

_commands: Commands

Defined in

lexical/src/LexicalEditor.ts:442


_compositionKey

_compositionKey: null | string

Defined in

lexical/src/LexicalEditor.ts:436


_config

_config: EditorConfig

Defined in

lexical/src/LexicalEditor.ts:446


_decorators

_decorators: Record<string, unknown>

Defined in

lexical/src/LexicalEditor.ts:444


_deferred

_deferred: () => void[]

Defined in

lexical/src/LexicalEditor.ts:437


_dirtyElements

_dirtyElements: Map<string, boolean>

Defined in

lexical/src/LexicalEditor.ts:450


_dirtyLeaves

_dirtyLeaves: Set<string>

Defined in

lexical/src/LexicalEditor.ts:449


_dirtyType

_dirtyType: 0 | 1 | 2

Defined in

lexical/src/LexicalEditor.ts:447


_editable

_editable: boolean

Defined in

lexical/src/LexicalEditor.ts:458


_editorState

_editorState: EditorState

Defined in

lexical/src/LexicalEditor.ts:434


_headless

_headless: boolean

Defined in

lexical/src/LexicalEditor.ts:431


_htmlConversions

_htmlConversions: DOMConversionCache

Defined in

lexical/src/LexicalEditor.ts:456


_key

_key: string

Defined in

lexical/src/LexicalEditor.ts:454


_keyToDOMMap

_keyToDOMMap: Map<string, HTMLElement>

Defined in

lexical/src/LexicalEditor.ts:438


_listeners

_listeners: Listeners

Defined in

lexical/src/LexicalEditor.ts:441


_nodes

_nodes: RegisteredNodes

Defined in

lexical/src/LexicalEditor.ts:443


_normalizedNodes

_normalizedNodes: Set<string>

Defined in

lexical/src/LexicalEditor.ts:451


_observer

_observer: null | MutationObserver

Defined in

lexical/src/LexicalEditor.ts:453


_onError

_onError: ErrorHandler

Defined in

lexical/src/LexicalEditor.ts:455


_parentEditor

_parentEditor: null | LexicalEditor

Defined in

lexical/src/LexicalEditor.ts:432


_pendingDecorators

_pendingDecorators: null | Record<string, unknown>

Defined in

lexical/src/LexicalEditor.ts:445


_pendingEditorState

_pendingEditorState: null | EditorState

Defined in

lexical/src/LexicalEditor.ts:435


_rootElement

_rootElement: null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:433


_updateTags

_updateTags: Set<string>

Defined in

lexical/src/LexicalEditor.ts:452


_updates

_updates: [() => void, undefined | EditorUpdateOptions][]

Defined in

lexical/src/LexicalEditor.ts:439


_updating

_updating: boolean

Defined in

lexical/src/LexicalEditor.ts:440


_window

_window: null | Window

Defined in

lexical/src/LexicalEditor.ts:457

Methods

blur

blur(): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:827


dispatchCommand

dispatchCommand<TCommand, TPayload>(type, payload): boolean

Type parameters

NameType
TCommandextends LexicalCommand<unknown>
TPayloadextends unknown

Parameters

NameType
typeTCommand
payloadTPayload

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:670


focus

focus(callbackFn?, options?): void

Parameters

NameType
callbackFn?() => void
optionsEditorFocusOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:787


getDecorators

getDecorators<T>(): Record<string, T>

Type parameters

Name
T

Returns

Record<string, T>

Defined in

lexical/src/LexicalEditor.ts:677


getEditorState

getEditorState(): EditorState

Returns

EditorState

Defined in

lexical/src/LexicalEditor.ts:735


getElementByKey

getElementByKey(key): null | HTMLElement

Parameters

NameType
keystring

Returns

null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:731


getKey

getKey(): string

Returns

string

Defined in

lexical/src/LexicalEditor.ts:685


getRootElement

getRootElement(): null | HTMLElement

Returns

null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:681


hasNodes

hasNodes<T>(nodes): boolean

Type parameters

NameType
Textends Klass<LexicalNode>

Parameters

NameType
nodesT[]

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:657


isComposing

isComposing(): boolean

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:520


isEditable

isEditable(): boolean

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:841


parseEditorState

parseEditorState(maybeStringifiedEditorState, updateFn?): EditorState

Parameters

NameType
maybeStringifiedEditorStatestring | SerializedEditorState
updateFn?() => void

Returns

EditorState

Defined in

lexical/src/LexicalEditor.ts:772


registerCommand

registerCommand<P>(command, listener, priority): () => void

Type parameters

Name
P

Parameters

NameType
commandLexicalCommand<P>
listenerCommandListener<P>
priorityCommandListenerPriority

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:566


registerDecoratorListener

registerDecoratorListener<T>(listener): () => void

Type parameters

Name
T

Parameters

NameType
listenerDecoratorListener<T>

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:540


registerEditableListener

registerEditableListener(listener): () => void

Parameters

NameType
listenerEditableListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:532


registerMutationListener

registerMutationListener(klass, listener): () => void

Parameters

NameType
klassKlass<LexicalNode>
listenerMutationListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:612


registerNodeTransform

registerNodeTransform<T>(klass, listener): () => void

Type parameters

NameType
Textends LexicalNode<T>

Parameters

NameType
klassKlass<T>
listenerTransform<T>

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:633


registerRootListener

registerRootListener(listener): () => void

Parameters

NameType
listenerRootListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:556


registerTextContentListener

registerTextContentListener(listener): () => void

Parameters

NameType
listenerTextContentListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:548


registerUpdateListener

registerUpdateListener(listener): () => void

Parameters

NameType
listenerUpdateListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:524


setEditable

setEditable(editable): void

Parameters

NameType
editableboolean

Returns

void

Defined in

lexical/src/LexicalEditor.ts:845


setEditorState

setEditorState(editorState, options?): void

Parameters

NameType
editorStateEditorState
options?EditorSetOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:739


setRootElement

setRootElement(nextRootElement): void

Parameters

NameType
nextRootElementnull | HTMLElement

Returns

void

Defined in

lexical/src/LexicalEditor.ts:689


toJSON

toJSON(): SerializedEditor

Returns

SerializedEditor

Defined in

lexical/src/LexicalEditor.ts:852


update

update(updateFn, options?): void

Parameters

NameType
updateFn() => void
options?EditorUpdateOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:783