prosemirror-commands

[ WEBSITE | ISSUES | FORUM | CHANGELOG ]

This is a core module of ProseMirror. ProseMirror is a well-behaved rich semantic content editor based on contentEditable, with support for collaborative editing and custom document schemas.

This module implements a number of editing commands, which are functions that abstract editing actions which can be bound to keys.

The project page has more information, a number of examples and the documentation.

This code is released under an MIT license. There's a forum for general discussion and support requests, and the Github bug tracker is the place to report issues.

We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.

1.7.1 (2025-04-13)

Bug fixes

Fix a regression in splitBlock that would cause it to crash, rather than return false, when no split is possible.

1.7.0 (2025-02-20)

New features

toggleMark now accepts an includeWhitespace option that controls whether it affects leading/trailing space.

1.6.2 (2024-10-24)

Bug fixes

Make splitBlock smart enough to split blocks when the cursor is inside a nested inline node.

1.6.1 (2024-10-11)

Bug fixes

joinBackward will, when moving a node into a block, no longer join that block with the block after when the two have compatible content but aren't of the same type.

Fix an issue in splitBlock that caused it to return true without doing anything when the schema makes splitting at the cursor impossible.

Support implicit conversion between hard break nodes and newlines in the joinForward and joinBackward commands.

1.6.0 (2024-07-26)

Bug fixes

Fix an issue where joinBackward couldn't lift the block with the cursor when the block before it was isolating.

New features

toggleMark now takes an option that controls its behavior when only part of the selection has the mark already.

The function given to splitBlockAs now has access to the split position via a third parameter.

toggleMark now takes an enterInlineAtoms option that controls whether it descends into atom nodes.

1.5.2 (2023-05-17)

Bug fixes

Include CommonJS type declarations in the package to please new TypeScript resolution settings.

1.5.1 (2023-03-01)

Bug fixes

Fix joinTextblockBackward not applying when the textblock before was wrapped in another node.

1.5.0 (2022-12-05)

New features

The new splitBlockAs command-builder allows you to pass in custom logic to determine the type of block that should be split off.

1.4.0 (2022-12-01)

Bug fixes

Make setBlockType act on all selection ranges in selections that have them.

New features

The new joinTextblockForward and joinTextblockBackward commands provide a more primitive command for delete/backspace behavior when you don't want the extra strategies implemented by joinForward/joinBackward.

1.3.1 (2022-09-08)

Bug fixes

Make sure toggleMark doesn't add marks to top nodes with non-inline content.

1.3.0 (2022-05-30)

New features

Include TypeScript type declarations.

1.2.2 (2022-03-16)

Bug fixes

Don't override behavior of Home and End keys in base keymap.

1.2.1 (2022-01-20)

Bug fixes

Fix an issue where joinBackward and joinForward would return true when activated with the cursor in an empty but undeletable block, but not make any change.

1.2.0 (2022-01-17)

Bug fixes

Add a workaround for a bug on macOS where Ctrl-a and Ctrl-e getting stuck at the edge of inline nodes.

New features

The new selectTextblockEnd and selectTextblockStart commands move the cursor to the start/end of the textblock, when inside one.

Ctrl-a/e on macOS and Home/End on other platforms are now bound to selectTextblockEnd and selectTextblockStart.

1.1.12 (2021-10-29)

Bug fixes

Fix issue where the default PC keymap was used on recent versions of iPhone or iPad operating systems.

1.1.11 (2021-10-06)

Bug fixes

Add a binding for Shift-Backspace to the base keymap, so that shift or caps-lock won't interfere with backspace behavior.

Fix an issue in autoJoin that made it ignore a third argument if it was passed one.

1.1.10 (2021-07-05)

Bug fixes

Make joinBackward capable of joining textblocks wrapped in parent nodes when the parent nodes themselves can't be joined (for example two list items which allow only a single paragraph).

1.1.9 (2021-06-07)

Bug fixes

Fix a regression where splitBlock could crash when splitting at the end of a non-default block.

1.1.8 (2021-05-22)

Bug fixes

Fix a crash in splitBlock that occurred with certain types of schemas.

1.1.7 (2021-02-22)

Bug fixes

Fix a regression where createParagraphNear no longer fired for gap cursor selections.

1.1.6 (2021-02-10)

