Module: @lexical/html
Type Aliases
FindCachedParentDOMNode
Ƭ FindCachedParentDOMNode: (node: Node, searchFn: FindCachedParentDOMNodeSearchFn) => null | Node
Type declaration
▸ (node, searchFn): null | Node
Parameters
| Name | Type |
|---|---|
node | Node |
searchFn | FindCachedParentDOMNodeSearchFn |
Returns
null | Node
Defined in
lexical-html/src/index.ts:35
FindCachedParentDOMNodeSearchFn
Ƭ FindCachedParentDOMNodeSearchFn: (node: Node) => boolean
Type declaration
▸ (node): boolean
Parameters
| Name | Type |
|---|---|
node | Node |
Returns
boolean
Defined in
lexical-html/src/index.ts:39
Functions
$findParentDOMNode
▸ $findParentDOMNode(node, searchFn): null | Node
Parameters
| Name | Type |
|---|---|
node | Node |
searchFn | FindCachedParentDOMNodeSearchFn |
Returns
null | Node
Defined in
lexical-html/src/index.ts:41
$generateHtmlFromNodes
▸ $generateHtmlFromNodes(editor, selection?): string
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
selection? | null | RangeSelection | GridSelection | NodeSelection |
Returns
string
Defined in
lexical-html/src/index.ts:96
$generateNodesFromDOM
▸ $generateNodesFromDOM(editor, dom): LexicalNode[]
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 equivilant library and pass in the document here.
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
dom | Document |
Returns
Defined in
lexical-html/src/index.ts:75