Type Editor / @type-editor/viewdesc / TextViewDesc / TextViewDesc

Class: TextViewDesc

View description for text nodes. Text nodes are leaf nodes that contain only text content and no children. They can be wrapped by mark decorations but don't have their own content DOM.

Extends

NodeViewDesc

Constructors

Constructor

new TextViewDesc(
   parent,
   node,
   outerDeco,
   innerDeco,
   dom,
   nodeDOM): TextViewDesc;

Defined in: TextViewDesc.ts:29

Creates a new TextViewDesc.

Parameters

Parameter	Type	Description
`parent`	`ViewDesc`	The parent view description
`node`	`Node_2`	The text node
`outerDeco`	readonly `PmDecoration`[]	Outer decorations (typically marks)
`innerDeco`	`DecorationSource`	Inner decorations (unused for text nodes)
`dom`	`Node`	The outer DOM node (may include mark wrappers)
`nodeDOM`	`Node`	The actual text DOM node

Returns

TextViewDesc

Overrides

NodeViewDesc.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_children`	`protected`	`ViewDesc`[]	`undefined`	`NodeViewDesc`.`_children`	ViewDesc.ts:28
`_contentDOM`	`readonly`	`HTMLElement`	`undefined`	`NodeViewDesc`.`_contentDOM`	ViewDesc.ts:24
`_dirty`	`protected`	`ViewDirtyState`	`ViewDirtyState.NOT_DIRTY`	`NodeViewDesc`.`_dirty`	ViewDesc.ts:25
`_dom`	`protected`	`Node`	`undefined`	`NodeViewDesc`.`_dom`	ViewDesc.ts:29
`_innerDeco`	`protected`	`DecorationSource`	`null`	`NodeViewDesc`.`_innerDeco`	NodeViewDesc.ts:22
`_node`	`protected`	`Node_2`	`undefined`	`NodeViewDesc`.`_node`	ViewDesc.ts:26
`_nodeDOM`	`readonly`	`Node`	`undefined`	`NodeViewDesc`.`_nodeDOM`	NodeViewDesc.ts:20
`_outerDeco`	`protected`	readonly `PmDecoration`[]	`null`	`NodeViewDesc`.`_outerDeco`	NodeViewDesc.ts:21
`_parent`	`protected`	`ViewDesc`	`undefined`	`NodeViewDesc`.`_parent`	ViewDesc.ts:27

Accessors

border

Get Signature

get border(): number;

Defined in: NodeViewDesc.ts:77

For block nodes, this represents the space taken up by their start/end tokens.

Returns

number

Inherited from

NodeViewDesc.border

children

Get Signature

get children(): ViewDesc[];

Defined in: ViewDesc.ts:88

The child view descriptions of this view.

Returns

ViewDesc[]

Set Signature

set children(children): void;

Defined in: ViewDesc.ts:92

Parameters

Parameter	Type
`children`	`ViewDesc`[]

Returns

void

Inherited from

WidgetViewDesc.children

contentDOM

Get Signature

get contentDOM(): HTMLElement;

Defined in: ViewDesc.ts:106

The DOM node that contains child content, if any.

Returns

HTMLElement

Inherited from

NodeViewDesc.contentDOM

contentLost

Get Signature

get contentLost(): boolean;

Defined in: ViewDesc.ts:134

Checks if the content DOM has been detached from the main DOM.

Returns

boolean

Inherited from

NodeViewDesc.contentLost

dirty

Get Signature

get dirty(): ViewDirtyState;

Defined in: ViewDesc.ts:59

The dirty state of this description. Can be NOT_DIRTY, CHILD_DIRTY, CONTENT_DIRTY, or NODE_DIRTY.

Returns

ViewDirtyState

Set Signature

set dirty(dirty): void;

Defined in: ViewDesc.ts:63

Parameters

Parameter	Type
`dirty`	`ViewDirtyState`

Returns

void

Inherited from

NodeViewDesc.dirty

dom

Get Signature

get dom(): Node;

Defined in: ViewDesc.ts:99

The DOM node this description represents.

Returns

Node

Inherited from

NodeViewDesc.dom

domAtom

Get Signature

get domAtom(): boolean;

Defined in: TextViewDesc.ts:38

Whether this description represents an atomic node that should be treated as a single unit.

Returns

boolean

Overrides

NodeViewDesc.domAtom

ignoreForCoords

Get Signature

get ignoreForCoords(): boolean;

Defined in: ViewDesc.ts:120

Whether this view should be ignored when determining coordinates.

Returns

boolean

Inherited from

NodeViewDesc.ignoreForCoords

ignoreForSelection

Get Signature

get ignoreForSelection(): boolean;

Defined in: ViewDesc.ts:127

Whether this view should be ignored for selection purposes.

Returns

boolean

Inherited from

NodeViewDesc.ignoreForSelection

innerDeco

Get Signature

get innerDeco(): DecorationSource;

Defined in: NodeViewDesc.ts:61

The decoration source for decorations inside this node. Provides access to decorations that should be applied to child content.

Returns

DecorationSource

Inherited from

NodeViewDesc.innerDeco

node

Get Signature

get node(): Node_2;

Defined in: ViewDesc.ts:70

The ProseMirror node this description represents, if any.

Returns

Node_2

Inherited from

NodeViewDesc.node

nodeDOM

Get Signature

get nodeDOM(): Node;

Defined in: NodeViewDesc.ts:69

The DOM node that directly represents this ProseMirror node. May differ from dom if outer decorations wrap it.

Returns

Node

Inherited from

NodeViewDesc.nodeDOM

outerDeco

Get Signature

get outerDeco(): readonly PmDecoration[];

Defined in: NodeViewDesc.ts:53

The decorations that wrap this node from the outside. These might add attributes, classes, or wrapper elements around the node.

Returns

readonly PmDecoration[]

Inherited from

NodeViewDesc.outerDeco

parent

Get Signature

get parent(): ViewDesc;

Defined in: ViewDesc.ts:77

The parent view description in the tree.

Returns

ViewDesc

Set Signature

set parent(parent): void;

Defined in: ViewDesc.ts:81

Parameters

Parameter	Type
`parent`	`ViewDesc`

Returns

void

Inherited from

WidgetViewDesc.parent

posAfter

Get Signature

get posAfter(): number;

Defined in: ViewDesc.ts:155

The document position just after this view.

Returns

number

Inherited from

NodeViewDesc.posAfter

posAtEnd

Get Signature

get posAtEnd(): number;

Defined in: ViewDesc.ts:162

The document position at the end of this view's content.

Returns

number

Inherited from

NodeViewDesc.posAtEnd

posAtStart

Get Signature

get posAtStart(): number;

Defined in: ViewDesc.ts:148

The document position at the start of this view's content.

Returns

number

Inherited from

NodeViewDesc.posAtStart

posBefore

Get Signature

get posBefore(): number;

Defined in: ViewDesc.ts:141

The document position just before this view.

Returns

number

Inherited from

NodeViewDesc.posBefore

side

Get Signature

get side(): number;

Defined in: ViewDesc.ts:185

Gets the side value which determines positioning behavior of the view.

Negative values: positioned before content
Zero: neutral positioning
Positive values: positioned after content

Returns

number

Inherited from

NodeViewDesc.side

size

Get Signature

get size(): number;

Defined in: NodeViewDesc.ts:73

The size of the content represented by this desc.

Returns

number

Inherited from

NodeViewDesc.size

Methods

descAt()

descAt(pos): ViewDesc;

Defined in: ViewDesc.ts:371

Find the desc for the node after the given pos, if any. (When a parent node overrode rendering, there might not be one.)

Parameters

Parameter	Type	Description
`pos`	`number`	The document position to search for

Returns

ViewDesc

The view description at that position, or undefined

Inherited from

NodeViewDesc.descAt

deselectNode()

deselectNode(): void;

Defined in: NodeViewDesc.ts:499

Remove selected node marking from this node.

Returns

void

Inherited from

NodeViewDesc.deselectNode

destroy()

destroy(): void;

Defined in: ViewDesc.ts:265

Destroys this view description and all its children, cleaning up references.

This method ensures proper cleanup even if exceptions occur during child destruction.

Returns

void

Inherited from

NodeViewDesc.destroy

domAfterPos()

domAfterPos(pos): Node;

Defined in: ViewDesc.ts:468

Gets the DOM node immediately after a given document position.

Parameters

Parameter	Type	Description
`pos`	`number`	The document position

Returns

Node

The DOM node after the position

Throws

RangeError if there's no node after the position

Inherited from

NodeViewDesc.domAfterPos

domFromPos()

domFromPos(pos): {
  node: Node;
  offset: number;
};

Defined in: TextViewDesc.ts:114

Converts a document position to a DOM position within the text node.

Parameters

Parameter	Type	Description
`pos`	`number`	The position offset within this text node

Returns

{
  node: Node;
  offset: number;
}

The text DOM node and offset

Name	Type	Defined in
`node`	`Node`	TextViewDesc.ts:114
`offset`	`number`	TextViewDesc.ts:114

Overrides

NodeViewDesc.domFromPos

emptyChildAt()

emptyChildAt(side): boolean;

Defined in: ViewDesc.ts:452

Checks if there's an empty child at the start or end of this view.

Parameters

Parameter	Type	Description
`side`	`number`	Direction to check (-1 for start, 1 for end)

Returns

boolean

True if there's an empty child at the specified side

Inherited from

NodeViewDesc.emptyChildAt

getDesc()

getDesc(dom): ViewDesc;

Defined in: ViewDesc.ts:333

Gets a view description from a DOM node if it's a descendant of this description.

Parameters

Parameter	Type	Description
`dom`	`Node`	The DOM node to check

Returns

ViewDesc

The view description if it's a descendant, undefined otherwise

Inherited from

NodeViewDesc.getDesc

getType()

getType(): ViewDescType;

Defined in: TextViewDesc.ts:175

Returns

ViewDescType

Overrides

NodeViewDesc.getType

ignoreMutation()

ignoreMutation(mutation): boolean;

Defined in: TextViewDesc.ts:139

Text nodes only care about character data and selection changes.

Parameters

Parameter	Type	Description
`mutation`	`ViewMutationRecord`	The mutation to check

Returns

boolean

True if mutation should be ignored

Overrides

NodeViewDesc.ignoreMutation

inParent()

inParent(): boolean;

Defined in: TextViewDesc.ts:99

Checks if this text node is still in its parent's content DOM.

Returns

boolean

True if the text node is properly attached

isText()

isText(text): boolean;

Defined in: TextViewDesc.ts:171

Checks if this view represents text with a specific content.

Parameters

Parameter	Type	Description
`text`	`string`	The text content to check against

Returns

boolean

True if this is a text view with the given content

Overrides

NodeViewDesc.isText

localPosFromDOM()

localPosFromDOM(
   dom,
   offset,
   bias): number;

Defined in: TextViewDesc.ts:126

Converts a DOM position to a document position within the text node.

Parameters

Parameter	Type	Description
`dom`	`Node`	The DOM node
`offset`	`number`	The offset within the DOM node
`bias`	`number`	Direction bias (unused for text nodes)

Returns

number

The document position

Overrides

NodeViewDesc.localPosFromDOM

markDirty()

markDirty(from, to): void;

Defined in: TextViewDesc.ts:163

Marks a range as dirty. If the entire text or boundaries are affected, marks for full node recreation.

Parameters

Parameter	Type	Description
`from`	`number`	Start position
`to`	`number`	End position

Returns

void

Overrides

NodeViewDesc.markDirty

markParentsDirty()

markParentsDirty(): void;

Defined in: ViewDesc.ts:557

Marks this description and its parents as dirty, propagating the dirty state up the tree. Sets the dirty level to CONTENT_DIRTY for the immediate parent and CHILD_DIRTY for ancestors.

Returns

void

Inherited from

NodeViewDesc.markParentsDirty

matchesHack()

matchesHack(_nodeName): boolean;

Defined in: ViewDesc.ts:236

Checks if this description matches a hack node with a specific name.

Parameters

Parameter	Type	Description
`_nodeName`	`string`	The node name to check against

Returns

boolean

True if this is a hack node with the given name

Inherited from

NodeViewDesc.matchesHack

matchesMark()

matchesMark(_mark): boolean;

Defined in: ViewDesc.ts:214

Checks if this description matches a given mark.

Parameters

Parameter	Type	Description
`_mark`	`Mark`	The mark to check against

Returns

boolean

True if this description represents the given mark

Inherited from

NodeViewDesc.matchesMark

matchesNode()

matchesNode(
   node,
   outerDeco,
   innerDeco): boolean;

Defined in: NodeViewDesc.ts:434

Checks if this description matches a given node with decorations.

Parameters

Parameter	Type	Description
`node`	`Node_2`	The node to check against
`outerDeco`	readonly `PmDecoration`[]	The outer decorations to check
`innerDeco`	`DecorationSource`	The inner decoration source to check

Returns

boolean

True if this description represents the given node with matching decorations

Inherited from

NodeViewDesc.matchesNode

matchesWidget()

matchesWidget(_widget): boolean;

Defined in: ViewDesc.ts:199

Checks if this description matches a given widget decoration.

Parameters

Parameter	Type	Description
`_widget`	`PmDecoration`	The widget decoration to check against

Returns

boolean

True if this description represents the given widget

Inherited from

NodeViewDesc.matchesWidget

parseRange()

parseRange(
   from,
   to,
   base?): {
  from: number;
  fromOffset: number;
  node: Node;
  to: number;
  toOffset: number;
};

Defined in: ViewDesc.ts:435

Finds a DOM range in a single parent for a given changed range.

This method maps document positions to DOM child indices, which is needed for parsing changed content. It tries to optimize by recursing into a single child when the entire range fits inside it.

Parameters

Parameter	Type	Default value	Description
`from`	`number`	`undefined`	Start position of the range
`to`	`number`	`undefined`	End position of the range
`base`	`number`	`0`	Base offset for position calculations (default: 0)

Returns

{
  from: number;
  fromOffset: number;
  node: Node;
  to: number;
  toOffset: number;
}

Object containing the DOM node and offsets for the range

Name	Type	Defined in
`from`	`number`	ViewDesc.ts:437
`fromOffset`	`number`	ViewDesc.ts:437
`node`	`Node`	ViewDesc.ts:437
`to`	`number`	ViewDesc.ts:437
`toOffset`	`number`	ViewDesc.ts:437

Inherited from

NodeViewDesc.parseRange

parseRule()

parseRule(): {
  skip: boolean | ParentNode;
};

Defined in: TextViewDesc.ts:47

Returns a parse rule that skips any decoration wrappers around the text node.

Returns

{
  skip: boolean | ParentNode;
}

Parse rule with skip set to the first non-decoration parent

Name	Type	Defined in
`skip`	`boolean` \| `ParentNode`	TextViewDesc.ts:47

Overrides

NodeViewDesc.parseRule

posBeforeChild()

posBeforeChild(child): number;

Defined in: ViewDesc.ts:293

Calculates the document position just before a given child view.

Parameters

Parameter	Type	Description
`child`	`PmViewDesc`	The child view to locate

Returns

number

The document position before the child

Inherited from

NodeViewDesc.posBeforeChild

posFromDOM()

posFromDOM(
   dom,
   offset,
   bias): number;

Defined in: ViewDesc.ts:354

Converts a DOM position to a document position.

Parameters

Parameter	Type	Description
`dom`	`Node`	The DOM node containing the position
`offset`	`number`	The offset within the DOM node
`bias`	`number`	Direction bias for ambiguous positions

Returns

number

The document position, or -1 if not found

Inherited from

NodeViewDesc.posFromDOM

selectNode()

selectNode(): void;

Defined in: NodeViewDesc.ts:487

Mark this node as being the selected node.

Returns

void

Inherited from

NodeViewDesc.selectNode

setDomNode()

protected setDomNode(dom): void;

Defined in: ViewDesc.ts:575

Sets the DOM node for this description and establishes the bidirectional link.

Parameters

Parameter	Type	Description
`dom`	`Node`	The DOM node to associate with this description

Returns

void

Inherited from

NodeViewDesc.setDomNode

setSelection()

setSelection(
   anchor,
   head,
   view,
   force?): void;

Defined in: ViewDesc.ts:492

Sets a selection within this view description or delegates to a child.

View descs are responsible for setting selections that fall entirely inside them, allowing custom node views to implement specialized selection behavior.

Strategy:

If selection is entirely within a child → delegate to that child
Otherwise → convert positions to DOM and apply selection

Parameters

Parameter	Type	Default value	Description
`anchor`	`number`	`undefined`	The anchor position of the selection
`head`	`number`	`undefined`	The head position of the selection
`view`	`PmEditorView`	`undefined`	The editor view
`force`	`boolean`	`false`	Whether to force the selection update even if it appears unchanged

Returns

void

Inherited from

NodeViewDesc.setSelection

slice()

slice(from, to): TextViewDesc;

Defined in: TextViewDesc.ts:150

Creates a sliced copy of this text node.

Parameters

Parameter	Type	Description
`from`	`number`	Start position of the slice
`to`	`number`	End position of the slice

Returns

TextViewDesc

A new TextViewDesc with sliced content

stopEvent()

stopEvent(_event): boolean;

Defined in: ViewDesc.ts:256

Used by the editor's event handler to ignore events that come from certain descs.

Parameters

Parameter	Type	Description
`_event`	`Event`	The DOM event to check

Returns

boolean

True if the event should be stopped/ignored

Inherited from

NodeViewDesc.stopEvent

update()

update(
   node,
   outerDeco,
   _innerDeco,
   view): boolean;

Defined in: TextViewDesc.ts:68

Updates this text node with new content and decorations.

Parameters

Parameter	Type	Description
`node`	`Node_2`	The new text node
`outerDeco`	readonly `PmDecoration`[]	New outer decorations
`_innerDeco`	`DecorationSource`	Inner decorations (unused for text)
`view`	`PmEditorView`	The editor view

Returns

boolean

True if update succeeded, false if node needs recreation

updateInner()

updateInner(
   node,
   outerDeco,
   innerDeco): void;

Defined in: NodeViewDesc.ts:450

Updates the internal state of this node view with new node and decorations.

Parameters

Parameter	Type	Description
`node`	`Node_2`	The new node
`outerDeco`	readonly `PmDecoration`[]	New outer decorations
`innerDeco`	`DecorationSource`	New inner decorations

Returns

void

Inherited from

NodeViewDesc.updateInner

updateOuterDeco()

updateOuterDeco(outerDeco): void;

Defined in: NodeViewDesc.ts:463

Updates the outer decorations on this node, patching the DOM as needed.

Parameters

Parameter	Type	Description
`outerDeco`	readonly `PmDecoration`[]	The new array of outer decorations

Returns

void

Inherited from

NodeViewDesc.updateOuterDeco

applyOuterDeco()

static applyOuterDeco(
   dom,
   deco,
   node): Node;

Defined in: NodeViewDesc.ts:93

Apply outer decorations to a DOM node.

Parameters

Parameter	Type	Description
`dom`	`Node`	The DOM node to decorate
`deco`	readonly `PmDecoration`[]	Array of decorations to apply
`node`	`Node_2`	The ProseMirror node

Returns

Node

The decorated DOM node

Inherited from

NodeViewDesc.applyOuterDeco

Class: TextViewDesc ​

Extends ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Overrides ​

Properties ​

Accessors ​

border ​

Get Signature ​

Returns ​

Inherited from ​

children ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

Returns ​

Inherited from ​

contentDOM ​

Get Signature ​

Returns ​

Inherited from ​

contentLost ​

Get Signature ​

Returns ​

Inherited from ​

dirty ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

Returns ​

Inherited from ​

dom ​

Get Signature ​

Returns ​

Inherited from ​

domAtom ​

Get Signature ​

Returns ​

Overrides ​

ignoreForCoords ​

Get Signature ​

Returns ​

Inherited from ​

ignoreForSelection ​

Get Signature ​

Returns ​

Inherited from ​

innerDeco ​

Get Signature ​

Returns ​

Inherited from ​

node ​

Get Signature ​

Returns ​

Inherited from ​

nodeDOM ​

Get Signature ​

Returns ​

Inherited from ​

outerDeco ​

Get Signature ​

Returns ​

Inherited from ​

parent ​

Get Signature ​

Returns ​

Set Signature ​

Parameters ​

Returns ​

Inherited from ​

posAfter ​

Get Signature ​

Returns ​

Inherited from ​

posAtEnd ​

Get Signature ​

Class: TextViewDesc

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

border

Get Signature

Returns

Inherited from

children

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

contentDOM

Get Signature

Returns

Inherited from

contentLost

Get Signature

Returns

Inherited from

dirty

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

dom

Get Signature

Returns

Inherited from

domAtom

Get Signature

Returns

Overrides

ignoreForCoords

Get Signature

Returns

Inherited from

ignoreForSelection

Get Signature

Returns

Inherited from

innerDeco

Get Signature

Returns

Inherited from

node

Get Signature

Returns

Inherited from

nodeDOM

Get Signature

Returns

Inherited from

outerDeco

Get Signature

Returns

Inherited from

parent

Get Signature

Returns

Set Signature

Parameters

Returns

Inherited from

posAfter

Get Signature

Returns

Inherited from

posAtEnd

Get Signature