Node Positions

Node Positions ( NodePos) describe the specific position of a node, its children, and its parent, providing easy navigation between them. Node Positions are heavily inspired by the DOM and are based on ProseMirror's ResolvedPos implementation.

Use Node Positions

The easiest way to create a new Node Position is by using the helper functions in the Editor instance. This way you always use the correct editor instance and have direct access to the API.

// set up your editor somewhere up here

// The NodePosition for the outermost document node
const $doc = editor.$doc

// Get all nodes of type 'heading' in the document
const $headings = editor.$nodes('heading')

// Filter by attributes
const $h1 = editor.$nodes('heading', { level: 1 })

// Pick nodes directly
const $firstHeading = editor.$node('heading', { level: 1 })

// Create a new NodePos via the $pos method when the type is unknown
const $myCustomPos = editor.$pos(30)

You can also create your own NodePos instances:

// You need to have an editor instance
// and a position you want to map to
const myNodePos = new NodePos(100, editor)

What can I do with a NodePos?

NodePos lets you traverse the document similarly to the document DOM in your browser. You can access parent nodes, child nodes, and sibling nodes.

Example: Get and update the content of a codeBlock node

// get the first codeBlock from your document
const $codeBlock = editor.$node('codeBlock')

// get the previous NodePos of your codeBlock node
const $previousItem = $codeBlock.before

// easily update the content
$previousItem.content = '<p>Updated content</p>'

If you are familiar with the DOM, this example will look familiar:

Example: Select list items and insert a new item in a bullet list

// get a bullet list from your doc
const $bulletList = editor.$node('bulletList')

// get all listItems from your bulletList
const $listItems = $bulletList.querySelectorAll('listItem')

// get the last listItem
const $lastListItem = $listItems[0]

// insert a new listItem after the last one
editor.commands.insertContentAt($lastListItem.after, '<li>New item</li>')

API

NodePos

The NodePos class is the main class you will work with. It describes a specific position of a node, its children, its parent and easy ways to navigate between them. They are heavily inspired by the DOM and are based on ProseMirror's ResolvedPos implementation.

Methods

constructor

Arguments

• pos – The position you want to map to
• editor – The editor instance you want to use

Returns NodePos

const myNodePos = new NodePos(100, editor)

closest

The closest NodePos instance of your NodePosition going up the depth. If there is no matching NodePos, it will return null.

Returns NodePos | null

const closest = myNodePos.closest('bulletList')

querySelector

The first matching NodePos instance of your NodePosition going down the depth. If there is no matching NodePos, it will return null.

You can also filter by attributes via the second attribute.

Returns NodePos | null

const firstHeading = myNodePos.querySelector('heading')
const firstH1 = myNodePos.querySelector('heading', { level: 1 })

querySelectorAll

All matching NodePos instances of your NodePosition going down the depth. If there is no matching NodePos, it will return an empty array.

You can also filter by attributes via the second attribute.

Returns Array<NodePos>

const headings = myNodePos.querySelectorAll('heading')
const h1s = myNodePos.querySelectorAll('heading', { level: 1 })

setAttribute

Set attributes on the current NodePos.

Returns NodePos

myNodePos.setAttribute({ level: 1 })

Properties

node

The ProseMirror Node at the current Node Position.

Returns Node

const node = myNodePos.node
node.type.name // 'paragraph'

element

The DOM element at the current Node Position.

Returns Element

const element = myNodePos.element
element.tagName // 'P'

content

The content of your NodePosition. You can set this to a new value to update the content of the node.

Returns string

const content = myNodePos.content
myNodePos.content = '<p>Updated content</p>'

attributes

The attributes of your NodePosition.

Returns Object

const attributes = myNodePos.attributes
attributes.level // 1

textContent

The text content of your NodePosition.

Returns string

const textContent = myNodePos.textContent

depth

The depth of your NodePosition.

Returns number

const depth = myNodePos.depth

pos

The position of your NodePosition.

Returns number

const pos = myNodePos.pos

size

The size of your NodePosition.

Returns number

const size = myNodePos.size

from

The from position of your NodePosition.

Returns number

const from = myNodePos.from

to

The to position of your NodePosition.

Returns number

const to = myNodePos.to

range

The range of your NodePosition.

Returns number

const range = myNodePos.range

parent

The parent NodePos of your NodePosition.

Returns NodePos

const parent = myNodePos.parent

before

The NodePos before your NodePosition. If there is no NodePos before, it will return null.

Returns NodePos | null

const before = myNodePos.before

after

The NodePos after your NodePosition. If there is no NodePos after, it will return null.

Returns NodePos | null

const after = myNodePos.after

children

The child NodePos instances of your NodePosition.

Returns Array<NodePos>

const children = myNodePos.children

firstChild

The first child NodePos instance of your NodePosition. If there is no child, it will return null.

Returns NodePos | null

const firstChild = myNodePos.firstChild

lastChild

The last child NodePos instance of your NodePosition. If there is no child, it will return null.

Returns NodePos | null

const lastChild = myNodePos.lastChild