Utils library for ProseMirror

Quick Start

Install prosemirror-utils package from npm:

npm install prosemirror-utils

Public API documentation

Utils for working with `selection`

findParentNode(predicate: fn(node: ProseMirrorNode) → boolean) → fn(selection: Selection) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes, returning the closest node and its start position predicate returns truthy for. start points to the start position of the node, pos points directly before the node.
```
const predicate = node => node.type === schema.nodes.blockquote;
const parent = findParentNode(predicate)(selection);
```
findParentNodeClosestToPos($pos: ResolvedPos, predicate: fn(node: ProseMirrorNode) → boolean) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes starting from the given $pos, returning the closest node and its start position predicate returns truthy for. start points to the start position of the node, pos points directly before the node.
```
const predicate = node => node.type === schema.nodes.blockquote;
const parent = findParentNodeClosestToPos(state.doc.resolve(5), predicate);
```
findParentDomRef(predicate: fn(node: ProseMirrorNode) → boolean, domAtPos: fn(pos: number) → {node: dom.Node, offset: number}) → fn(selection: Selection) → ?dom.Node
Iterates over parent nodes, returning DOM reference of the closest node predicate returns truthy for.
```
const domAtPos = view.domAtPos.bind(view);
const predicate = node => node.type === schema.nodes.table;
const parent = findParentDomRef(predicate, domAtPos)(selection); // <table>
```
hasParentNode(predicate: fn(node: ProseMirrorNode) → boolean) → fn(selection: Selection) → boolean
Checks if there's a parent node predicate returns truthy for.
```
if (hasParentNode(node => node.type === schema.nodes.table)(selection)) {
  // ....
}
```
findParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes, returning closest node of a given nodeType. start points to the start position of the node, pos points directly before the node.
```
const parent = findParentNodeOfType(schema.nodes.paragraph)(selection);
```
findParentNodeOfTypeClosestToPos($pos: ResolvedPos, nodeType: NodeType | [NodeType]) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes starting from the given $pos, returning closest node of a given nodeType. start points to the start position of the node, pos points directly before the node.
```
const parent = findParentNodeOfTypeClosestToPos(state.doc.resolve(10), schema.nodes.paragraph);
```
hasParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → boolean
Checks if there's a parent node of a given nodeType.
```
if (hasParentNodeOfType(schema.nodes.table)(selection)) {
  // ....
}
```
findParentDomRefOfType(nodeType: NodeType | [NodeType], domAtPos: fn(pos: number) → {node: dom.Node, offset: number}) → fn(selection: Selection) → ?dom.Node
Iterates over parent nodes, returning DOM reference of the closest node of a given nodeType.
```
const domAtPos = view.domAtPos.bind(view);
const parent = findParentDomRefOfType(schema.nodes.codeBlock, domAtPos)(selection); // <pre>
```
findSelectedNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → ?{pos: number, start: number, node: ProseMirrorNode}
Returns a node of a given nodeType if it is selected. start points to the start position of the node, pos points directly before the node.
```
const { extension, inlineExtension, bodiedExtension } = schema.nodes;
const selectedNode = findSelectedNodeOfType([
  extension,
  inlineExtension,
  bodiedExtension,
])(selection);
```
isNodeSelection(selection: Selection) → boolean
Checks if current selection is a NodeSelection.
```
if (isNodeSelection(tr.selection)) {
  // ...
}
```
findPositionOfNodeBefore(selection: Selection) → ?number
Returns position of the previous node.
```
const pos = findPositionOfNodeBefore(tr.selection);
```
findDomRefAtPos(position: number, domAtPos: fn(pos: number) → {node: dom.Node, offset: number}) → dom.Node
Returns DOM reference of a node at a given position. If the node type is of type TEXT_NODE it will return the reference of the parent node.
```
const domAtPos = view.domAtPos.bind(view);
const ref = findDomRefAtPos($from.pos, domAtPos);
```

Utils for working with ProseMirror `node`

