Skip to main content

Class: LexicalEditor

lexical.LexicalEditor

Constructors

constructor

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

Parameters

NameType
editorStateEditorState
parentEditornull | LexicalEditor
nodesRegisteredNodes
configEditorConfig
onErrorErrorHandler
htmlConversionsDOMConversionCache
readOnlyboolean

Defined in

lexical/src/LexicalEditor.ts:454

Properties

_cloneNotNeeded

_cloneNotNeeded: Set<string>

Defined in

lexical/src/LexicalEditor.ts:443


_commands

_commands: Commands

Defined in

lexical/src/LexicalEditor.ts:437


_compositionKey

_compositionKey: null | string

Defined in

lexical/src/LexicalEditor.ts:431


_config

_config: EditorConfig

Defined in

lexical/src/LexicalEditor.ts:441


_decorators

_decorators: Record<string, unknown>

Defined in

lexical/src/LexicalEditor.ts:439


_deferred

_deferred: () => void[]

Defined in

lexical/src/LexicalEditor.ts:432


_dirtyElements

_dirtyElements: Map<string, boolean>

Defined in

lexical/src/LexicalEditor.ts:445


_dirtyLeaves

_dirtyLeaves: Set<string>

Defined in

lexical/src/LexicalEditor.ts:444


_dirtyType

_dirtyType: 0 | 1 | 2

Defined in

lexical/src/LexicalEditor.ts:442


_editorState

_editorState: EditorState

Defined in

lexical/src/LexicalEditor.ts:429


_headless

_headless: boolean

Defined in

lexical/src/LexicalEditor.ts:426


_htmlConversions

_htmlConversions: DOMConversionCache

Defined in

lexical/src/LexicalEditor.ts:451


_key

_key: string

Defined in

lexical/src/LexicalEditor.ts:449


_keyToDOMMap

_keyToDOMMap: Map<string, HTMLElement>

Defined in

lexical/src/LexicalEditor.ts:433


_listeners

_listeners: Listeners

Defined in

lexical/src/LexicalEditor.ts:436


_nodes

_nodes: RegisteredNodes

Defined in

lexical/src/LexicalEditor.ts:438


_normalizedNodes

_normalizedNodes: Set<string>

Defined in

lexical/src/LexicalEditor.ts:446


_observer

_observer: null | MutationObserver

Defined in

lexical/src/LexicalEditor.ts:448


_onError

_onError: ErrorHandler

Defined in

lexical/src/LexicalEditor.ts:450


_parentEditor

_parentEditor: null | LexicalEditor

Defined in

lexical/src/LexicalEditor.ts:427


_pendingDecorators

_pendingDecorators: null | Record<string, unknown>

Defined in

lexical/src/LexicalEditor.ts:440


_pendingEditorState

_pendingEditorState: null | EditorState

Defined in

lexical/src/LexicalEditor.ts:430


_readOnly

_readOnly: boolean

Defined in

lexical/src/LexicalEditor.ts:452


_rootElement

_rootElement: null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:428


_updateTags

_updateTags: Set<string>

Defined in

lexical/src/LexicalEditor.ts:447


_updates

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

Defined in

lexical/src/LexicalEditor.ts:434


_updating

_updating: boolean

Defined in

lexical/src/LexicalEditor.ts:435

Methods

blur

blur(): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:816


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:663


focus

focus(callbackFn?, options?): void

Parameters

NameType
callbackFn?() => void
optionsEditorFocusOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:776


getDecorators

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

Type parameters

Name
T

Returns

Record<string, T>

Defined in

lexical/src/LexicalEditor.ts:670


getEditorState

getEditorState(): EditorState

Returns

EditorState

Defined in

lexical/src/LexicalEditor.ts:724


getElementByKey

getElementByKey(key): null | HTMLElement

Parameters

NameType
keystring

Returns

null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:720


getKey

getKey(): string

Returns

string

Defined in

lexical/src/LexicalEditor.ts:678


getRootElement

getRootElement(): null | HTMLElement

Returns

null | HTMLElement

Defined in

lexical/src/LexicalEditor.ts:674


hasNodes

hasNodes<T>(nodes): boolean

Type parameters

NameType
Textends Klass<LexicalNode>

Parameters

NameType
nodesT[]

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:650


isComposing

isComposing(): boolean

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:513


isReadOnly

isReadOnly(): boolean

Returns

boolean

Defined in

lexical/src/LexicalEditor.ts:830


parseEditorState

parseEditorState(maybeStringifiedEditorState, updateFn?): EditorState

Parameters

NameType
maybeStringifiedEditorStatestring | SerializedEditorState
updateFn?() => void

Returns

EditorState

Defined in

lexical/src/LexicalEditor.ts:761


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:559


registerDecoratorListener

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

Type parameters

Name
T

Parameters

NameType
listenerDecoratorListener<T>

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:533


registerMutationListener

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

Parameters

NameType
klassKlass<LexicalNode>
listenerMutationListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:605


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:626


registerReadOnlyListener

registerReadOnlyListener(listener): () => void

Parameters

NameType
listenerReadOnlyListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:525


registerRootListener

registerRootListener(listener): () => void

Parameters

NameType
listenerRootListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:549


registerTextContentListener

registerTextContentListener(listener): () => void

Parameters

NameType
listenerTextContentListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:541


registerUpdateListener

registerUpdateListener(listener): () => void

Parameters

NameType
listenerUpdateListener

Returns

fn

▸ (): void

Returns

void

Defined in

lexical/src/LexicalEditor.ts:517


setEditorState

setEditorState(editorState, options?): void

Parameters

NameType
editorStateEditorState
options?EditorSetOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:728


setReadOnly

setReadOnly(readOnly): void

Parameters

NameType
readOnlyboolean

Returns

void

Defined in

lexical/src/LexicalEditor.ts:834


setRootElement

setRootElement(nextRootElement): void

Parameters

NameType
nextRootElementnull | HTMLElement

Returns

void

Defined in

lexical/src/LexicalEditor.ts:682


toJSON

toJSON(): SerializedEditor

Returns

SerializedEditor

Defined in

lexical/src/LexicalEditor.ts:841


update

update(updateFn, options?): void

Parameters

NameType
updateFn() => void
options?EditorUpdateOptions

Returns

void

Defined in

lexical/src/LexicalEditor.ts:772