Skip to main content

Module: @lexical/utils

Type Aliases

DFSNode

Ƭ DFSNode: Readonly<{ depth: number ; node: LexicalNode }>

Defined in

lexical-utils/src/index.ts:32


DOMNodeToLexicalConversion

Ƭ DOMNodeToLexicalConversion: (element: Node) => LexicalNode

Type declaration

▸ (element): LexicalNode

Parameters
NameType
elementNode
Returns

LexicalNode

Defined in

lexical-utils/src/index.ts:202


DOMNodeToLexicalConversionMap

Ƭ DOMNodeToLexicalConversionMap: Record<string, DOMNodeToLexicalConversion>

Defined in

lexical-utils/src/index.ts:204

Functions

$dfs

$dfs(startingNode?, endingNode?): DFSNode[]

Parameters

NameType
startingNode?LexicalNode
endingNode?LexicalNode

Returns

DFSNode[]

Defined in

lexical-utils/src/index.ts:114


$findMatchingParent

$findMatchingParent(startingNode, findFn): LexicalNode | null

Parameters

NameType
startingNodeLexicalNode
findFn(node: LexicalNode) => boolean

Returns

LexicalNode | null

Defined in

lexical-utils/src/index.ts:209


$getNearestBlockElementAncestorOrThrow

$getNearestBlockElementAncestorOrThrow(startNode): ElementNode

Parameters

NameType
startNodeLexicalNode

Returns

ElementNode

Defined in

lexical-utils/src/index.ts:183


$getNearestNodeOfType

$getNearestNodeOfType<T>(node, klass): T | null

Type parameters

NameType
Textends ElementNode<T>

Parameters

NameType
nodeLexicalNode
klassKlass<T>

Returns

T | null

Defined in

lexical-utils/src/index.ts:166


$insertNodeToNearestRoot

$insertNodeToNearestRoot<T>(node): T

Type parameters

NameType
Textends LexicalNode<T>

Parameters

NameType
nodeT

Returns

T

Defined in

lexical-utils/src/index.ts:470


$restoreEditorState

$restoreEditorState(editor, editorState): void

Parameters

NameType
editorLexicalEditor
editorStateEditorState

Returns

void

Defined in

lexical-utils/src/index.ts:453


$splitNode

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

Parameters

NameType
nodeElementNode
offsetnumber

Returns

[ElementNode | null, ElementNode]

Defined in

lexical-utils/src/index.ts:518


$wrapNodeInElement

$wrapNodeInElement(node, createElementNode): ElementNode

Parameters

NameType
nodeLexicalNode
createElementNode() => ElementNode

Returns

ElementNode

Defined in

lexical-utils/src/index.ts:508


addClassNamesToElement

addClassNamesToElement(element, ...classNames): void

Parameters

NameType
elementHTMLElement
...classNames(undefined | null | string | boolean)[]

Returns

void

Defined in

lexical-utils/src/index.ts:37


isMimeType

isMimeType(file, acceptableMimeTypes): boolean

Parameters

NameType
fileFile
acceptableMimeTypesstring[]

Returns

boolean

Defined in

lexical-utils/src/index.ts:60


mediaFileReader

mediaFileReader(files, acceptableMimeTypes): Promise<{ file: File ; result: string }[]>

Lexical File Reader with:

  1. MIME type support
  2. batched results (HistoryPlugin compatibility)
  3. Order aware (respects the order when multiple Files are passed)

const filesResult = await mediaFileReader(files, ['image/']); filesResult.forEach(file => editor.dispatchCommand('INSERT_IMAGE', { src: file.result, }));

Parameters

NameType
filesFile[]
acceptableMimeTypesstring[]

Returns

Promise<{ file: File ; result: string }[]>

Defined in

lexical-utils/src/index.ts:83


mergeRegister

mergeRegister(...func): () => void

Parameters

NameType
...funcFunc[]

Returns

fn

▸ (): void

Returns

void

Defined in

lexical-utils/src/index.ts:228


registerNestedElementResolver

registerNestedElementResolver<N>(editor, targetNode, cloneNode, handleOverlap): () => void

Type parameters

NameType
Nextends ElementNode<N>

Parameters

NameType
editorLexicalEditor
targetNodeKlass<N>
cloneNode(from: N) => N
handleOverlap(from: N, to: N) => void

Returns

fn

▸ (): void

Returns

void

Defined in

lexical-utils/src/index.ts:234


removeClassNamesFromElement

removeClassNamesFromElement(element, ...classNames): void

Parameters

NameType
elementHTMLElement
...classNames(undefined | null | string | boolean)[]

Returns

void

Defined in

lexical-utils/src/index.ts:49


unstable_convertLegacyJSONEditorState

unstable_convertLegacyJSONEditorState(editor, maybeStringifiedEditorState): EditorState

Parameters

NameType
editorLexicalEditor
maybeStringifiedEditorStatestring

Returns

EditorState

Defined in

lexical-utils/src/index.ts:442