flatten(node: ProseMirrorNode, descend: ?boolean = true) → [{node: ProseMirrorNode, pos: number}]
Flattens descendants of a given node. It doesn't descend into a node when descend argument is false (defaults to true).
```
const children = flatten(node);
```
findChildren(node: ProseMirrorNode, predicate: fn(node: ProseMirrorNode) → boolean, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Iterates over descendants of a given node, returning child nodes predicate returns truthy for. It doesn't descend into a node when descend argument is false (defaults to true).
```
const textNodes = findChildren(node, child => child.isText, false);
```
findTextNodes(node: ProseMirrorNode, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Returns text nodes of a given node. It doesn't descend into a node when descend argument is false (defaults to true).
```
const textNodes = findTextNodes(node);
```
findInlineNodes(node: ProseMirrorNode, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Returns inline nodes of a given node. It doesn't descend into a node when descend argument is false (defaults to true).
```
const inlineNodes = findInlineNodes(node);
```
findBlockNodes(node: ProseMirrorNode, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Returns block descendants of a given node. It doesn't descend into a node when descend argument is false (defaults to true).
```
const blockNodes = findBlockNodes(node);
```
findChildrenByAttr(node: ProseMirrorNode, predicate: fn(attrs: ?Object) → boolean, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Iterates over descendants of a given node, returning child nodes predicate returns truthy for. It doesn't descend into a node when descend argument is false (defaults to true).
```
const mergedCells = findChildrenByAttr(table, attrs => attrs.colspan === 2);
```
findChildrenByType(node: ProseMirrorNode, nodeType: NodeType, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Iterates over descendants of a given node, returning child nodes of a given nodeType. It doesn't descend into a node when descend argument is false (defaults to true).
```
const cells = findChildrenByType(table, schema.nodes.tableCell);
```
findChildrenByMark(node: ProseMirrorNode, markType: markType, descend: ?boolean) → [{node: ProseMirrorNode, pos: number}]
Iterates over descendants of a given node, returning child nodes that have a mark of a given markType. It doesn't descend into a node when descend argument is false (defaults to true).
```
const nodes = findChildrenByMark(state.doc, schema.marks.strong);
```
contains(node: ProseMirrorNode, nodeType: NodeType) → boolean
Returns true if a given node contains nodes of a given nodeType
```
if (contains(panel, schema.nodes.listItem)) {
  // ...
}
```

Utils for working with `table`

findTable(selection: Selection) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes, returning the closest table node.
```
const table = findTable(selection);
```
isCellSelection(selection: Selection) → boolean
Checks if current selection is a CellSelection.
```
if (isCellSelection(selection)) {
  // ...
}
```
isColumnSelected(columnIndex: number) → fn(selection: Selection) → boolean
Checks if entire column at index columnIndex is selected.
```
const className = isColumnSelected(i)(selection) ? 'selected' : '';
```
isRowSelected(rowIndex: number) → fn(selection: Selection) → boolean
Checks if entire row at index rowIndex is selected.
```
const className = isRowSelected(i)(selection) ? 'selected' : '';
```
isTableSelected(selection: Selection) → boolean
Checks if entire table is selected
```
const className = isTableSelected(selection) ? 'selected' : '';
```
getCellsInColumn(columnIndex: number) → fn(selection: Selection) → ?[{pos: number, start: number, node: ProseMirrorNode}]
Returns an array of cells in a column at index columnIndex.
```
const cells = getCellsInColumn(i)(selection); // [{node, pos}, {node, pos}]
```
getCellsInRow(rowIndex: number) → fn(selection: Selection) → ?[{pos: number, start: number, node: ProseMirrorNode}]
Returns an array of cells in a row at index rowIndex.
```
const cells = getCellsInRow(i)(selection); // [{node, pos}, {node, pos}]
```
getCellsInTable(selection: Selection) → ?[{pos: number, start: number, node: ProseMirrorNode}]
Returns an array of all cells in a table.
```
const cells = getCellsInTable(selection); // [{node, pos}, {node, pos}]
```
selectColumn(columnIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that creates a CellSelection on a column at index columnIndex.
```
dispatch(
  selectColumn(i)(state.tr)
);
```
selectRow(rowIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that creates a CellSelection on a column at index rowIndex.
```
dispatch(
  selectRow(i)(state.tr)
);
```
selectTable(selection: Selection) → fn(tr: Transaction) → Transaction
Returns a new transaction that creates a CellSelection on the entire table.
```
dispatch(
  selectTable(i)(state.tr)
);
```
emptyCell(cell: {pos: number, node: ProseMirrorNode}, schema: Schema) → fn(tr: Transaction) → Transaction
Returns a new transaction that clears the content of a given cell.
```
const $pos = state.doc.resolve(13);
dispatch(
  emptyCell(findCellClosestToPos($pos), state.schema)(state.tr)
);
```
addColumnAt(columnIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that adds a new column at index columnIndex.
```
dispatch(
  addColumnAt(i)(state.tr)
);
```
addRowAt(rowIndex: number, clonePreviousRow: ?boolean) → fn(tr: Transaction) → Transaction
Returns a new transaction that adds a new row at index rowIndex. Optionally clone the previous row.
```
dispatch(
  addRowAt(i)(state.tr)
);
```
```
dispatch(
  addRowAt(i, true)(state.tr)
);
```
cloneRowAt(cloneRowIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that adds a new row after cloneRowIndex, cloning the row attributes at cloneRowIndex.
```
dispatch(
  cloneRowAt(i)(state.tr)
);
```
removeColumnAt(columnIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that removes a column at index columnIndex. If there is only one column left, it will remove the entire table.
```
dispatch(
  removeColumnAt(i)(state.tr)
);
```
removeRowAt(rowIndex: number) → fn(tr: Transaction) → Transaction
Returns a new transaction that removes a row at index rowIndex. If there is only one row left, it will remove the entire table.
```
dispatch(
  removeRowAt(i)(state.tr)
);
```
removeTable(tr: Transaction) → Transaction
Returns a new transaction that removes a table node if the cursor is inside of it.
```
dispatch(
  removeTable(state.tr)
);
```
removeSelectedColumns(tr: Transaction) → Transaction
Returns a new transaction that removes selected columns.
```
dispatch(
  removeSelectedColumns(state.tr)
);
```
removeSelectedRows(tr: Transaction) → Transaction
Returns a new transaction that removes selected rows.
```
dispatch(
  removeSelectedRows(state.tr)
);
```
removeColumnClosestToPos($pos: ResolvedPos) → fn(tr: Transaction) → Transaction
Returns a new transaction that removes a column closest to a given $pos.
```
dispatch(
  removeColumnClosestToPos(state.doc.resolve(3))(state.tr)
);
```
removeRowClosestToPos($pos: ResolvedPos) → fn(tr: Transaction) → Transaction
Returns a new transaction that removes a row closest to a given $pos.
```
dispatch(
  removeRowClosestToPos(state.doc.resolve(3))(state.tr)
);
```
findCellClosestToPos($pos: ResolvedPos) → ?{pos: number, start: number, node: ProseMirrorNode}
Iterates over parent nodes, returning a table cell or a table header node closest to a given $pos.
```
const cell = findCellClosestToPos(state.selection.$from);
```
findCellRectClosestToPos($pos: ResolvedPos) → ?{left: number, top: number, right: number, bottom: number}
Returns the rectangle spanning a cell closest to a given $pos.
```
dispatch(
  findCellRectClosestToPos(state.selection.$from)
);
```
forEachCellInColumn(columnIndex: number, cellTransform: fn(cell: {pos: number, start: number, node: ProseMirrorNode}, tr: Transaction) → Transaction, setCursorToLastCell: ?boolean) → fn(tr: Transaction) → Transaction
Returns a new transaction that maps a given cellTransform function to each cell in a column at a given columnIndex. It will set the selection into the last cell of the column if setCursorToLastCell param is set to true.
```
dispatch(
  forEachCellInColumn(0, (cell, tr) => emptyCell(cell, state.schema)(tr))(state.tr)
);
```
forEachCellInRow(rowIndex: number, cellTransform: fn(cell: {pos: number, start: number, node: ProseMirrorNode}, tr: Transaction) → Transaction, setCursorToLastCell: ?boolean) → fn(tr: Transaction) → Transaction
Returns a new transaction that maps a given cellTransform function to each cell in a row at a given rowIndex. It will set the selection into the last cell of the row if setCursorToLastCell param is set to true.
```
dispatch(
  forEachCellInRow(0, (cell, tr) => setCellAttrs(cell, { background: 'red' })(tr))(state.tr)
);
```
setCellAttrs(cell: {pos: number, start: number, node: ProseMirrorNode}, attrs: Object) → fn(tr: Transaction) → Transaction
Returns a new transaction that sets given attrs to a given cell.
```
dispatch(
  setCellAttrs(findCellClosestToPos($pos), { background: 'blue' })(tr);
);
```
createTable(schema: Schema, rowsCount: ?number = 3, colsCount: ?number = 3, withHeaderRow: ?boolean = true) → Node
Returns a table node of a given size. withHeaderRow defines whether the first row of the table will be a header row.
```
const table = createTable(state.schema); // 3x3 table node
dispatch(
  tr.replaceSelectionWith(table).scrollIntoView()
);
```

Utils for document transformation

removeParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(tr: Transaction) → Transaction
Returns a new transaction that removes a node of a given nodeType. It will return an original transaction if parent node hasn't been found.
```
dispatch(
  removeParentNodeOfType(schema.nodes.table)(tr)
);
```
replaceParentNodeOfType(nodeType: NodeType | [NodeType], content: ProseMirrorNode | Fragment) → fn(tr: Transaction) → Transaction
Returns a new transaction that replaces parent node of a given nodeType with the given content. It will return an original transaction if either parent node hasn't been found or replacing is not possible.
```
const node = schema.nodes.paragraph.createChecked({}, schema.text('new'));

dispatch(
 replaceParentNodeOfType(schema.nodes.table, node)(tr)
);
```
removeSelectedNode(tr: Transaction) → Transaction
Returns a new transaction that removes selected node. It will return an original transaction if current selection is not a NodeSelection.
```
dispatch(
  removeSelectedNode(tr)
);
```
replaceSelectedNode(node: ProseMirrorNode) → fn(tr: Transaction) → Transaction
Returns a new transaction that replaces selected node with a given node. It will return the original transaction if either current selection is not a NodeSelection or replacing is not possible.
```
const node = schema.nodes.paragraph.createChecked({}, schema.text('new'));
dispatch(
  replaceSelectedNode(node)(tr)
);
```

canInsert($pos: ResolvedPos, content: ProseMirrorNode | Fragment) → boolean
Checks if a given content can be inserted at the given $pos

const { selection: { $from } } = state;
const node = state.schema.nodes.atom.createChecked();
if (canInsert($from, node)) {
  // ...
}

safeInsert(content: ProseMirrorNode | Fragment, position: ?number) → fn(tr: Transaction) → Transaction
Returns a new transaction that inserts a given content at the current cursor position, or at a given position, if it is allowed by schema. If schema restricts such nesting, it will try to find an appropriate place for a given node in the document, looping through parent nodes up until the root document node. If cursor is inside of an empty paragraph, it will try to replace that paragraph with the given content. If insertion is successful and inserted node has content, it will set cursor inside of that content. It will return an original transaction if the place for insertion hasn't been found.
```
const node = schema.nodes.extension.createChecked({});
dispatch(
  safeInsert(node)(tr)
);
```
setParentNodeMarkup(nodeType: NodeType | [NodeType], type: ?NodeType | null, attrs: ?Object | null, marks: ?[Mark]) → fn(tr: Transaction) → Transaction
Returns a transaction that changes the type, attributes, and/or marks of the parent node of a given nodeType.
```
const node = schema.nodes.extension.createChecked({});
dispatch(
  setParentNodeMarkup(schema.nodes.panel, null, { panelType })(tr);
);
```
selectParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(tr: Transaction) → Transaction
Returns a new transaction that sets a NodeSelection on a parent node of a given nodeType.
```
dispatch(
  selectParentNodeOfType([tableCell, tableHeader])(state.tr)
);
```
removeNodeBefore(tr: Transaction) → Transaction
Returns a new transaction that deletes previous node.
```
dispatch(
  removeNodeBefore(state.tr)
);
```
setTextSelection(position: number, dir: ?number = 1) → fn(tr: Transaction) → Transaction
Returns a new transaction that tries to find a valid cursor selection starting at the given position and searching back if dir is negative, and forward if positive. If a valid cursor position hasn't been found, it will return the original transaction.
```
dispatch(
  setTextSelection(5)(tr)
);
```

License

Apache 2.0 : http://www.apache.org/licenses/LICENSE-2.0

ahixon/prosemirror-utils

Utils library for ProseMirror

Quick Start

Public API documentation

Utils for working with selection

Utils for working with ProseMirror node

Utils for working with table

Utils for document transformation

License

Utils for working with `selection`

Utils for working with ProseMirror `node`

Utils for working with `table`