@lexical/html

Interfaces

DOMImportConfigMatch

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

Properties

$import()

$import: (node, $next, editor) => undefined | null | DOMImportOutput

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

Parameters

node

Node

$next

DOMImportNext

editor

LexicalEditor

Returns

undefined | null | DOMImportOutput

priority?

optional priority: 0 | 1 | 2 | 3 | 4

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

selector?

optional selector: string

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

tag

tag: string & object | "#text" | "*" | "#comment" | "#cdata-section"

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

---

DOMImportExtensionOutput

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

Properties

$importNode()

$importNode: (node) => undefined | null | DOMImportOutput

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

Parameters

node

Node

Returns

undefined | null | DOMImportOutput

$importNodes()

$importNodes: (root) => LexicalNode[]

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

Parameters

root

Document | ParentNode

Returns

LexicalNode[]

---

DOMImportNext()

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

DOMImportNext(): undefined | null | DOMImportOutput

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

Returns

undefined | null | DOMImportOutput

Properties

[DOMImportNextSymbol]

readonly [DOMImportNextSymbol]: true

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

---

DOMImportOutputContinue

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

Properties

$appendChild?

optional $appendChild: undefined

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

$finalize()?

optional $finalize: (node) => null | LexicalNode | LexicalNode[]

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

Parameters

node

null | LexicalNode | LexicalNode[]

Returns

null | LexicalNode | LexicalNode[]

childContext?

optional childContext: AnyImportStateConfigPair[]

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

childNodes?

optional childNodes: undefined

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

nextContext?

optional nextContext: AnyImportStateConfigPair[]

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

node

node: DOMImportNext

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

---

DOMImportOutputNode

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

Properties

$appendChild()?

optional $appendChild: (node, dom) => void

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

Parameters

node

LexicalNode

dom

ChildNode

Returns

void

$finalize()?

optional $finalize: (node) => null | LexicalNode | LexicalNode[]

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

Parameters

node

null | LexicalNode | LexicalNode[]

Returns

null | LexicalNode | LexicalNode[]

childContext?

optional childContext: AnyImportStateConfigPair[]

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

childNodes?

optional childNodes: NodeListOf<ChildNode> | readonly ChildNode[]

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

node

node: null | LexicalNode | LexicalNode[]

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

---

DOMRenderExtensionOutput

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

Properties

defaults

defaults: undefined | ContextRecord<_K>

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

---

NodeNameMap

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

Extends

• HTMLElementTagNameMap

Properties

*

*: Node

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

#cdata-section

#cdata-section: CDATASection

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

#comment

#comment: Comment

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

#document

#document: Document

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

#text

#text: Text

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

a

a: HTMLAnchorElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38138

Inherited from

HTMLElementTagNameMap.a

abbr

abbr: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38139

Inherited from

HTMLElementTagNameMap.abbr

address

address: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38140

Inherited from

HTMLElementTagNameMap.address

area

area: HTMLAreaElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38141

Inherited from

HTMLElementTagNameMap.area

article

article: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38142

Inherited from

HTMLElementTagNameMap.article

aside

aside: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38143

Inherited from

HTMLElementTagNameMap.aside

audio

audio: HTMLAudioElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38144

Inherited from

HTMLElementTagNameMap.audio

b

b: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38145

Inherited from

HTMLElementTagNameMap.b

base

base: HTMLBaseElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38146

Inherited from

HTMLElementTagNameMap.base

bdi

bdi: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38147

Inherited from

HTMLElementTagNameMap.bdi

bdo

bdo: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38148

Inherited from

HTMLElementTagNameMap.bdo

blockquote

blockquote: HTMLQuoteElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38149

Inherited from

HTMLElementTagNameMap.blockquote

body

body: HTMLBodyElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38150

Inherited from

HTMLElementTagNameMap.body

br

br: HTMLBRElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38151

Inherited from

HTMLElementTagNameMap.br

button

button: HTMLButtonElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38152

Inherited from

HTMLElementTagNameMap.button

canvas

canvas: HTMLCanvasElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38153

Inherited from

HTMLElementTagNameMap.canvas

caption

caption: HTMLTableCaptionElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38154

Inherited from

HTMLElementTagNameMap.caption

cite

cite: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38155

Inherited from

HTMLElementTagNameMap.cite

code

code: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38156

Inherited from

HTMLElementTagNameMap.code

col

col: HTMLTableColElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38157

Inherited from

HTMLElementTagNameMap.col

colgroup

colgroup: HTMLTableColElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38158

Inherited from