Bug fixes

Improve behavior of enter when the entire document is selected.

1.1.5 (2021-01-14)

Bug fixes

joinBackward and joinForward will now, when the textblock after the cut can't be moved into the structure before the cut, try to just join the inline content onto the last child in the structure before the cut.

toggleMark will now skip whitespace at the start and end of the selection when adding a mark.

1.1.4 (2020-04-15)

Bug fixes

selectNodeForward and selectNodeBackward will now also select nodes next to a gap cursor (or other custom empty selection type).

1.1.3 (2020-01-03)

Bug fixes

Fix an issue where, since version 1.7.4 of prosemirror-model, splitBlock fails to create the expected new textblock in some schemas.

1.1.2 (2019-11-20)

Bug fixes

Rename ES module files to use a .js extension, since Webpack gets confused by .mjs

1.1.1 (2019-11-19)

Bug fixes

The file referred to in the package's module field now is compiled down to ES5.

1.1.0 (2019-11-08)

New features

Add a module field to package json file.

1.0.8 (2019-05-14)

Bug fixes

Fix a crash caused by using a position potentially outside the document in splitBlock.

1.0.7 (2018-04-09)

Bug fixes

Fixes an issue where joinBackward might create a selection pointing into the old document.

1.0.6 (2018-04-04)

Bug fixes

The setBlockType command command is now considered applicable when any of the selected textblocks can be changed (it used to only look at the first one).

Fix crash when calling splitBlock when the selection isn't in a block node (by disabling the command in that case).

Fixes an issue where joinForward might create a selection pointing into the old document.

1.0.5 (2018-01-30)

Bug fixes

Fix crash in splitBlock when defaultContentType returns null.

1.0.4 (2018-01-18)

Bug fixes

Pressing delete in front of an isolating node no longer opens it.

1.0.3 (2017-12-19)

Bug fixes

Fix issue where joinBackward would sometimes create an invalid selection.

1.0.2 (2017-11-21)

Bug fixes

splitBlock no longer crashes when used in a block that's it's parent node's only allowed child.

1.0.0 (2017-10-13)

New features

The setBlockType command can now be used to change the types of multiple selected textblocks (rather than only one).

The platform-dependent versions of the base keymap are now exported separately as pcBaseKeymap and macBaseKeymap.

0.23.0 (2017-09-13)

Breaking changes

joinForward and joinBackward no longer fall back to selecting the next node when no other behavior is possible. There are now separate commands selectNodeForward and selectNodeBackward that do this, which the base keymap binds as fallback behavior.

baseKeymap no longer binds keys for joinUp, joinDown, lift, and selectParentNode.

New features

New commands selectNodeForward and selectNodeBackward added.

0.20.0 (2017-04-03)

New features

The new selectAll command, bound to Mod-a in the base keymap, sets the selection to an AllSelection.

0.19.0 (2017-03-16)

Bug fixes

Calling joinBackward at the start of a node that can't be joined no longer raises an error.

0.18.0 (2017-02-24)

New features

New command splitBlockKeepMarks which splits a block but preserves the marks at the cursor.

0.17.1 (2017-01-16)

Bug fixes

Make sure toggleMark also works in the top-level node (when it is a textblock).

0.17.0 (2017-01-05)

Breaking changes

The dispatch function passed to commands is now passed a Transaction, not an action object.

0.15.0 (2016-12-10)

Breaking changes

Drops suppport for delete(Char|Word)(Before|After) and move(Back|For)ward, since we are now letting the browser handle those natively.

Bug fixes

The joinForward and joinBackward commands can now strip out markup and nodes that aren't allowed in the joined node.

New features

A new command exitCode allows a user to exit a code block by creating a new paragraph below it.

The joinForward and joinBackward commands now use a bidirectional-text-aware way to determine whether the cursor is at the proper side of its parent textblock when they are passed a view.

0.13.0 (2016-11-11)

New features

The autoJoin function allows you to wrap command functions so that when the command makes nodes of a certain type occur next to each other, they are automatically joined.

0.12.0 (2016-10-21)

Bug fixes

Fix crash when backspacing into nodes with complex content expressions.

0.11.0 (2016-09-21)

Breaking changes

Moved into a separate module.

The interface for command functions was changed to work with the new state/action abstractions.