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

Name	Type
element	Node

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

Name	Type
startingNode?	LexicalNode
endingNode?	LexicalNode

Returns

DFSNode[]

Defined in

lexical-utils/src/index.ts:114

---

$findMatchingParent

▸ $findMatchingParent(startingNode, findFn): LexicalNode | null

Parameters

Name	Type
startingNode	LexicalNode
findFn	(node: LexicalNode) => boolean

Returns

LexicalNode | null

Defined in

lexical-utils/src/index.ts:209

---

$getNearestBlockElementAncestorOrThrow

▸ $getNearestBlockElementAncestorOrThrow(startNode): ElementNode

Parameters

Name	Type
startNode	LexicalNode

Returns

ElementNode

Defined in

lexical-utils/src/index.ts:183

---

$getNearestNodeOfType

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

Type parameters

Name	Type
T	extends ElementNode<T>

Parameters

Name	Type
node	LexicalNode
klass	Klass<T>

Returns

T | null

Defined in

lexical-utils/src/index.ts:166

---

$insertNodeToNearestRoot

▸ $insertNodeToNearestRoot<T>(node): T

Type parameters

Name	Type
T	extends LexicalNode<T>

Parameters

Name	Type
node	T

Returns

T

Defined in

lexical-utils/src/index.ts:470

---

$restoreEditorState

▸ $restoreEditorState(editor, editorState): void

Parameters

Name	Type
editor	LexicalEditor
editorState	EditorState

Returns

void

Defined in

lexical-utils/src/index.ts:453

---

$splitNode

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

Parameters

Name	Type
node	ElementNode
offset	number

Returns

[ElementNode | null, ElementNode]

Defined in

lexical-utils/src/index.ts:518

---

$wrapNodeInElement

▸ $wrapNodeInElement(node, createElementNode): ElementNode

Parameters

Name	Type
node	LexicalNode
createElementNode	() => ElementNode

Returns

ElementNode

Defined in

lexical-utils/src/index.ts:508

---

addClassNamesToElement

▸ addClassNamesToElement(element, ...classNames): void

Parameters

Name	Type
element	HTMLElement
...classNames	(undefined | null | string | boolean)[]

Returns

void

Defined in

lexical-utils/src/index.ts:37

---

isMimeType

▸ isMimeType(file, acceptableMimeTypes): boolean

Parameters

Name	Type
file	File
acceptableMimeTypes	string[]

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

Name	Type
files	File[]
acceptableMimeTypes	string[]

Returns

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

Defined in

lexical-utils/src/index.ts:83

---

mergeRegister

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

Parameters

Name	Type
...func	Func[]

Returns

fn

▸ (): void

Returns

void

Defined in

lexical-utils/src/index.ts:228

---

registerNestedElementResolver

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

Type parameters

Name	Type
N	extends ElementNode<N>

Parameters

Name	Type
editor	LexicalEditor
targetNode	Klass<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

Name	Type
element	HTMLElement
...classNames	(undefined | null | string | boolean)[]

Returns

void

Defined in

lexical-utils/src/index.ts:49

---

unstable_convertLegacyJSONEditorState

▸ unstable_convertLegacyJSONEditorState(editor, maybeStringifiedEditorState): EditorState

Parameters

Name	Type
editor	LexicalEditor
maybeStringifiedEditorState	string

Returns

EditorState

Defined in

lexical-utils/src/index.ts:442