Skip to main content

Interface: DepthNodeCaret<T, D>

lexical.DepthNodeCaret

A DepthNodeCaret points from an origin ElementNode towards its first or last child.

Type parameters​

NameType
Textends ElementNode = ElementNode
Dextends CaretDirection = CaretDirection

Hierarchy​

  • BaseNodeCaret<T, D, "depth">

    ↳ DepthNodeCaret

Properties​

direction​

• Readonly direction: D

next if pointing at the next sibling or first child, previous if pointing at the previous sibling or last child

Inherited from​

BaseNodeCaret.direction

Defined in​

packages/lexical/src/LexicalCaret.ts:38

getAdjacentCaret​

• getAdjacentCaret: () => null | BreadthNodeCaret<LexicalNode, D>

Get a new BreadthNodeCaret from getNodeAtCaret() in the same direction. This is used for traversals, but only goes in the breadth (sibling) direction.

Type declaration​

▸ (): null | BreadthNodeCaret<LexicalNode, D>

Returns​

null | BreadthNodeCaret<LexicalNode, D>

Inherited from​

BaseNodeCaret.getAdjacentCaret

Defined in​

packages/lexical/src/LexicalCaret.ts:60

getChildCaret​

• getChildCaret: () => this

Return this, the DepthNode is already a child caret of its origin

Type declaration​

▸ (): this

Returns​

this

Defined in​

packages/lexical/src/LexicalCaret.ts:178

getFlipped​

• getFlipped: () => NodeCaret<FlipDirection<D>>

Get a new NodeCaret with the head and tail of its directional arrow flipped, such that flipping twice is the identity. For example, given a non-empty parent with a firstChild and lastChild, and a second emptyParent node with no children:

Example

caret.getFlipped().getFlipped().is(caret) === true;
$getDepthCaret(parent, 'next').getFlipped().is($getBreadthCaret(firstChild, 'previous')) === true;
$getBreadthCaret(lastChild, 'next').getFlipped().is($getDepthCaret(parent, 'previous')) === true;
$getBreadthCaret(firstChild, 'next).getFlipped().is($getBreadthCaret(lastChild, 'previous')) === true;
$getDepthCaret(emptyParent, 'next').getFlipped().is($getDepthCaret(emptyParent, 'previous')) === true;

Type declaration​

▸ (): NodeCaret<FlipDirection<D>>

Returns​

NodeCaret<FlipDirection<D>>

Inherited from​

BaseNodeCaret.getFlipped

Defined in​

packages/lexical/src/LexicalCaret.ts:54

getNodeAtCaret​

• getNodeAtCaret: () => null | LexicalNode

Get the node connected to the origin in the caret's direction, or null if there is no node

Type declaration​

▸ (): null | LexicalNode

Returns​

null | LexicalNode

Inherited from​

BaseNodeCaret.getNodeAtCaret

Defined in​

packages/lexical/src/LexicalCaret.ts:58

getParentAtCaret​

• getParentAtCaret: () => T

Type declaration​

▸ (): T

Returns​

T

Overrides​

BaseNodeCaret.getParentAtCaret

Defined in​

packages/lexical/src/LexicalCaret.ts:176

getParentCaret​

• getParentCaret: (mode: RootMode) => null | BreadthNodeCaret<T, D>

Type declaration​

▸ (mode): null | BreadthNodeCaret<T, D>

Parameters​
NameType
modeRootMode
Returns​

null | BreadthNodeCaret<T, D>

Defined in​

packages/lexical/src/LexicalCaret.ts:175

insert​

• insert: (node: LexicalNode) => this

Insert a node connected to origin in this direction. For a BreadthNodeCaret this is origin.insertAfter(node) for next, or origin.insertBefore(node) for previous. For a DepthNodeCaret this is origin.splice(0, 0, [node]) for next or origin.append(node) for previous.

Type declaration​

▸ (node): this

Parameters​
NameType
nodeLexicalNode
Returns​

this

Inherited from​

BaseNodeCaret.insert

Defined in​

packages/lexical/src/LexicalCaret.ts:68

is​

• is: (other: null | NodeCaret<CaretDirection>) => boolean

Retun true if other is a caret with the same origin (by node key comparion), type, and direction

Type declaration​

▸ (other): boolean

Parameters​
NameType
othernull | NodeCaret<CaretDirection>
Returns​

boolean

Inherited from​

BaseNodeCaret.is

Defined in​

packages/lexical/src/LexicalCaret.ts:40

origin​

• Readonly origin: T

The origin node of this caret, typically this is what you will use in traversals

Inherited from​

BaseNodeCaret.origin

Defined in​

packages/lexical/src/LexicalCaret.ts:34

remove​

• remove: () => this

Remove the getNodeAtCaret() node, if it exists

Type declaration​

▸ (): this

Returns​

this

Inherited from​

BaseNodeCaret.remove

Defined in​

packages/lexical/src/LexicalCaret.ts:62

replaceOrInsert​

• replaceOrInsert: (node: LexicalNode, includeChildren?: boolean) => this

If getNodeAtCaret() is null then replace it with node, otherwise insert node

Type declaration​

▸ (node, includeChildren?): this

Parameters​
NameType
nodeLexicalNode
includeChildren?boolean
Returns​

this

Inherited from​

BaseNodeCaret.replaceOrInsert

Defined in​

packages/lexical/src/LexicalCaret.ts:70

splice​

• splice: (deleteCount: number, nodes: Iterable<LexicalNode>, nodesDirection?: CaretDirection) => this

Splice an iterable (typically an Array) of nodes into this location.

Type declaration​

▸ (deleteCount, nodes, nodesDirection?): this

Parameters​
NameTypeDescription
deleteCountnumberThe number of existing nodes to replace or delete
nodesIterable<LexicalNode>An iterable of nodes that will be inserted in this location, using replace instead of insert for the first deleteCount nodes
nodesDirection?CaretDirectionThe direction of the nodes iterable, defaults to 'next'
Returns​

this

Inherited from​

BaseNodeCaret.splice

Defined in​

packages/lexical/src/LexicalCaret.ts:78

type​

• Readonly type: "depth"

breadth for a BreadthNodeCaret (pointing at the next or previous sibling) or depth for a DepthNodeCaret (pointing at the first or last child)

Inherited from​

BaseNodeCaret.type

Defined in​

packages/lexical/src/LexicalCaret.ts:36

Methods​

[iterator]​

▸ [iterator](): Iterator<BreadthNodeCaret<LexicalNode, D>, any, undefined>

Returns​

Iterator<BreadthNodeCaret<LexicalNode, D>, any, undefined>

Inherited from​

BaseNodeCaret.[iterator]

Defined in​

node_modules/typescript/lib/lib.es2015.iterable.d.ts:49