Skip to main content

@lexical/html

Interfaces​

DOMRenderExtensionOutput​

Defined in: packages/lexical-html/src/types.ts:45

Properties​

defaults​

defaults: ContextRecord<_K> | undefined

Defined in: packages/lexical-html/src/types.ts:46

Type Aliases​

AnyRenderStateConfig​

AnyRenderStateConfig = RenderStateConfig<any>

Defined in: packages/lexical-html/src/types.ts:59

AnyRenderStateConfigPairOrUpdater​

AnyRenderStateConfigPairOrUpdater = AnyContextConfigPairOrUpdater<typeof DOMRenderContextSymbol>

Defined in: packages/lexical-html/src/types.ts:54

ContextPairOrUpdater​

ContextPairOrUpdater<Ctx, V> = ContextConfigPair<Ctx, V> | ContextConfigUpdater<Ctx, V>

Defined in: packages/lexical-html/src/types.ts:37

Type Parameters​

Ctx​

Ctx extends AnyContextSymbol

V​

V

NodeMatch​

NodeMatch<T> = Klass<T> | ((node) => node is T)

Defined in: packages/lexical-html/src/types.ts:71

Type Parameters​

T​

T extends LexicalNode

Variables​

$withRenderContext​

const $withRenderContext: (cfg, editor?) => <T>(f) => T

Defined in: packages/lexical-html/src/RenderContext.ts:85

Parameters​

cfg​

readonly AnyRenderStateConfigPairOrUpdater[]

editor?​

LexicalEditor

Returns​

<T>(f) => T

IGNORE_TAGS​

const IGNORE_TAGS: Set<string>

Defined in: packages/lexical-html/src/index.ts:138

RenderContextExport​

const RenderContextExport: RenderStateConfig<boolean>

Defined in: packages/lexical-html/src/RenderContext.ts:57

true if this is an export operation ($generateHtmlFromNodes)

RenderContextRoot​

const RenderContextRoot: RenderStateConfig<boolean>

Defined in: packages/lexical-html/src/RenderContext.ts:52

true if the export was initiated from the root of the document

Functions​

$generateDOMFromNodes()​

$generateDOMFromNodes<T>(container, selection?, editor?): T

Defined in: packages/lexical-html/src/index.ts:178

Type Parameters​

T​

T extends HTMLElement | DocumentFragment

Parameters​

container​

T

selection?​

BaseSelection | null

editor?​

LexicalEditor = ...

Returns​

T

$generateDOMFromRoot()​

$generateDOMFromRoot<T>(container, root?): T

Defined in: packages/lexical-html/src/index.ts:204

Type Parameters​

T​

T extends HTMLElement | DocumentFragment

Parameters​

container​

T

root?​

LexicalNode = ...

Returns​

T

$generateHtmlFromNodes()​

$generateHtmlFromNodes(editor, selection?): string

Defined in: packages/lexical-html/src/index.ts:224

Parameters​

editor​

LexicalEditor

selection?​

BaseSelection | null

Returns​

string

$generateNodesFromDOM()​

$generateNodesFromDOM(editor, dom): LexicalNode[]

Defined in: packages/lexical-html/src/index.ts:145

How you parse your html string to get a document is left up to you. In the browser you can use the native DOMParser API to generate a document (see clipboard.ts), but to use in a headless environment you can use JSDom or an equivalent library and pass in the document here.

Parameters​

editor​

LexicalEditor

dom​

Document | ParentNode

Returns​

LexicalNode[]

$getRenderContextValue()​

$getRenderContextValue<V>(cfg, editor?): V

Defined in: packages/lexical-html/src/RenderContext.ts:78

Type Parameters​

V​

V

Parameters​

cfg​

RenderStateConfig<V>

editor?​

LexicalEditor = ...

Returns​

V

$unwrapArtificialNodes()​

$unwrapArtificialNodes(allArtificialNodes): void

Defined in: packages/lexical-html/src/index.ts:510

Parameters​

allArtificialNodes​

ArtificialNode__DO_NOT_USE[]

Returns​

void

$wrapContinuousInlinesInPlace()​

$wrapContinuousInlinesInPlace(nodes, $createWrapperFn): void

Defined in: packages/lexical-html/src/index.ts:531

Parameters​

nodes​

LexicalNode[]

$createWrapperFn​

() => ElementNode

Returns​

void

contextUpdater()​

contextUpdater<Ctx, V>(cfg, updater): ContextConfigUpdater<Ctx, V>

Defined in: packages/lexical-html/src/ContextRecord.ts:121

Type Parameters​

Ctx​

Ctx extends typeof DOMRenderContextSymbol

V​

V

Parameters​

cfg​

ContextConfig<Ctx, V>

updater​

(prev) => V

Returns​

ContextConfigUpdater<Ctx, V>

contextValue()​

contextValue<Ctx, V>(cfg, value): ContextConfigPair<Ctx, V>

Defined in: packages/lexical-html/src/ContextRecord.ts:114

Type Parameters​

Ctx​

Ctx extends typeof DOMRenderContextSymbol

V​

V

Parameters​

cfg​

ContextConfig<Ctx, V>

value​

V

Returns​

ContextConfigPair<Ctx, V>

domOverride()​

Call Signature​

domOverride(nodes, config): DOMRenderMatch<LexicalNode>

Defined in: packages/lexical-html/src/domOverride.ts:18

A convenience function for type inference when constructing DOM overrides for use with DOMRenderExtension.

@NO_SIDE_EFFECTS

Parameters​
nodes​

"*"

config​

Omit<DOMRenderMatch<LexicalNode>, "nodes">

Returns​

DOMRenderMatch<LexicalNode>

Call Signature​

domOverride<T>(nodes, config): DOMRenderMatch<T>

Defined in: packages/lexical-html/src/domOverride.ts:22

A convenience function for type inference when constructing DOM overrides for use with DOMRenderExtension.

@NO_SIDE_EFFECTS

Type Parameters​
T​

T extends LexicalNode

Parameters​
nodes​

readonly NodeMatch<T>[]

config​

Omit<DOMRenderMatch<T>, "nodes">

Returns​

DOMRenderMatch<T>

getConversionFunction()​

getConversionFunction(domNode, editor): DOMConversionFn | null

Defined in: packages/lexical-html/src/index.ts:325

Parameters​

domNode​

Node

editor​

LexicalEditor

Returns​

DOMConversionFn | null

isDomNodeBetweenTwoInlineNodes()​

isDomNodeBetweenTwoInlineNodes(node): boolean

Defined in: packages/lexical-html/src/index.ts:551

Parameters​

node​

Node

Returns​

boolean