Class: ParagraphNode
lexical.ParagraphNode
Hierarchy
-
↳
ParagraphNode
Constructors
constructor
• new ParagraphNode(key?): ParagraphNode
Parameters
| Name | Type |
|---|---|
key? | string |
Returns
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:52
Properties
__textStyle
• __textStyle: string
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:50
constructor
• constructor: KlassConstructor<typeof ParagraphNode>
Overrides
ElementNode.constructor
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:47
Methods
afterCloneFrom
▸ afterCloneFrom(prevNode): void
Perform any state updates on the clone of prevNode that are not already
handled by the constructor call in the static clone method. If you have
state to update in your clone that is not handled directly by the
constructor, it is advisable to override this method but it is required
to include a call to super.afterCloneFrom(prevNode) in your
implementation. This is only intended to be called by
$cloneWithProperties function or via a super call.
Parameters
| Name | Type |
|---|---|
prevNode | this |
Returns
void
Example
class ClassesTextNode extends TextNode {
// Not shown: static getType, static importJSON, exportJSON, createDOM, updateDOM
__classes = new Set<string>();
static clone(node: ClassesTextNode): ClassesTextNode {
// The inherited TextNode constructor is used here, so
// classes is not set by this method.
return new ClassesTextNode(node.__text, node.__key);
}
afterCloneFrom(node: this): void {
// This calls TextNode.afterCloneFrom and LexicalNode.afterCloneFrom
// for necessary state updates
super.afterCloneFrom(node);
this.__addClasses(node.__classes);
}
// This method is a private implementation detail, it is not
// suitable for the public API because it does not call getWritable
__addClasses(classNames: Iterable<string>): this {
for (const className of classNames) {
this.__classes.add(className);
}
return this;
}
addClass(...classNames: string[]): this {
return this.getWritable().__addClasses(classNames);
}
removeClass(...classNames: string[]): this {
const node = this.getWritable();
for (const className of classNames) {
this.__classes.delete(className);
}
return this;
}
getClasses(): Set<string> {
return this.getLatest().__classes;
}
}
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:93
collapseAtStart
▸ collapseAtStart(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:191
createDOM
▸ createDOM(config): HTMLElement
Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.
This method must return exactly one HTMLElement. Nested elements are not supported.
Do not attempt to update the Lexical EditorState during this phase of the update lifecyle.
Parameters
| Name | Type | Description |
|---|---|---|
config | EditorConfig | allows access to things like the EditorTheme (to apply classes) during reconciliation. |
Returns
HTMLElement
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:101
exportDOM
▸ exportDOM(editor): DOMExportOutput
Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:127
exportJSON
▸ exportJSON(): SerializedParagraphNode
Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.
Returns
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:164
getTextFormat
▸ getTextFormat(): number
Returns
number
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:62
getTextStyle
▸ getTextStyle(): string
Returns
string
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:78
hasTextFormat
▸ hasTextFormat(type): boolean
Parameters
| Name | Type |
|---|---|
type | TextFormatType |
Returns
boolean
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:73
insertNewAfter
▸ insertNewAfter(rangeSelection, restoreSelection): ParagraphNode
Parameters
| Name | Type |
|---|---|
rangeSelection | RangeSelection |
restoreSelection | boolean |
Returns
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:176
setTextFormat
▸ setTextFormat(type): this
Parameters
| Name | Type |
|---|---|
type | number |
Returns
this
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:67
setTextStyle
▸ setTextStyle(style): this
Parameters
| Name | Type |
|---|---|
style | string |
Returns
this
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:83
updateDOM
▸ updateDOM(prevNode, dom, config): boolean
Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.
Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.
Parameters
| Name | Type |
|---|---|
prevNode | ParagraphNode |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:110
clone
▸ clone(node): ParagraphNode
Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.
Parameters
| Name | Type |
|---|---|
node | ParagraphNode |
Returns
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:89
getType
▸ getType(): string
Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.
Returns
string
Overrides
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:58
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical/src/nodes/LexicalParagraphNode.ts:118
importJSON
▸ importJSON(serializedNode): ParagraphNode
Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.
Parameters
| Name | Type |
|---|---|
serializedNode | SerializedParagraphNode |