Class EditorNode

A node in the document tree. Immutable. All "mutators" return new nodes. Text lives in the TextNode subclass.

Hierarchy (View Summary)

EditorNode
- TextNode

Index

Constructors

Properties

attrs content marks type

Accessors

childCount isAtom isBlock isInline isText isTextblock textContent

Methods

child eq toJSON withAttrs withContent withMarks

Constructors

constructor

new EditorNode(
    type: NodeType,
    attrs?: Attrs,
    content?: Fragment,
    marks?: readonly Mark[],
): EditorNode
Parameters
- type: NodeType
- attrs: Attrs = emptyAttrs
- content: Fragment = Fragment.empty
- marks: readonly Mark[] = noMarks
Returns EditorNode
- Defined in packages/core/src/model/node.ts:20

Properties

`Readonly`attrs

attrs: Attrs = emptyAttrs

`Readonly`content

content: Fragment = Fragment.empty

`Readonly`marks

marks: readonly Mark[] = noMarks

`Readonly`type

Accessors

childCount

get childCount(): number
Returns number
- Defined in packages/core/src/model/node.ts:49

isAtom

get isAtom(): boolean
True when this node has no editable content of its own (image, hr, …).

Returns boolean
- Defined in packages/core/src/model/node.ts:40

isBlock

get isBlock(): boolean
Returns boolean
- Defined in packages/core/src/model/node.ts:35

isInline

get isInline(): boolean
Returns boolean
- Defined in packages/core/src/model/node.ts:31

isText

get isText(): boolean
Returns boolean
- Defined in packages/core/src/model/node.ts:27

isTextblock

get isTextblock(): boolean
True when this node directly contains inline content (paragraph, heading, …).

Returns boolean
- Defined in packages/core/src/model/node.ts:45

textContent

get textContent(): string
Returns string
- Defined in packages/core/src/model/node.ts:57

Methods

child

child(index: number): EditorNode
Parameters
- index: number
Returns EditorNode
- Defined in packages/core/src/model/node.ts:53

eq

eq(other: EditorNode): boolean
Parameters
- other: EditorNode
Returns boolean
- Defined in packages/core/src/model/node.ts:77

toJSON

toJSON(): NodeJSON
Returns NodeJSON
- Defined in packages/core/src/model/node.ts:87

withAttrs

withAttrs(attrs: Attrs): EditorNode
Parameters
- attrs: Attrs
Returns EditorNode
- Defined in packages/core/src/model/node.ts:69

withContent

withContent(content: Fragment): EditorNode
Parameters
- content: Fragment
Returns EditorNode
- Defined in packages/core/src/model/node.ts:65

withMarks

withMarks(marks: readonly Mark[]): EditorNode
Parameters
- marks: readonly Mark[]
Returns EditorNode
- Defined in packages/core/src/model/node.ts:73