Module: @lexical/utils
Type Aliases
DFSNode
Ƭ DFSNode: Readonly<{ depth: number ; node: LexicalNode }>
Defined in
lexical-utils/src/index.ts:30
DOMNodeToLexicalConversion
Ƭ DOMNodeToLexicalConversion: (element: Node) => LexicalNode
Type declaration
▸ (element): LexicalNode
Parameters
| Name | Type |
|---|---|
element | Node |
Returns
Defined in
lexical-utils/src/index.ts:146
DOMNodeToLexicalConversionMap
Ƭ DOMNodeToLexicalConversionMap: Record<string, DOMNodeToLexicalConversion>
Defined in
lexical-utils/src/index.ts:148
Functions
$dfs
▸ $dfs(startingNode?, endingNode?): DFSNode[]
Parameters
| Name | Type |
|---|---|
startingNode? | LexicalNode |
endingNode? | LexicalNode |
Returns
DFSNode[]
Defined in
lexical-utils/src/index.ts:58
$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:153
$getNearestBlockElementAncestorOrThrow
▸ $getNearestBlockElementAncestorOrThrow(startNode): ElementNode
Parameters
| Name | Type |
|---|---|
startNode | LexicalNode |
Returns
Defined in
lexical-utils/src/index.ts:127
$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:110
$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:414
$restoreEditorState
▸ $restoreEditorState(editor, editorState): void
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
editorState | EditorState |
Returns
void
Defined in
lexical-utils/src/index.ts:397
$wrapNodeInElement
▸ $wrapNodeInElement(node, createElementNode): ElementNode
Parameters
| Name | Type |
|---|---|
node | LexicalNode |
createElementNode | () => ElementNode |
Returns
Defined in
lexical-utils/src/index.ts:435
addClassNamesToElement
▸ addClassNamesToElement(element, ...classNames): void
Parameters
| Name | Type |
|---|---|
element | HTMLElement |
...classNames | (undefined | null | string | boolean)[] |
Returns
void
Defined in
lexical-utils/src/index.ts:35
mergeRegister
▸ mergeRegister(...func): () => void
Parameters
| Name | Type |
|---|---|
...func | Func[] |
Returns
fn
▸ (): void
Returns
void
Defined in
lexical-utils/src/index.ts:172
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:178
removeClassNamesFromElement
▸ removeClassNamesFromElement(element, ...classNames): void
Parameters
| Name | Type |
|---|---|
element | HTMLElement |
...classNames | (undefined | null | string | boolean)[] |
Returns
void
Defined in
lexical-utils/src/index.ts:47
unstable_convertLegacyJSONEditorState
▸ unstable_convertLegacyJSONEditorState(editor, maybeStringifiedEditorState): EditorState
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
maybeStringifiedEditorState | string |
Returns
Defined in
lexical-utils/src/index.ts:386