prosemirror-utils

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, node: ProseMirrorNode}
  Iterates over parent nodes, returning the closest node and its start position predicate returns truthy for.

  Example

  const predicate = node => node.type === schema.nodes.blockquote;
  const parent = findParentNode(predicate)(selection);
  

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

  Example

  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.

  Example

  if (hasParentNode(node => node.type === schema.nodes.table)(selection)) {
    // ....
  }
  

• findParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → ?{node: ProseMirrorNode, pos: number}
  Iterates over parent nodes, returning closest node of a given nodeType.

  Example

  const parent = findParentNodeOfType(schema.nodes.paragraph)(selection);
  

• hasParentNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → boolean
  Checks if there's a parent node of a given nodeType.

  Example

  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.

  Example

  const domAtPos = view.domAtPos.bind(view);
  const parent = findParentDomRefOfType(schema.nodes.codeBlock, domAtPos)(selection); // <pre>
  

• findSelectedNodeOfType(nodeType: NodeType | [NodeType]) → fn(selection: Selection) → ?{node: ProseMirrorNode, pos: number}
  Returns a node of a given nodeType if it is selected.

  Example

  const { extension, inlineExtension, bodiedExtension } = schema.nodes;
  const selectedNode = findSelectedNodeOfType([
    extension,
    inlineExtension,
    bodiedExtension,
  ])(selection);
  

• isNodeSelection(selection: Selection) → boolean
  Checks if current selection is a NodeSelection.

  Example

  if (isNodeSelection(tr.selection)) {
    // ...
  }
  

• findPositionOfNodeBefore(selection: Selection) → ?number
  Returns position of the previous node.

  Example

  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. @see https://github.com/atlassian/prosemirror-utils/issues/8 for more context.

  Example

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

  Example

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

  Example

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

  Example

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

  Example

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

  Example

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

  Example

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

  Example

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

  Example

  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

  Example

  if (contains(panel, schema.nodes.listItem)) {
    // ...
  }
  

Utils for working with table

• findTable(selection: Selection) → ?{pos: number, node: ProseMirrorNode}
  Iterates over parent nodes, returning the closest table node.

  Example

  const table = findTable(selection);
  

• isCellSelection(selection: Selection) → boolean
  Checks if current selection is a CellSelection.

  Example

  if (isCellSelection(selection)) {
    // ...
  }
  

• isColumnSelected(columnIndex: number) → fn(selection: Selection) → boolean
  Checks if entire column at index columnIndex is selected.

  Example

  const className = isColumnSelected(i)(selection) ? 'selected' : '';
  

• isRowSelected(rowIndex: number) → fn(selection: Selection) → boolean
  Checks if entire row at index rowIndex is selected.

  Example

  const className = isRowSelected(i)(selection) ? 'selected' : '';
  

• isTableSelected(selection: Selection) → boolean
  Checks if entire table is selected

  Example

  const className = isTableSelected(selection) ? 'selected' : '';
  

• getCellsInColumn(columnIndex: number) → fn(selection: Selection) → ?[{pos: number, node: ProseMirrorNode}]
  Returns an array of cells in a column at index columnIndex.

  Example

  const cells = getCellsInColumn(i)(selection); // [{node, pos}, {node, pos}]
  

• getCellsInRow(rowIndex: number) → fn(selection: Selection) → ?[{pos: number, node: ProseMirrorNode}]
  Returns an array of cells in a row at index rowIndex.

  Example

  const cells = getCellsInRow(i)(selection); // [{node, pos}, {node, pos}]
  

• getCellsInTable(selection: Selection) → ?[{pos: number, node: ProseMirrorNode}]
  Returns an array of all cells in a table.

  Example

  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.

  Example

  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.

  Example

  dispatch(
    selectRow(i)(state.tr)
  );
  

• selectTable(selection: Selection) → fn(tr: Transaction) → Transaction
  Returns a new transaction that creates a CellSelection on the entire table.

  Example

  dispatch(
    selectTable(i)(state.tr)
  );
  

• emptySelectedCells(schema: Schema) → fn(tr: Transaction) → Transaction
  Returns a new transaction that clears the content of selected cells.

  Example

  dispatch(
    emptySelectedCells(state.schema)(state.tr)
  );
  

• addColumnAt(columnIndex: number) → fn(tr: Transaction) → Transaction
  Returns a new transaction that adds a new column at index columnIndex.

  Example

  dispatch(
    addColumnAt(i)(state.tr)
  );
  

• addRowAt(rowIndex: number) → fn(tr: Transaction) → Transaction
  Returns a new transaction that adds a new row at index rowIndex.

  Example

  dispatch(
    addRowAt(i)(state.tr)
  );
  

• removeColumnAt(columnIndex: number) → fn(tr: Transaction) → Transaction
  Returns a new transaction that removes a column at index columnIndex.

  Example

  dispatch(
    removeColumnAt(i)(state.tr)
  );
  

• removeRowAt(rowIndex: number) → fn(tr: Transaction) → Transaction
  Returns a new transaction that removes a row at index rowIndex.

  Example

  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.

  Example

  dispatch(
    removeTable(state.tr)
  );
  

• removeSelectedColumns(tr: Transaction) → Transaction
  Returns a new transaction that removes selected columns.

  Example

  dispatch(
    removeSelectedColumns(state.tr)
  );
  

• removeSelectedRows(tr: Transaction) → Transaction
  Returns a new transaction that removes selected rows.

  Example

  dispatch(
    removeSelectedRows(state.tr)
  );
  

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.

  Example

  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.

  Example

  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.

  Example

  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.

  Example

  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

  Example

  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.

  Example

  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.

  Example

  const node = schema.nodes.extension.createChecked({});
  dispatch(
    safeInsert(node)(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.

  Example

  dispatch(
    selectParentNodeOfType([tableCell, tableHeader])(state.tr)
  );
  

• removeNodeBefore(tr: Transaction) → Transaction
  Returns a new transaction that deletes previous node.

  Example

  dispatch(
    removeNodeBefore(state.tr)
  );
  

• setTextSelection(position: number) → fn(tr: Transaction) → Transaction
  Returns a new transaction that tries to find a valid cursor selection starting at the given position. If a valid cursor position hasn't been found, it will return the original transaction.

  Example

  dispatch(
    setTextSelection(5)(tr)
  );
  

License

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