HTMLElementTagNameMap.colgroup

data

data: HTMLDataElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38159

Inherited from

HTMLElementTagNameMap.data

datalist

datalist: HTMLDataListElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38160

Inherited from

HTMLElementTagNameMap.datalist

dd

dd: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38161

Inherited from

HTMLElementTagNameMap.dd

del

del: HTMLModElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38162

Inherited from

HTMLElementTagNameMap.del

details

details: HTMLDetailsElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38163

Inherited from

HTMLElementTagNameMap.details

dfn

dfn: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38164

Inherited from

HTMLElementTagNameMap.dfn

dialog

dialog: HTMLDialogElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38165

Inherited from

HTMLElementTagNameMap.dialog

div

div: HTMLDivElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38166

Inherited from

HTMLElementTagNameMap.div

dl

dl: HTMLDListElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38167

Inherited from

HTMLElementTagNameMap.dl

dt

dt: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38168

Inherited from

HTMLElementTagNameMap.dt

em

em: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38169

Inherited from

HTMLElementTagNameMap.em

embed

embed: HTMLEmbedElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38170

Inherited from

HTMLElementTagNameMap.embed

fieldset

fieldset: HTMLFieldSetElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38171

Inherited from

HTMLElementTagNameMap.fieldset

figcaption

figcaption: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38172

Inherited from

HTMLElementTagNameMap.figcaption

figure

figure: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38173

Inherited from

HTMLElementTagNameMap.figure

footer

footer: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38174

Inherited from

HTMLElementTagNameMap.footer

form

form: HTMLFormElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38175

Inherited from

HTMLElementTagNameMap.form

h1

h1: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38176

Inherited from

HTMLElementTagNameMap.h1

h2

h2: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38177

Inherited from

HTMLElementTagNameMap.h2

h3

h3: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38178

Inherited from

HTMLElementTagNameMap.h3

h4

h4: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38179

Inherited from

HTMLElementTagNameMap.h4

h5

h5: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38180

Inherited from

HTMLElementTagNameMap.h5

h6

h6: HTMLHeadingElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38181

Inherited from

HTMLElementTagNameMap.h6

head

head: HTMLHeadElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38182

Inherited from

HTMLElementTagNameMap.head

header

header: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38183

Inherited from

HTMLElementTagNameMap.header

hgroup

hgroup: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38184

Inherited from

HTMLElementTagNameMap.hgroup

hr

hr: HTMLHRElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38185

Inherited from

HTMLElementTagNameMap.hr

html

html: HTMLHtmlElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38186

Inherited from

HTMLElementTagNameMap.html

i

i: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38187

Inherited from

HTMLElementTagNameMap.i

iframe

iframe: HTMLIFrameElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38188

Inherited from

HTMLElementTagNameMap.iframe

img

img: HTMLImageElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38189

Inherited from

HTMLElementTagNameMap.img

input

input: HTMLInputElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38190

Inherited from

HTMLElementTagNameMap.input

ins

ins: HTMLModElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38191

Inherited from

HTMLElementTagNameMap.ins

kbd

kbd: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38192

Inherited from

HTMLElementTagNameMap.kbd

label

label: HTMLLabelElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38193

Inherited from

HTMLElementTagNameMap.label

legend

legend: HTMLLegendElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38194

Inherited from

HTMLElementTagNameMap.legend

li

li: HTMLLIElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38195

Inherited from

HTMLElementTagNameMap.li

link

link: HTMLLinkElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38196

Inherited from

HTMLElementTagNameMap.link

main

main: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38197

Inherited from

HTMLElementTagNameMap.main

map

map: HTMLMapElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38198

Inherited from

HTMLElementTagNameMap.map

mark

mark: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38199

Inherited from

HTMLElementTagNameMap.mark

menu

menu: HTMLMenuElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38200

Inherited from

HTMLElementTagNameMap.menu

meta

meta: HTMLMetaElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38201

Inherited from

HTMLElementTagNameMap.meta

meter

meter: HTMLMeterElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38202

Inherited from

HTMLElementTagNameMap.meter

nav

nav: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38203

Inherited from

HTMLElementTagNameMap.nav

noscript

noscript: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38204

Inherited from

HTMLElementTagNameMap.noscript

object

object: HTMLObjectElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38205

Inherited from

HTMLElementTagNameMap.object

ol

ol: HTMLOListElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38206

Inherited from

HTMLElementTagNameMap.ol

optgroup

optgroup: HTMLOptGroupElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38207

