Class: ElementDOMSlot<T>
lexical.ElementDOMSlot
A utility class for managing the DOM children of an ElementNode
Type parameters
| Name | Type |
|---|---|
T | extends HTMLElement = HTMLElement |
Constructors
constructor
• new ElementDOMSlot<T>(element, before?, after?): ElementDOMSlot<T>
Type parameters
| Name | Type |
|---|---|
T | extends HTMLElement = HTMLElement |
Parameters
| Name | Type | Description |
|---|---|---|
element | T | The element returned by createDOM |
before? | null | Node | All managed children will be inserted before this node, if defined |
after? | null | Node | All managed children will be inserted after this node, if defined |
Returns
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:90
Properties
after
• Readonly after: null | Node
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:89
before
• Readonly before: null | Node
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:88
element
• Readonly element: T
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:87
Methods
getFirstChild
▸ getFirstChild(): null | ChildNode
Returns the first managed child of this node, which will either be this.after.nextSibling or this.element.firstChild, and will never be this.before if it is defined.
Returns
null | ChildNode
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:168
insertChild
▸ insertChild(dom): this
Insert the given child before this.before and any reconciler managed line break node, or append it if this.before is not defined
Parameters
| Name | Type |
|---|---|
dom | Node |
Returns
this
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:129
removeChild
▸ removeChild(dom): this
Remove the managed child from this container, will throw if it was not already there
Parameters
| Name | Type |
|---|---|
dom | Node |
Returns
this
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:141
replaceChild
▸ replaceChild(dom, prevDom): this
Replace managed child prevDom with dom. Will throw if prevDom is not a child
Parameters
| Name | Type | Description |
|---|---|---|
dom | Node | The new node to replace prevDom |
prevDom | Node | the node that will be replaced |
Returns
this
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:155
withAfter
▸ withAfter(after): ElementDOMSlot<T>
Return a new ElementDOMSlot where all managed children will be inserted after this node
Parameters
| Name | Type |
|---|---|
after | undefined | null | Node |
Returns
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:111
withBefore
▸ withBefore(before): ElementDOMSlot<T>
Return a new ElementDOMSlot where all managed children will be inserted before this node
Parameters
| Name | Type |
|---|---|
before | undefined | null | Node |
Returns
Defined in
packages/lexical/src/nodes/LexicalElementNode.ts:105
withElement
▸ withElement<ElementType>(element): ElementDOMSlot<ElementType>
Return a new ElementDOMSlot with an updated root element
Type parameters
| Name | Type |
|---|---|
ElementType | extends HTMLElement |
Parameters
| Name | Type |
|---|---|
element | ElementType |
Returns
ElementDOMSlot<ElementType>