Type Editor

---

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

Class: ViewDesc

Defined in: ViewDesc.ts:22

Superclass for the various kinds of descriptions. Defines their basic structure and shared methods.

Extends

• AbstractViewDesc

Extended by

• CompositionViewDesc
• MarkViewDesc
• NodeViewDesc
• TrailingHackViewDesc
• WidgetViewDesc

Implements

• PmViewDesc

Constructors

Constructor

new ViewDesc(
   parent,
   children,
   dom,
   contentDOM): ViewDesc;

Defined in: ViewDesc.ts:39

Creates a new ViewDesc instance.

Parameters

Parameter	Type	Description
parent	ViewDesc	The parent ViewDesc in the tree hierarchy
children	ViewDesc[]	Array of child ViewDesc instances
dom	Node	The DOM node this description wraps
contentDOM	HTMLElement	The DOM node that holds the child views. May be null for descs that don't have children.

Returns

ViewDesc

Overrides

AbstractViewDesc.constructor

Properties

Property	Modifier	Type	Default value	Defined in
_children	protected	ViewDesc[]	undefined	ViewDesc.ts:28
_contentDOM	readonly	HTMLElement	undefined	ViewDesc.ts:24
_dirty	protected	ViewDirtyState	ViewDirtyState.NOT_DIRTY	ViewDesc.ts:25
_dom	protected	Node	undefined	ViewDesc.ts:29
_node	protected	Node_2	undefined	ViewDesc.ts:26
_parent	protected	ViewDesc	undefined	ViewDesc.ts:27

Accessors

border

Get Signature

get border(): number;

Defined in: ViewDesc.ts:181

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

Returns

number

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.children;

---

contentDOM

Get Signature

get contentDOM(): HTMLElement;

Defined in: ViewDesc.ts:106

The DOM node that contains child content, if any.

Returns

HTMLElement

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.dirty;

---

dom

Get Signature

get dom(): Node;

Defined in: ViewDesc.ts:99

The DOM node this description represents.

Returns

Node

Implementation of

PmViewDesc.dom;

---

domAtom

Get Signature

get domAtom(): boolean;

Defined in: ViewDesc.ts:113

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

Returns

boolean

Implementation of

PmViewDesc.domAtom;

---

ignoreForCoords

Get Signature

get ignoreForCoords(): boolean;

Defined in: ViewDesc.ts:120

Whether this view should be ignored when determining coordinates.

Returns

boolean

Implementation of

PmViewDesc.ignoreForCoords;

---

ignoreForSelection

Get Signature

get ignoreForSelection(): boolean;

Defined in: ViewDesc.ts:127

Whether this view should be ignored for selection purposes.

Returns

boolean

Implementation of

PmViewDesc.ignoreForSelection;

---

node

Get Signature

get node(): Node_2;

Defined in: ViewDesc.ts:70

The ProseMirror node this description represents, if any.

Returns

Node_2

Implementation of

PmViewDesc.node;

---

nodeDOM

Get Signature

get nodeDOM(): Node;

Defined in: AbstractViewDesc.ts:22

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

Returns

Node

The node DOM element, or null if this view doesn't have a direct node representation

Implementation of

PmViewDesc.nodeDOM;

Inherited from

AbstractViewDesc.nodeDOM

---

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

Implementation of

PmViewDesc.parent;

---

posAfter

Get Signature

get posAfter(): number;

Defined in: ViewDesc.ts:155

The document position just after this view.

Returns

number

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.posAtStart;

---

posBefore

Get Signature

get posBefore(): number;

Defined in: ViewDesc.ts:141

The document position just before this view.

Returns

number

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.side;

Overrides

AbstractViewDesc.side

---

size

Get Signature

get size(): number;

Defined in: ViewDesc.ts:169

The size of the content represented by this desc.

Returns

number

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.descAt;

---

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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.domAfterPos;

---

domFromPos()

domFromPos(pos, side): {
  atom?: number;
  node: Node;
  offset: number;
};

Defined in: ViewDesc.ts:408

Converts a document position to a DOM position.

The algorithm:

1. For leaf nodes: return the DOM node itself with atom marker
2. For container nodes: find which child contains the position
3. If inside a child: recurse into that child
4. If at boundary: adjust for zero-width widgets and find DOM position

Parameters

Parameter	Type	Description
pos	number	The document position (relative to this view's start)
side	number	Direction to favor (-1 for before, 0 for neutral, 1 for after)

Returns

{
  atom?: number;
  node: Node;
  offset: number;
}

Object containing the DOM node, offset, and optionally an atom marker

Name	Type	Defined in
atom?	number	ViewDesc.ts:409
node	Node	ViewDesc.ts:409
offset	number	ViewDesc.ts:409

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.getDesc;

---

getType()

getType(): ViewDescType;

Defined in: ViewDesc.ts:189

Returns

ViewDescType

Implementation of

PmViewDesc.getType;

---

ignoreMutation()

ignoreMutation(mutation): boolean;

Defined in: ViewDesc.ts:509

Determines if a mutation can be safely ignored.

Parameters

Parameter	Type	Description
mutation	ViewMutationRecord	The mutation record to check

Returns

boolean

True if the mutation can be ignored, false if it needs processing

Implementation of

PmViewDesc.ignoreMutation;

---

isText()

isText(_text): boolean;

Defined in: ViewDesc.ts:549

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

Implementation of

PmViewDesc.isText;

---

localPosFromDOM()

localPosFromDOM(
   dom,
   offset,
   bias): number;

Defined in: ViewDesc.ts:316

Converts a DOM position within this view to a document position.

Uses two strategies:

1. If position is inside contentDOM: scans through children to find nearest view desc
2. If position is outside contentDOM: uses heuristics based on DOM structure

Parameters

Parameter	Type	Description
dom	Node	The DOM node where the position is
offset	number	The offset within the DOM node
bias	number	Direction bias for ambiguous positions (-1 for before, 1 for after)

Returns

number

The document position corresponding to the DOM position

Implementation of

PmViewDesc.localPosFromDOM;

---

markDirty()

markDirty(from, to): void;

Defined in: ViewDesc.ts:524

Marks a subtree that has been touched by a DOM change for redrawing.

The algorithm walks through children to find which ones overlap with the dirty range, then either:

• Recursively marks the child if range is fully contained
• Marks the child for full recreation if range partially overlaps

Parameters

Parameter	Type	Description
from	number	Start position of the dirty range
to	number	End position of the dirty range

Returns

void

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.matchesMark;

---

matchesNode()

matchesNode(
   _node,
   _outerDeco,
   _innerDeco): boolean;

Defined in: ViewDesc.ts:226

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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.parseRange;

---

parseRule()

parseRule(): Omit<TagParseRule, "tag">;

Defined in: ViewDesc.ts:245

When parsing in-editor content (in domchange.js), we allow descriptions to determine the parse rules that should be used to parse them.

Returns

Omit<TagParseRule, "tag">

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.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

Implementation of

PmViewDesc.posFromDOM;

---

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

---

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:

1. If selection is entirely within a child → delegate to that child
2. 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

Implementation of

PmViewDesc.setSelection;

---

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

Implementation of

PmViewDesc.stopEvent;