Inherited from

HTMLElementTagNameMap.optgroup

option

option: HTMLOptionElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38208

Inherited from

HTMLElementTagNameMap.option

output

output: HTMLOutputElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38209

Inherited from

HTMLElementTagNameMap.output

p

p: HTMLParagraphElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38210

Inherited from

HTMLElementTagNameMap.p

picture

picture: HTMLPictureElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38211

Inherited from

HTMLElementTagNameMap.picture

pre

pre: HTMLPreElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38212

Inherited from

HTMLElementTagNameMap.pre

progress

progress: HTMLProgressElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38213

Inherited from

HTMLElementTagNameMap.progress

q

q: HTMLQuoteElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38214

Inherited from

HTMLElementTagNameMap.q

rp

rp: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38215

Inherited from

HTMLElementTagNameMap.rp

rt

rt: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38216

Inherited from

HTMLElementTagNameMap.rt

ruby

ruby: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38217

Inherited from

HTMLElementTagNameMap.ruby

s

s: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38218

Inherited from

HTMLElementTagNameMap.s

samp

samp: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38219

Inherited from

HTMLElementTagNameMap.samp

script

script: HTMLScriptElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38220

Inherited from

HTMLElementTagNameMap.script

search

search: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38221

Inherited from

HTMLElementTagNameMap.search

section

section: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38222

Inherited from

HTMLElementTagNameMap.section

select

select: HTMLSelectElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38223

Inherited from

HTMLElementTagNameMap.select

slot

slot: HTMLSlotElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38224

Inherited from

HTMLElementTagNameMap.slot

small

small: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38225

Inherited from

HTMLElementTagNameMap.small

source

source: HTMLSourceElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38226

Inherited from

HTMLElementTagNameMap.source

span

span: HTMLSpanElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38227

Inherited from

HTMLElementTagNameMap.span

strong

strong: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38228

Inherited from

HTMLElementTagNameMap.strong

style

style: HTMLStyleElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38229

Inherited from

HTMLElementTagNameMap.style

sub

sub: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38230

Inherited from

HTMLElementTagNameMap.sub

summary

summary: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38231

Inherited from

HTMLElementTagNameMap.summary

sup

sup: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38232

Inherited from

HTMLElementTagNameMap.sup

table

table: HTMLTableElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38233

Inherited from

HTMLElementTagNameMap.table

tbody

tbody: HTMLTableSectionElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38234

Inherited from

HTMLElementTagNameMap.tbody

td

td: HTMLTableCellElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38235

Inherited from

HTMLElementTagNameMap.td

template

template: HTMLTemplateElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38236

Inherited from

HTMLElementTagNameMap.template

textarea

textarea: HTMLTextAreaElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38237

Inherited from

HTMLElementTagNameMap.textarea

tfoot

tfoot: HTMLTableSectionElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38238

Inherited from

HTMLElementTagNameMap.tfoot

th

th: HTMLTableCellElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38239

Inherited from

HTMLElementTagNameMap.th

thead

thead: HTMLTableSectionElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38240

Inherited from

HTMLElementTagNameMap.thead

time

time: HTMLTimeElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38241

Inherited from

HTMLElementTagNameMap.time

title

title: HTMLTitleElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38242

Inherited from

HTMLElementTagNameMap.title

tr

tr: HTMLTableRowElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38243

Inherited from

HTMLElementTagNameMap.tr

track

track: HTMLTrackElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38244

Inherited from

HTMLElementTagNameMap.track

u

u: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38245

Inherited from

HTMLElementTagNameMap.u

ul

ul: HTMLUListElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38246

Inherited from

HTMLElementTagNameMap.ul

var

var: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38247

Inherited from

HTMLElementTagNameMap.var

video

video: HTMLVideoElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38248

Inherited from

HTMLElementTagNameMap.video

wbr

wbr: HTMLElement

Defined in: node_modules/typescript/lib/lib.dom.d.ts:38249

Inherited from

HTMLElementTagNameMap.wbr

Type Aliases

AnyImportStateConfig

AnyImportStateConfig = ImportStateConfig<any>

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

---

AnyImportStateConfigPair

AnyImportStateConfigPair = AnyContextConfigPair<typeof DOMImportContextSymbol>

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

---

AnyRenderStateConfig

AnyRenderStateConfig = RenderStateConfig<any>

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

---

AnyRenderStateConfigPair

AnyRenderStateConfigPair = AnyContextConfigPair<typeof DOMRenderContextSymbol>

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

---

DOMImportFunction()

DOMImportFunction<T> = (node, $next, editor) => null | undefined | DOMImportOutput

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

Type Parameters

T

T extends Node

Parameters

node

T

$next

DOMImportNext

editor

LexicalEditor

Returns

null | undefined | DOMImportOutput

---

DOMTextWrapMode

DOMTextWrapMode = keyof typeof DOMTextWrapModeKeys

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

---

DOMWhiteSpaceCollapse

DOMWhiteSpaceCollapse = keyof typeof DOMWhiteSpaceCollapseKeys

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

---

NodeMatch

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

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

Type Parameters

T

T extends LexicalNode

---

NodeNameToType

NodeNameToType<T> = T extends keyof NodeNameMap ? NodeNameMap[T] : Node

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

Type Parameters

T

T extends string

Variables

$withImportContext()

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

Defined in: packages/lexical-html/src/ImportContext.ts:50

Parameters

cfg

readonly AnyContextConfigPair<typeof DOMImportContextSymbol>[]

editor?

LexicalEditor

Returns

<T>(f): T

Type Parameters

T

T

Parameters

f

() => T

Returns

T

---

$withRenderContext()

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

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

Parameters

cfg

readonly AnyContextConfigPair<typeof DOMRenderContextSymbol>[]

editor?

LexicalEditor

Returns

<T>(f): T

Type Parameters

T

T

Parameters

f

() => T

Returns

T

---

ImportContextHasBlockAncestorLexicalNode

const ImportContextHasBlockAncestorLexicalNode: ImportStateConfig<boolean>

Defined in: packages/lexical-html/src/ImportContext.ts:98

---

ImportContextParentLexicalNode

const ImportContextParentLexicalNode: ImportStateConfig<null | LexicalNode>

Defined in: packages/lexical-html/src/ImportContext.ts:94

---

ImportContextTextAlign

const ImportContextTextAlign: ImportStateConfig<undefined | ElementFormatType>

Defined in: packages/lexical-html/src/ImportContext.ts:74

---

ImportContextTextFormats

const ImportContextTextFormats: ImportStateConfig<{ bold?: boolean; capitalize?: boolean; code?: boolean; highlight?: boolean; italic?: boolean; lowercase?: boolean; strikethrough?: boolean; subscript?: boolean; superscript?: boolean; underline?: boolean; uppercase?: boolean; }>

Defined in: packages/lexical-html/src/ImportContext.ts:79

---

ImportContextWhiteSpaceCollapse

const ImportContextWhiteSpaceCollapse: ImportStateConfig<"break-spaces" | "collapse" | "discard" | "preserve" | "preserve-breaks" | "preserve-spaces">

Defined in: packages/lexical-html/src/ImportContext.ts:84

---

RenderContextExport

const RenderContextExport: RenderStateConfig<boolean>

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

true if this is an export operation ($generateHtmlFromNodes)

---

RenderContextRoot

const RenderContextRoot: RenderStateConfig<boolean>

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

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/$generateDOMFromNodes.ts:30

Type Parameters

T

T extends HTMLElement | DocumentFragment

Parameters

container

T

selection

null | BaseSelection

editor

LexicalEditor = ...

Returns

T

---

$generateDOMFromRoot()

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

Defined in: packages/lexical-html/src/$generateDOMFromNodes.ts:56

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/$generateDOMFromNodes.ts:156

Parameters

editor

LexicalEditor

selection

null | BaseSelection

Returns

string

---

$generateNodesFromDOM()

$generateNodesFromDOM(editor, dom): LexicalNode[]

Defined in: packages/lexical-html/src/$generateNodesFromDOM.ts:69

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[]

---

$getImportContextValue()

$getImportContextValue<V>(cfg, editor): V

Defined in: packages/lexical-html/src/ImportContext.ts:55

Type Parameters

V

V

Parameters

cfg

ImportStateConfig<V>

editor

LexicalEditor = ...

Returns

V

---

$getRenderContextValue()

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

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

Type Parameters

V

V

Parameters

cfg

RenderStateConfig<V>

editor

LexicalEditor = ...

Returns

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>

---

importOverride()

importOverride<T>(tag, $import, options): DOMImportConfigMatch

Defined in: packages/lexical-html/src/importOverride.ts:21

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

@NO_SIDE_EFFECTS

Type Parameters

T

T extends string

Parameters

tag

T

$import

DOMImportFunction<NodeNameToType<T>>

options

Omit<DOMImportConfigMatch, "tag" | "$import"> = {}

Returns

DOMImportConfigMatch