Reference manual
This is the reference manual for the
ProseMirror rich text editor. It
lists and describes the full public API exported by the library.
FIXME write and link introduction guides
ProseMirror is distributed as a set of JavaScript modules. This
reference manual describes the exported API per module. So if you want
to use something from the edit module, you have to import
it from there.
var edit = require("prosemirror/dist/edit")
var editor = new edit.ProseMirror()
Or in ES6 syntax:
import {ProseMirror} from "prosemirror/dist/edit"
let editor = new ProseMirror()
Note that the content of the dist directory only exists in a built
version of code. If you are getting it from npm, you should be fine.
If you manually cloned the
git repository, you'll
need to npm install inside of it first.
This module implements the ProseMirror editor. It contains
functionality related to editing, selection, and integration with
the browser. ProseMirror is the class you'll want to instantiate
and interact with when using the editor.
Options
schema: Schema 📄The schema that the editor's document should use.
doc: any 📄The starting document. Usually a Node, but can be in another
format when the docFormat option is also specified.
docFormat: ?string 📄The format in which the doc option is given. Defaults to null
(a raw Node).
place: ?union<DOMNode, fn(DOMNode)> 📄Determines the placement of the editor in the page. When null,
the editor is not placed. When a DOM node is given, the editor is
appended to that node. When a function is given, it is called
with the editor's wrapping DOM node, and is expected to place it
into the document.
historyDepth: number 📄The amount of history events that are collected before the oldest
events are discarded. Defaults to 100.
historyEventDelay: number 📄The amount of milliseconds that must pass between changes to
start a new history event. Defaults to 500.
commands: CommandSet 📄Specifies the set of commands available in the editor
(which in turn determines the base key bindings and items available
in the menus). Defaults to CommandSet.default.
label: ?string 📄The label of the editor. When set, the editable DOM node gets an
aria-label attribute with this value.
This is the class used to represent instances of the editor. A
ProseMirror editor holds a document and a
selection, and displays an editable surface
representing that document in the browser document.
Contains event methods (on, etc) from the event
mixin.
Constructor
new ProseMirror(opts: Object) 📄Construct a new editor from a set of options
and, if it has a place option, add it to the
document.
Properties
schema: Schema 📄The schema for this editor's document.
content: DOMNode 📄The editable DOM node containing the document.
wrapper: DOMNode 📄The outer DOM element of the editor.
mod: Object 📄A namespace where modules can store references to themselves
associated with this editor instance.
commands: Object<Command> 📄The commands available in the editor.
selection: Selection 📄Get the current selection.
doc: Node 📄The current document.
tr: EditorTransform 📄Create an editor- and selection-aware Transform for this editor.
Methods
setOption(name: string, value: any) 📄Update the value of the given option.
getOption(name: string) → any 📄Get the current value of the given option.
setTextSelection(anchor: Pos, head: ?Pos) 📄Set the selection to a text selection from
anchor to head, or, if head is null, a cursor selection at
anchor.
setNodeSelection(pos: Pos) 📄Set the selection to a node selection on the node after pos.
setSelection(selection: Selection) 📄Set the selection to the given selection object.
setContent(value: any, format: ?string) 📄Replace the editor's document. When format is given, it should
be a parsable format, and value should something in
that format. If not, value should be a Node.
getContent(format: ?string) → any 📄Get the editor's content in a given format. When format is not
given, a Node is returned. If it is given, it should be an
existing serialization format.
setDoc(doc: Node, sel: ?Selection) 📄Set the editor's content, and optionally include a new selection.
apply(transform: Transform, options: ?Object = nullOptions) → ?Transform 📄Apply a transformation (which you might want to create with the
tr getter) to the document in the editor.
The following options are supported:
selection: ?Selection- A new selection to set after the transformation is applied.
scrollIntoView: ?bool- When true, scroll the selection into view on the next
redraw.
Returns the transform, or false if there were no steps in it.
Has the following property:
scroll: Object 📄The object {scrollIntoView: true}, which is a common argument to
pass to ProseMirror.apply or EditorTransform.apply.
checkPos(pos: Pos, textblock: ?bool) 📄Verify that the given position is valid in the current document,
and throw an error otherwise. When textblock is true, the position
must also fall within a textblock node.
flush() 📄Flush any pending changes to the DOM. When the document,
selection, or marked ranges in an editor change, the DOM isn't
updated immediately, but rather scheduled to be updated the next
time the browser redraws the screen. This method can be used to
force this to happen immediately. It can be useful when you, for
example, want to measure where on the screen a part of the
document ends up, immediately after changing the document.
addKeymap(map: Keymap, rank: ?number = 50) 📄Add a
keymap
to the editor. Keymaps added in this way are queried before the
base keymap. The rank parameter can be used to
control when they are queried relative to other maps added like
this. Maps with a lower rank get queried first.
removeKeymap(map: union<string, Keymap>) 📄Remove the given keymap, or the keymap with the given name, from
the editor.
markRange(from: Pos, to: Pos, options: ?Object) → MarkedRange 📄Create a marked range between the given positions. Marked ranges
“track” the part of the document they point to—as the document
changes, they are updated to move, grow, and shrink along with
their content.
options may be an object containing these properties:
inclusiveLeft: bool = false- Whether the left side of the range is inclusive. When it is,
content inserted at that point will become part of the range.
When not, it will be outside of the range.
inclusiveRight: bool = false- Whether the right side of the range is inclusive.
removeWhenEmpty: bool = true- Whether the range should be forgotten when it becomes empty
(because all of its content was deleted).
className: string- A CSS class to add to the inline content that is part of this
range.
removeRange(range: MarkedRange) 📄Remove the given range from the editor.
setMark(type: MarkType, to: ?bool, attrs: ?Object) 📄Set (when to is true), unset (to is false), or toggle (to
is null) the given mark type on the selection. When there is a
non-empty selection, the marks of the selection are updated. When
the selection is empty, the set of active
marks is updated.
activeMarks() → [Mark] 📄Get the marks at the cursor. By default, this yields the marks
associated with the content at the cursor, as per Node.marksAt.
But setMark may have been used to change the set of active
marks, in which case that set is returned.
focus() 📄Give the editor focus.
hasFocus() → bool 📄Query whether the editor has focus.
posAtCoords(coords: {top: number, left: number}) → ?Pos 📄If the given coordinates (which should be relative to the top
left corner of the window—not the page) fall within the editable
content, this method will return the document position that
corresponds to those coordinates.
coordsAtPos(pos: Pos) → {top: number, left: number, bottom: number} 📄Find the screen coordinates (relative to top left corner of the
window) of the given document position.
scrollIntoView(pos: ?Pos = null) 📄Scroll the given position, or the cursor position if pos isn't
given, into view.
execCommand(name: string, params: ?[any]) → bool 📄Execute the named command. If the command takes
parameters and they are not passed here, the user will be
prompted for them.
keyForCommand(name: string) → ?string 📄Return the name of the key that is bound to the given command, if
any.
Events
optionChanged(name: string, value: any) 📄Fired when setOption is called.
beforeSetDoc(doc: Node, selection: Selection) 📄Fired when setDoc is called, before
the document is actually updated.
setDoc(doc: Node, selection: Selection) 📄Fired when setDoc is called, after
the document is updated.
change() 📄Fired when the document has changed. See
setDoc and
transform for more specific
change-related events.
transform(Transform, Object) 📄Signals that a (non-empty) transformation has been aplied to
the editor. Passes the Transform and the options given to
apply as arguments to the handler.
flushing() 📄Fired when the editor is about to flush
an update to the DOM.
draw() 📄Fired when the editor redrew its document in the DOM.
flush() 📄Fired when the editor has finished
flushing an update to the DOM.
activeMarkChange() 📄Fired when the set of active marks changes.
selectionChange() 📄Indicates that the editor's selection has changed.
commandsChanging() 📄Fired before the set of commands for the editor is updated.
commandsChanged() 📄Fired when the set of commands for the editor is updated.
textInput() 📄Fired when the user types text into the editor.
transformPastedText(text: string) → string 📄Fired when plain text is pasted. Handlers must return the given
string or a transformed version of
it.
transformPastedHTML(html: string) → string 📄Fired when html content is pasted. Handlers must return the given
string or a transformed version of
it.
focus() 📄Fired when the editor gains focus.
blur() 📄Fired when the editor loses focus.
Extends Transform.
A selection-aware extension of Transform. Use
ProseMirror.tr to create an instance.
selection: Selection 📄Get the editor's current selection, mapped
through the steps in this transform.
apply(options: ?Object) → ?EditorTransform 📄Apply the transformation. Returns the transform, or false it is
was empty.
replaceSelection(node: ?Node, inheritMarks: ?bool) → EditorTransform 📄Replace the selection with the given node, or delete it if node
is null. When inheritMarks is true and the node is an inline
node, it inherits the marks from the place where it is inserted.
deleteSelection() → EditorTransform 📄Delete the selection.
typeText(text: string) → EditorTransform 📄Replace the selection with a text node containing the given string.
Extends ProseMirrorError.
Error type used to signal selection-related problems.
An editor selection. Can be one of two selection types:
TextSelection and NodeSelection. Both have the properties
listed here, but also contain more information (such as the
selected node or the
head and anchor).
Properties
from: Pos 📄The start of the selection.
to: Pos 📄The end of the selection.
Static properties
empty: bool 📄True if the selection is an empty text selection (head an anchor
are the same).
eq(other: Selection) → bool 📄Test whether the selection is the same as another selection.
map(doc: Node, mapping: Mappable) → Selection 📄Map this selection through a mappable thing. doc
should be the new document, to which we are mapping.
Extends Selection.
A text selection represents a classical editor
selection, with a head (the moving side) and anchor (immobile
side), both of which point into textblock nodes. It can be empty (a
regular cursor position).
Constructor
new TextSelection(anchor: Pos, head: ?Pos) 📄Construct a text selection. When head is not given, it defaults
to anchor.
Properties
anchor: Pos 📄The selection's immobile side (does not move when pressing
shift-arrow).
head: Pos 📄The selection's mobile side (the side that moves when pressing
shift-arrow).
Extends Selection.
A node selection is a selection that points at a
single node. All nodes marked selectable
can be the target of a node selection. In such an object, from
and to point directly before and after the selected node.
Constructor
new NodeSelection(from: Pos, to: Pos, node: Node) 📄Create a node selection. Does not verify the validity of its
arguments. Use ProseMirror.setNodeSelection for an easier,
error-checking way to create a node selection.
Properties
node: Node 📄The selected node.
A marked range. Includes the methods
from the event mixin.
Properties
from: ?Pos 📄The current start position of the range. Updated whenever the
editor's document is changed. Set to null when the marked
range is removed.
to: ?Pos 📄The current end position of the range. Updated whenever the
editor's document is changed. Set to null when the marked
range is removed.
Events
removed(from: Pos, to: Pos) 📄Signalled when the marked range is removed from the editor.
A command is a named piece of functionality that can be bound to
a key, shown in the menu, or otherwise exposed to the user.
The commands available in a given editor are determined by the
commands option. By default, they come from the baseCommands
object and the commands registered with
schema items. Registering a CommandSpec on a node or
mark type will cause that command to come into scope
in editors whose schema includes that item.
Properties
name: string 📄The name of the command.
spec: CommandSpec 📄The command's specifying object.
params: [CommandParam] 📄Get the list of parameters that this command expects.
label: string 📄Get the label for this command.
Methods
exec(pm: ProseMirror, params: ?[any]) → ?bool 📄Execute this command. If the command takes
parameters, they can be passed as second
argument here, or omitted, in which case a parameter
handler will be called to prompt the user
for values.
Returns the value returned by the command spec's run
method, or false if the command could not be
ran.
select(pm: ProseMirror) → bool 📄Ask this command whether it is currently relevant, given the
editor's document and selection. If the command does not define a
select method, this always returns true.
active(pm: ProseMirror) → bool 📄Ask this command whether it is “active”. This is mostly used to
style inline mark icons (such as strong) differently when the
selection contains such marks.
The type used as the value of the commands option. Allows you
to specify the set of commands that are available in the editor by
adding and modifying command specs.
Methods
add(set: union<Object<CommandSpec>, string>, filter: ?fn(string, CommandSpec) → bool) → CommandSet 📄Add a set of commands, creating a new command set. If set is
the string "schema", the commands are retrieved from the
editor's schema's registry, otherwise, it
should be an object mapping command names to command specs.
A filter function can be given to add only the commands for which
the filter returns true.
update(update: Object<?CommandSpec>) → CommandSet 📄Create a new command set by adding, modifying, or deleting
commands. The update object can map a command name to null to
delete it, to a full CommandSpec (containing a run property)
to add it, or to a partial CommandSpec (without a run
property) to update some properties in the command by that name.
Static properties
empty: CommandSet 📄A set without any commands.
default: CommandSet 📄The default value of the commands option. Includes the base
commands and the commands defined by the schema.
Commands are defined using objects that specify various aspects of
the command. The only property that must appear in a command spec
is run. You should probably also give your
commands a label.
label: string 📄A user-facing label for the command. This will be used, among other
things. as the tooltip title for the command's menu item. If there
is no label, the command's name will be used instead.
run(pm: ProseMirror, ...params: [any]) → ?bool 📄The function that executes the command. If the command has
parameters, their values are passed as
arguments. For commands registered on node or
mark types, this will be bound to the node or mark type when this
function is ran. Should return false when the command could not
be executed.
params: [CommandParam] 📄The parameters that this command expects.
select(pm: ProseMirror) → bool 📄The function used to select the command. this
will again be bound to a node or mark type, when available.
active(pm: ProseMirror) → bool 📄The function used to determine whether the command is
active. this refers to the associated node or
mark type.
keys: union<string, [string]> 📄The default key bindings for this command. May either be an array
of strings containing key
names,
or an object with optional all, mac, and pc properties,
specifying arrays of keys for different platforms.
derive: union<bool, Object> 📄Mark and node types often need to define
boilerplate commands. To reduce the amount of duplicated code, you
can derive such commands by setting the derive property to either
true or an object which is passed to the deriving function. If
this object has a name property, that is used, instead of the
command name, to pick a deriving function.
For node types, you can derive "insert", "make", and "wrap".
For mark types, you can derive "set", "unset", and "toggle".
The parameters that a command can take are specified using objects
with the following properties:
label: string 📄The user-facing name of the parameter. Shown to the user when
prompting for this parameter.
type: string 📄The type of the parameter. Supported types are "text" and "select".
default: any 📄A default value for the parameter.
prefill(ProseMirror) → ?any 📄A function that, given an editor instance (and a this bound to
the command's source item), tries to derive an initial value for
the parameter, or return null if it can't.
You can add several properties to node types to
influence the way the editor interacts with them.
Methods
countCoordsAsChild(node: Node, path: [number], dom: DOMNode, coords: {left: number, top: number}) → ?Pos 📄Specifies that, if this node is clicked, a child node might
actually be meant. This is used to, for example, make clicking a
list marker (which, in the DOM, is part of the list node) select
the list item it belongs to. Should return null if the given
coordinates don't refer to a child node, or the position
before the child otherwise.
handleClick(pm: ProseMirror, event: MouseEvent, path: [number], node: Node) → bool 📄If a node is directly clicked (that is, the click didn't land in a
DOM node belonging to a child node), and its type has a
handleClick method, that method is given a chance to handle the
click. The method is called, and should return false if it did
not handle the click.
The event passed is the event for "mousedown", but calling
preventDefault on it has no effect, since this method is only
called after a corresponding "mouseup" has occurred and
ProseMirror has determined that this is not a drag or multi-click
event.
handleContextMenu(pm: ProseMirror, event: MouseEvent, path: [number], node: Node) → bool 📄When the context
menu
is activated in the editable context, nodes that the clicked
position falls inside of get a chance to react to it. Node types
may define a handleContextMenu method, which will be called when
present, first on inner nodes and then up the document tree, until
one of the methods returns something other than false.
The handlers can inspect event.target to figure out whether they
were directly clicked, and may call event.preventDefault() to
prevent the native context menu.
Functions
defineOption(name: string, defaultValue: any, update: fn(pm: ProseMirror, newValue: any, oldValue: any, init: bool), updateOnInit: bool) 📄Define a new option. The update handler will be called with the
option's old and new value every time the option is
changed. When updateOnInit is true, it
is also called on editor init, with null as the old value, and a fourth
argument of true.
commandParamHandler(pm: ProseMirror, cmd: Command, callback: fn(?[any])) 📄The handler used to prompt the user for command
parameters. Null (the default) means to use the
default handler.
withParamHandler(handler: fn(pm: ProseMirror, cmd: Command, callback: fn(?[any])), f: fn()) 📄Run f, overriding the current command parameter handler
with handler for the dynamic scope of the function.
defineDefaultParamHandler(handler: fn(pm: ProseMirror, cmd: Command, callback: fn(?[any])), override: ?bool = true) 📄Register a default parameter handler, which
is a function that prompts the user to enter values for a command's
parameters, and calls a callback with the values
received. If override is set to false, the new handler will be
ignored if another handler has already been defined.
Constants
baseCommands: Object<CommandSpec> 📄The set of default commands defined by the core library. They are
included in the default command set.
deleteSelection 📄Delete the selection, if there is one.
Keybindings: Backspace, Delete, Mod-Backspace, Mod-Delete,
**Ctrl-H (Mac), Alt-Backspace (Mac), Ctrl-D (Mac),
**Ctrl-Alt-Backspace (Mac), Alt-Delete (Mac), Alt-D (Mac)
joinBackward 📄If the selection is empty and at the start of a textblock, move
that block closer to the block before it, by lifting it out of its
parent or, if it has no parent it doesn't share with the node
before it, moving it into a parent of that node, or joining it with
that.
Keybindings: Backspace, Mod-Backspace
deleteCharBefore 📄Delete the character before the cursor, if the selection is empty
and the cursor isn't at the start of a textblock.
Keybindings: Backspace, Ctrl-H (Mac)
deleteWordBefore 📄Delete the word before the cursor, if the selection is empty and
the cursor isn't at the start of a textblock.
Keybindings: Mod-Backspace, Alt-Backspace (Mac)
joinForward 📄If the selection is empty and the cursor is at the end of a
textblock, move the node after it closer to the node with the
cursor (lifting it out of parents that aren't shared, moving it
into parents of the cursor block, or joining the two when they are
siblings).
Keybindings: Delete, Mod-Delete
deleteCharAfter 📄Delete the character after the cursor, if the selection is empty
and the cursor isn't at the end of its textblock.
Keybindings: Delete, Ctrl-D (Mac)
deleteWordAfter 📄Delete the word after the cursor, if the selection is empty and the
cursor isn't at the end of a textblock.
Keybindings: Mod-Delete, Ctrl-Alt-Backspace (Mac), Alt-Delete
(Mac), Alt-D (Mac)
joinUp 📄Join the selected block or, if there is a text selection, the
closest ancestor block of the selection that can be joined, with
the sibling above it.
Keybindings: Alt-Up
Registers itself in the block menu group
joinDown 📄Join the selected block, or the closest ancestor of the selection
that can be joined, with the sibling after it.
Keybindings: Alt-Down
lift 📄Lift the selected block, or the closest ancestor block of the
selection that can be lifted, out of its parent node.
Keybindings: Alt-Left
Registers itself in the block menu group.
newlineInCode 📄If the selection is in a node whose type has a truthy isCode
property, replace the selection with a newline character.
Keybindings: Enter
createParagraphNear 📄If a content-less block node is selected, create an empty paragraph
before (if it is its parent's first child) or after it.
Keybindings: Enter
liftEmptyBlock 📄If the cursor is in an empty textblock that can be lifted, lift the
block.
Keybindings: Enter
splitBlock 📄Split the parent block of the selection. If the selection is a text
selection, delete it.
Keybindings: Enter
textblockType 📄Change the type of the selected textblocks. Takes one parameter,
type, which should be a {type: NodeType, attrs: ?Object}
object, giving the new type and its attributes.
Available types are determined by enumerating the values
registered on the schema under the
"textblockMenu" namespace. They should have the form {label: string, rank: ?number, attrs: ?Object}.
Registers itself in the block menu group,
where it creates the textblock type dropdown.
insert 📄Replace the selection with a node chosen from a drop-down. Takes
its options values registered under the
"insertMenu" namespace. These should have the form {label: string, rank: ?number, attrs: ?Object, command: ?string}. rank
determines the order in which the options appear (lowest first). If
a command property is given, the command named by that string,
prefixed with the node type name and a colon, will be executed when
the option is chosen. If not, a node of type is created, with
attributes from the attrs property, and used to replace the
selection.
Registers itself in the insert menu group
selectParentNode 📄Move the selection to the node wrapping the current selection, if
any. (Will not select the document node.)
Keybindings: Esc
Registers itself in the block menu group.
selectNodeLeft 📄Select the node directly before the cursor, if any.
Keybindings: Left, Mod-Left
selectNodeRight 📄Select the node directly after the cursor, if any.
Keybindings: Right, Mod-Right
selectNodeUp 📄Select the node directly above the cursor, if any.
Keybindings: Up
selectNodeDown 📄Select the node directly below the cursor, if any.
Keybindings: Down
undo 📄Undo the most recent change event, if any.
Keybindings: Mod-Z
Registers itself in the history menu group.
redo 📄Redo the most recently undone change event, if any.
Keybindings: Mod-Y, Shift-Mod-Z
Registers itself in the history menu group.
Commands
strong:set 📄Add the strong mark to the selected content.
strong:unset 📄Remove the strong mark from the selected content.
strong:toggle 📄Toggle the strong mark. If there is any strong
content in the selection, or there is no selection and the active
marks contain the strong mark, this
counts as active and executing it removes the
mark. Otherwise, this does not count as active, and executing it
makes the selected content strong.
Keybindings: Mod-B
Registers itself in the inline menu group.
em:set 📄Add the emphasis mark to the selected content.
em:unset 📄Remove the emphasis mark from the selected content.
em:toggle 📄Toggle the emphasis mark. If there is any emphasized
content in the selection, or there is no selection and the active
marks contain the emphasis mark, this
counts as active and executing it removes the
mark. Otherwise, this does not count as active, and executing it
makes the selected content emphasized.
Keybindings: Mod-I
Registers itself in the inline menu group.
code:set 📄Add the code mark to the selected content.
code:unset 📄Remove the code mark from the selected content.
code:toggle 📄Toggle the code mark. If there is any code-styled
content in the selection, or there is no selection and the active
marks contain the code mark, this
counts as active and executing it removes the
mark. Otherwise, this does not count as active, and executing it
styles the selected content as code.
Keybindings: Mod-`
Registers itself in the inline menu group.
link:unset 📄Removes all links for the selected content, or, if there is no
selection, from the active marks. Will
only select itself when there is a link in the
selection or active marks.
Registers itself in the inline menu group.
link:set 📄Adds a link mark to the selection or set of active
marks. Takes parameters to determine the
attributes of the link:
href: string- The link's target.
title: string- The link's title.
Adds itself to the inline menu group. Only selects itself when
unlink isn't selected, so that only one of the two is visible in
the menu at any time.
image:insert 📄Replace the selection with an image node. Takes paramers
that specify the image's attributes:
src: string- The URL of the image.
alt: string- The alt text for the image.
title: string- A title for the image.
Registers itself in the inline menu group.
bullet_list:wrap 📄Wrap the selection in a bullet list.
Keybindings: Alt-Right '*', Alt-Right '-'
Registers itself in the block menu group.
ordered_list:wrap 📄Wrap the selection in an ordered list.
Keybindings: Alt-Right '1'
Registers itself in the block menu group.
blockquote:wrap 📄Wrap the selection in a block quote.
Keybindings: Alt-Right '>', Alt-Right '"'
Registers itself in the block menu group.
hard_break:insert 📄Replace the selection with a hard break node. If the selection is
in a node whose type has a truthy isCode property
(such as CodeBlock in the default schema), a regular newline is
inserted instead.
Keybindings: Mod-Enter, Shift-Enter
list_item:split 📄If the selection is a text selection inside of a child of a list
item, split that child and the list item, and delete the selection.
Keybindings: Enter
:heading::make_ 📄The commands make1 to make6 set the textblocks in the
selection to become headers with the given level.
Keybindings: Mod-H '1' through Mod-H '6'
paragraph:make 📄Set the textblocks in the selection to be regular paragraphs.
Keybindings: Mod-P
code_block:make 📄Set the textblocks in the selection to be code blocks.
Keybindings: Mod-\
horizontal_rule:insert 📄Replace the selection with a horizontal rule.
Keybindings: Mod-Shift-Minus
This module defines ProseMirror's document model, the data
structure used to define and inspect content documents. It
includes:
-
The node type that represents document elements
-
The schema types used to tag and constrain the
document structure
-
The data type for document positions
This module does not depend on the browser API being available
(i.e. you can load it into any JavaScript environment).
This class represents a node in the tree that makes up a
ProseMirror document. So a document is an instance of Node, with
children that are also instances of Node.
Nodes are persistent data structures. Instead of changing them, you
create new ones with the content you want. Old ones keep pointing
at the old document shape. This is made cheaper by sharing
structure between the old and new data as much as possible, which a
tree shape like this (without back pointers) makes easy.
Never directly mutate the properties of a Node object. See
this guide for more information.
Properties
type: NodeType 📄The type of node that this is.
attrs: Object 📄An object mapping attribute names to string values. The kind of
attributes allowed and required are determined by the node
type.
content: Fragment 📄The node's content.
marks: [Mark] 📄The marks (things like whether it is emphasized or part of a
link) associated with this node.
size: number 📄The size of the node's content, which is the maximum offset in
the node. For nodes that don't contain text, this is also the
number of child nodes that the node has.
width: number 📄The width of this node. Always 1 for non-text nodes, and the
length of the text for text nodes.
textContent: string 📄Concatenate all the text nodes found in this fragment and its
children.
firstChild: ?Node 📄Returns this node's first child, or null if there are no
children.
lastChild: ?Node 📄Returns this node's last child, or null if there are no
children.
isBlock: bool 📄True when this is a block (non-inline node)
isTextblock: bool 📄True when this is a textblock node, a block node with inline
content.
isInline: bool 📄True when this is an inline node (a text node or a node that can
appear among text).
isText: bool 📄True when this is a text node.
text: ?string 📄For text nodes, this contains the node's text content.
Methods
child(off: number) → Node 📄Retrieve the child at the given offset. Note that this is not
the appropriate way to loop over a node. child's complexity may
be non-constant for some nodes, and it will return the same node
multiple times when calling it for different offsets within a
text node.
iter(start: ?number, end: ?number) → Iterator<Node> 📄Create an iterator over this node's children, optionally starting
and ending at a given offset.
reverseIter(start: ?number, end: ?number) → Iterator<Node> 📄Create a reverse iterator (iterating from the node's end towards
its start) over this node's children, optionally starting and
ending at a given offset. Note: if given, start should be
greater than (or equal) to end.
chunkBefore(off: number) → {start: number, node: Node} 📄Find the node that sits before a given offset. Can be used to
find out which text node covers a given offset. The start
property of the return value is the starting offset of the
returned node. It is an error to call this with offset 0.
chunkAfter(off: number) → {start: number, node: Node} 📄Find the node that sits after a given offset. The start
property of the return value is the starting offset of the
returned node. It is an error to call this with offset
corresponding to the end of the node.
forEach(f: fn(node: Node, start: number, end: number)) 📄Call the given function for each child node. The function will be
given the node, as well as its start and end offsets, as
arguments.
sameMarkup(other: Node) → bool 📄Compare the markup (type, attributes, and marks) of this node to
those of another. Returns true if both have the same markup.
hasMarkup(type: NodeType, attrs: ?Object, marks: ?[Mark]) → bool 📄Check whether this node's markup correspond to the given type,
attributes, and marks.
copy(content: ?Fragment = null) → Node 📄Create a new node with the same markup as this node, containing
the given content (or empty, if no content is given).
mark(marks: [Mark]) → Node 📄Create a copy of this node, with the given set of marks instead
of the node's own marks.
slice(from: number, to: ?number) → Node 📄Create a copy of this node with only the content between the
given offsets. If to is not given, it defaults to the end of
the node.
splice(from: number, to: number, replace: Fragment) → Node 📄Create a copy of this node with the content between the given
offsets replaced by the given fragment.
append(fragment: Fragment, joinLeft: ?number = 0, joinRight: ?number = 0) → Node 📄Append the given fragment to this node's
content, and create a new node with the result.
replace(pos: number, node: Node) → Node 📄Return a copy of this node with the child at the given offset
replaced by the given node. Note: The offset should not fall
within a text node.
replaceDeep(path: [number], node: Node) → Node 📄Return a copy of this node with the descendant at path replaced
by the given replacement node. This will copy as many sub-nodes as
there are elements in path.
close(depth: number, side: string) → Node 📄“Close” this node by making sure that, if it is empty, and is not
allowed to be so, it has its default content inserted. When depth
is greater than zero, sub-nodes at the given side (which can be
"start" or "end") are closed too. Returns itself if no work
is necessary, or a closed copy if something did need to happen.
path(path: [number]) → Node 📄Get the descendant node at the given path, which is interpreted
as a series of offsets into successively deeper nodes.
nodeAfter(pos: Pos) → ?Node 📄Get the node after the given position, if any.
siblingRange(from: Pos, to: Pos) → {from: Pos, to: Pos} 📄Finds the narrowest sibling range (two positions that both point
into the same node) that encloses the given positions.
nodesBetween(from: ?Pos, to: ?Pos, f: fn(node: Node, path: [number], parent: Node)) 📄Iterate over all nodes between the given two positions, calling
the callback with the node, the path towards it, and its parent
node, as arguments. from and to may be null to denote
starting at the start of the node or ending at its end. Note that
the path passed to the callback is mutated as iteration
continues, so if you want to preserve it, make a copy.
inlineNodesBetween(from: ?Pos, to: ?Pos, f: fn(node: Node, path: [number], start: number, end: number, parent: Node)) 📄Calls the given function for each inline node between the two
given positions. Pass null for from or to to start or end at
the start or end of the node.
sliceBetween(from: ?Pos, to: ?Pos) → Node 📄Returns a copy of this node containing only the content between
from and to. You can pass null for either of them to start
or end at the start or end of the node.
marksAt(pos: Pos) → [Mark] 📄Get the marks of the node before the given position or, if that
position is at the start of a non-empty node, those of the node
after it.
rangeHasMark(from: ?Pos, to: ?Pos, type: MarkType) → bool 📄Test whether a mark of the given type occurs in this document
between the two given positions.
toString() → string 📄Return a string representation of this node for debugging
purposes.
toJSON() → Object 📄Return a JSON-serializeable representation of this node.
[Symbol.iterator]() → Iterator<Node> 📄A fragment is iterable, in the ES6 sense.
Static properties
fromJSON(schema: Schema, json: Object) → Node 📄Deserialize a node from its JSON representation.
A fragment is an abstract type used to represent a node's
collection of child nodes. It tries to hide considerations about
the actual way in which the child nodes are stored, so that
different representations (nodes that only contain simple nodes
versus nodes that also contain text) can be approached using the
same API.
Fragments are persistent data structures. That means you should
not mutate them or their content, but create new instances
whenever needed. The API tries to make this easy.
Properties
textContent: string 📄Concatenate all the text nodes found in this fragment and its
children.
size: number 📄The maximum offset in this fragment.
firstChild: ?Node 📄The first child of the fragment, or null if it is empty.
lastChild: ?Node 📄The last child of the fragment, or null if it is empty.
Methods
append(other: Fragment, joinLeft: ?number = 0, joinRight: ?number = 0) → Fragment 📄Create a fragment that combines this one with another fragment.
Takes care of merging adjacent text nodes and can also merge
“open” nodes at the boundary. joinLeft and joinRight give the
depth to which the left and right fragments are open. If open
nodes with the same markup are found on both sides, they are
joined. If not, the open nodes are closed.
toString() → string 📄Return a debugging string that describes this fragment.
toArray(from: ?number = 0, to: ?number = this.size, f: ?fn(Node) → Node) → [Node] 📄Produce an array with the child nodes between the given
boundaries, optionally mapping a function over them.
map(f: fn(Node) → Node) → Fragment 📄Produce a new Fragment by mapping all this fragment's children
through a function.
some(f: fn(Node) → bool) → bool 📄Returns true if the given function returned true for any of
the fragment's children.
sliceBetween(from: ?Pos, to: ?Pos) → Fragment 📄Slice out the sub-fragment between the two given positions.
null can be passed for either to indicate the slice should go
all the way to the start or end of the fragment.
iter(start: ?number = 0, end: ?number = this.size) → Iterator<Node> 📄Create a forward iterator over the content of the fragment. An
explicit start and end offset can be given to have the iterator
go over only part of the content. If an iteration bound falls
within a text node, only the part that is within the bounds is
yielded.
reverseIter(start: ?number = this.size, end: ?number = 0) → Iterator<Node> 📄Create a reverse iterator over the content of the fragment. An
explicit start and end offset can be given to have the iterator
go over only part of the content. Note: start should be
greater than end, when passed.
child(off: number) → Node 📄Get the child at the given offset. Might return a text node that
stretches before and/or after the offset.
forEach(f: fn(node: Node, start: number, end: number)) 📄Call the given function for each node in the fragment, passing it
the node, its start offset, and its end offset.
chunkBefore(off: number) → {start: number, node: Node} 📄Find the node before the given offset. Returns an object
containing the node as well as its start index. Offset should be
greater than zero.
chunkAfter(off: number) → {start: number, node: Node} 📄Find the node after the given offset. Returns an object
containing the node as well as its start index. Offset should be
less than the fragment's size.
slice(from: number, to: ?number = this.size) → Fragment 📄Return a fragment with only the nodes between the given offsets.
When to is not given, the slice will go to the end of the
fragment.
replace(offset: number, node: Node) → Fragment 📄Return a fragment in which the node at the given offset is
replaced by the given node. The node, as well as the one it
replaces, should not be text nodes.
toJSON() → Object 📄Create a JSON-serializeable representation of this fragment.
[Symbol.iterator]() → Iterator<Node> 📄A fragment is iterable, in the ES6 sense.
Static properties
fromJSON(schema: Schema, value: Object) → Fragment 📄Deserialize a fragment from its JSON representation.
fromArray(array: [Node]) → Fragment 📄Build a fragment from an array of nodes.
from(nodes: ?union<Fragment, Node, [Node]>) → Fragment 📄Create a fragment from something that can be interpreted as a set
of nodes. For null, it returns the empty fragment. For a
fragment, the fragment itself. For a node or array of nodes, a
fragment containing those nodes.
A mark is a piece of information that can be attached to a node,
such as it being emphasized, in code font, or a link. It has a type
and optionally a set of attributes that provide further information
(such as the target of the link). Marks are created through a
Schema, which controls which types exist and which
attributes they have.
Properties
type: MarkType 📄The type of this mark.
attrs: Object 📄The attributes associated with this mark.
Methods
toJSON() → Object 📄Convert this mark to a JSON-serializeable representation.
addToSet(set: [Mark]) → [Mark] 📄Given a set of marks, create a new set which contains this one as
well, in the right position. If this mark or another of its type
is already in the set, the set itself is returned.
removeFromSet(set: [Mark]) → [Mark] 📄Remove this mark from the given set, returning a new set. If this
mark is not in the set, the set itself is returned.
isInSet(set: [Mark]) → bool 📄Test whether this mark is in the given set of marks.
eq(other: Mark) → bool 📄Test whether this mark has the same type and attributes as
another mark.
Static properties
sameSet(a: [Mark], b: [Mark]) → bool 📄Test whether two sets of marks are identical.
setFrom(marks: ?union<Mark, [Mark]>) → [Mark] 📄Create a properly sorted mark set from null, a single mark, or an
unsorted array of marks.
Instances of the Pos class represent positions in a document.
A position is an array of integers that describe a path to the target
node (see Node.path) and an integer offset into that target node.
Constructor
new Pos(path: [number], offset: number) 📄
Properties
path: [number] 📄The path to the target node.
offset: number 📄The offset into the target node.
depth: number 📄The length of the position's path.
Methods
toString() 📄Return a string representation of the path of the form
"0/2:10", where the numbers before the colon are the path, and
the number after it is the offset.
max(other: Pos) → Pos 📄Return the greater of two positions.
min(other: Pos) → Pos 📄Return the lesser of two positions.
cmp(other: Pos) → number 📄Compares this position to another position, and returns a number.
Of this result number, only the sign is significant. It is
negative if this position is less than the other one, zero if
they are the same, and positive if this position is greater.
shorten(to: ?number = null, offset: ?number = 0) → Pos 📄Create a position pointing into a parent of this position's
target. When to is given, it determines the new length of the
path. By default, the path becomes one shorter. The offset
parameter can be used to determine where in this parent the
position points. By default, it points before the old target. You
can pass a negative or positive integer to move it backward or
forward (note: this method performs no bounds checking).
move(by: number) → Pos 📄Create a position with an offset moved relative to this
position's offset. For example moving 0/1:10 by -2 yields
0/1:8.
toPath(move: ?number = 0) → [number] 📄Convert this position to an array of numbers (including its
offset). Optionally pass an argument to adjust the value of the
offset.
isValid(doc: Node, requireTextblock: ?bool) → bool 📄Checks whether this position is valid in the given document. When
requireTextblock is true, only positions inside textblocks are
considered valid.
toJSON() → Object 📄Convert the position to a JSON-safe representation.
Static properties
samePath(pathA: [number], pathB: [number]) → bool 📄Compares two paths and returns true when they are the same.
from(array: [number], move: ?number = 0) → Pos 📄Build a position from an array of numbers (as in
toPath), taking the last element of the array as
offset and optionally moving it by move.
fromJSON(json: Object) → Pos 📄Create a position from a JSON representation.
Extends ProseMirrorError.
The exception type used to signal schema-related
errors.
The node and mark types
that make up a schema have several things in common—they support
attributes, and you can register values
with them. This class implements this functionality, and acts as a
superclass to those NodeType and MarkType.
Properties
attrs: Object<Attribute> 📄The set of attributes to associate with each node or mark of this
type.
Static properties
updateAttrs(attrs: Object<?Attribute>) 📄Add or remove attributes from this type. Expects an object
mapping names to either attributes (to add) or null (to remove
the attribute by that name).
register(namespace: string, name: string, value: any) 📄Register a value in this type's registry. Various components use
Schema.registry to query values from the marks and nodes that
make up the schema. The namespace, for example
"command", determines which component will see
this value. name is a name specific to this value. Its meaning
differs per namespace.
Subtypes inherit the registered values from their supertypes.
They can override individual values by calling this method to
overwrite them with a new value, or with null to disable them.
registerComputed(namespace: string, name: string, f: fn(SchemaItem) → any) 📄Register a value in this types's registry, like
register, but providing a function that
will be called with the actual node or mark type, whose return
value will be treated as the effective value (or will be ignored,
if null).
cleanNamespace(namespace: string) 📄By default, schema items inherit the
registered items from their superclasses.
Call this to disable that behavior for the given namespace.
Extends SchemaItem.
Node types are objects allocated once per Schema
and used to tag Node instances with a type. They are
instances of sub-types of this class, and contain information about
the node type (its name, its allowed attributes, methods for
serializing it to various formats, information to guide
deserialization, and so on).
Properties
name: string 📄The name the node type has in this schema.
schema: Schema 📄A link back to the Schema the node type belongs to.
isBlock: bool 📄True if this is a block type.
isTextblock: bool 📄True if this is a textblock type, a block that contains inline
content.
isInline: bool 📄True if this is an inline type.
isText: bool 📄True if this is the text node type.
selectable: bool 📄Controls whether nodes of this type can be selected (as a user
node selection).
draggable: bool 📄Determines whether nodes of this type can be dragged. Enabling it
causes ProseMirror to set a draggable attribute on its DOM
representation, and to put its HTML serialization into the drag
event's data
transfer
when dragged.
locked: bool 📄Controls whether this node type is locked.
contains: ?string 📄The kind of nodes this node may contain. null means it's a
leaf node.
canBeEmpty: bool 📄Controls whether this node is allowed to be empty.
containsMarks: union<bool, [string]> 📄The mark types that child nodes of this node may have. false
means no marks, true means any mark, and an array of strings
can be used to explicitly list the allowed mark types.
Methods
canContainFragment(fragment: Fragment) → bool 📄Test whether the content of the given fragment could be contained
in this node type.
canContain(node: Node) → bool 📄Test whether the given node could be contained in this node type.
canContainMark(mark: Mark) → bool 📄Test whether this node type can contain children with the given
mark.
canContainType(type: NodeType) → bool 📄Test whether this node type can contain nodes of the given node
type.
canContainContent(type: NodeType) → bool 📄Test whether the nodes that can be contained in the given node
type are a sub-type of the nodes that can be contained in this
type.
findConnection(other: NodeType) → ?[NodeType] 📄Find a set of intermediate node types, possibly empty, that have
to be inserted between this type and other to put a node of
type other into this type.
create(attrs: ?Object, content: ?Fragment, marks: ?[Mark]) → Node 📄Create a Node of this type. The given attributes are
checked and defaulted (you can pass null to use the type's
defaults entirely, if no required attributes exist). content
may be a Fragment, a node, an array of nodes, or
null. Similarly marks may be null to default to the empty
set of marks.
Static properties
kinds: string 📄Controls the kind of the node, which is used to determine valid
parent/child relations. Should be a single
name or space-separated string of kind names, where later names
are considered to be sub-kinds of former ones (for example
"textblock paragraph"). When you want to extend the superclass'
set of kinds, you can do something like
static get kinds() { return super.kind + " mykind" }
Extends NodeType.
Base type for block nodetypes.
Extends Block.
Base type for textblock node types.
Extends NodeType.
Base type for inline node types.
Extends Inline.
The text node type.
Attributes are named strings associated with nodes and marks.
Each node type or mark type has a fixed set of attributes, which
instances of this class are used to control.
Constructor
new Attribute(options: ?Object = {}) 📄Create an attribute. options is an object containing the
settings for the attributes. The following settings are
supported:
default: ?string- The default value for this attribute, to choose when no
explicit value is provided.
compute: ?(Fragment) → string- A function that computes a default value for the attribute from
the node's content.
label: ?string- A user-readable text label associated with the attribute.
Attributes that have no default or compute property must be
provided whenever a node or mark of a type that has them is
created.
Extends SchemaItem.
Like nodes, marks (which are associated with nodes to signify
things like emphasis or being part of a link) are tagged with type
objects, which are instantiated once per Schema.
Properties
name: string 📄The name of the mark type.
schema: Schema 📄The schema that this mark type instance is part of.
Methods
create(attrs: Object) → Mark 📄Create a mark of this type. attrs may be null or an object
containing only some of the mark's attributes. The others, if
they have defaults, will be added.
removeFromSet(set: [Mark]) → [Mark] 📄When there is a mark of this type in the given set, a new set
without it is returned. Otherwise, the input set is returned.
isInSet(set: [Mark]) → bool 📄Tests whether there is a mark of this type in the given set.
Static properties
rank: number 📄Mark type ranks are used to determine the order in which mark
arrays are sorted. (If multiple mark types end up with the same
rank, they still get a fixed order in the schema, but there's no
guarantee what it will be.)
A schema specification is a blueprint for an actual
Schema. It maps names to node and mark types, along
with extra information, such as additional attributes and changes
to node kinds and relations.
A specification consists of an object that associates node names
with node type constructors and another similar object associating
mark names with mark type constructors.
Constructor
new SchemaSpec(nodes: ?Object<NodeType>, marks: ?Object<MarkType>) 📄Create a schema specification from scratch. The arguments map
node names to node type constructors and mark names to mark type
constructors.
Methods
update(nodes: ?Object<?NodeType>, marks: ?Object<?MarkType>) → SchemaSpec 📄Base a new schema spec on this one by specifying nodes and marks
to add or remove.
When nodes is passed, it should be an object mapping type names
to either null, to delete the type of that name, or to a
NodeType subclass, to add or replace the node type of that
name.
Similarly, marks can be an object to add, change, or remove
mark types in the schema.
Each document is based on a single schema, which provides the
node and mark types that it is made up of (which, in turn,
determine the structure it is allowed to have).
Constructor
new Schema(spec: SchemaSpec) 📄Construct a schema from a specification.
Properties
spec: SchemaSpec 📄The specification on which the schema is based.
nodes: Object<NodeType> 📄An object mapping the schema's node names to node type objects.
marks: Object<MarkType> 📄A map from mark names to mark type objects.
cached: Object 📄An object for storing whatever values modules may want to
compute and cache per schema. (If you want to store something
in it, try to use property names unlikely to clash.)
Methods
node(type: union<string, NodeType>, attrs: ?Object, content: ?union<Fragment, Node, [Node]>, marks: ?[Mark]) → Node 📄Create a node in this schema. The type may be a string or a
NodeType instance. Attributes will be extended
with defaults, content may be a Fragment,
null, a Node, or an array of nodes.
When creating a text node, content should be a string and is
interpreted as the node's text.
This method is bound to the Schema, meaning you don't have to
call it as a method, but can pass it to higher-order functions
and such.
text(text: string, marks: ?[Mark]) → Node 📄Create a text node in the schema. This method is bound to the Schema.
defaultTextblockType() → ?NodeType 📄Return the default textblock type for this schema, or null if
it does not contain a node type with a defaultTextblock
property.
mark(name: string, attrs: ?Object) → Mark 📄Create a mark with the named type
nodeFromJSON(json: Object) → Node 📄Deserialize a node from its JSON representation. This method is
bound.
markFromJSON(json: Object) → Mark 📄Deserialize a mark from its JSON representation. This method is
bound.
nodeType(name: string) → NodeType 📄Get the NodeType associated with the given name in
this schema, or raise an error if it does not exist.
subKind(sub: string, sup: string) → bool 📄Test whether a node kind is a sub-kind of another kind.
registry(namespace: string, f: fn(value: any, source: union<NodeType, MarkType>, name: string), ?bool) 📄Retrieve all registered items under the given name from this
schema. The given function will be called with each item, the
element—node type or mark type—that it was associated with, and
that element's name in the schema.
Extends Block.
The default top-level document node type.
Extends Block.
The default blockquote node type.
Extends Block.
The default ordered list node type. Has a single attribute,
order, which determines the number at which the list starts
counting, and defaults to 1.
Extends Block.
The default bullet list node type.
Extends Block.
The default list item node type.
Extends Block.
The default horizontal rule node type.
Extends Textblock.
The default heading node type. Has a single attribute
level, which indicates the heading level, and defaults to 1.
Properties
maxLevel: number 📄Controls the maximum heading level. Has the value 6 in the
Heading class, but you can override it in a subclass.
Extends Textblock.
The default code block / listing node type. Only
allows unmarked text nodes inside of it.
Extends Textblock.
The default paragraph node type.
Extends Inline.
The default inline image node type. Has these
attributes:
src (required): The URL of the image.alt: The alt text.title: The title of the image.
Extends Inline.
The default hard break node type.
Extends MarkType.
The default emphasis mark type.
Extends MarkType.
The default strong mark type.
Extends MarkType.
The default link mark type. Has these attributes:
href (required): The link target.title: The link's title.
Extends MarkType.
The default code font mark type.
Extends ProseMirrorError.
Class used to signal model-related errors.
Functions
findDiffStart(a: Node, b: Node) → ?Pos 📄Find the first position at which nodes a and b differ, or
null if they are the same.
findDiffEnd(a: Node, b: Node) → ?{a: Pos, b: Pos} 📄Find the first position, searching from the end, at which nodes a
and b differ, or null if they are the same. Since this position
will not be the same in both nodes, an object with two separate
positions is returned.
Constants
emptyFragment: Fragment 📄An empty fragment. Intended to be reused whenever a node doesn't
contain anything (rather than allocating a new empty fragment for
each leaf node).
defaultSpec: SchemaSpec 📄The specification for the default schema.
defaultSchema: Schema 📄ProseMirror's default document schema.
This module defines a way to transform documents. Transforming
happens in Steps, which are atomic, well-defined modifications to
a document. Applying a step produces a new document
and a position map that maps positions in the old
document to position in the new document. Steps can be
inverted to create a step that undoes their effect,
and chained together in a convenience object called a Transform.
This module does not depend on the browser API being available
(i.e. you can load it into any JavaScript environment).
You can read more about transformations in this
guide.
These are the types of steps defined:
join- Join two block elements together.
from and to must point at
the end of the first and start of the second element (so that
the intention is preserved even when the positions are mapped).
split- Split a block node at
pos. The parameter, if given, may be
{type, ?attrs} object giving the node type and optionally the
attributes of the node created to hold the content after the
split.
ancestor- Change the stack of nodes that wrap the part of the document
between
from and to, which must point into the same parent
node.The set of ancestors to replace is determined by the depth
property of the step's parameter. If this is greater than
zero, from and to must point at the start and end of a
stack of nodes, of that depth, since this step will not split
nodes.The set of new ancestors to wrap with is determined by the
types and attrs properties of the parameter. The first
should be an array of NodeTypes, and the second, optionally,
an array of attribute objects.
replace- Delete the part of the document between
from and to and
optionally replace it with another chunk of content. pos must
point at the ‘root’ at which the cut starts—a position between
and above from and to.When new content is to be inserted, the step's parameter should
be an object of shape {content:Fragment, openLeft: number, openRight: number}. The step will insert the
given content at the root of the cut, and openLeft and
openRight indicate how much of the content on both sides
should be consided ‘open’.A replace step will try to join open nodes on both sides of the
cut. That is, nodes in the original document that are partially
cut off by from and to, and nodes at the sides of the
replacement content as specificed by openLeft and
openRight. For example, if openLeft is 2, the first node of
the replacement content as well as its first child is
considered open. Whenever two open nodes with the same
markup end up next to each other, they are
joined. Open nodes that aren't joined are closed
to ensure their content (or lack of it) is valid.
addMark- Add the
Mark given as the step's parameter to all
inline content between from and to (when allowed).
removeMark- Remove the
Mark given as the step's parameter from all inline
content between from and to.
A step object wraps an atomic operation. It generally applies
only to the document it was created for, since the positions
associated with it will only make sense for that document.
Constructor
new Step(type: string, from: ?Pos, to: ?Pos, pos: ?Pos, param: ?any = null) 📄Build a step. The type should name a defined step
type, and the shape of the positions and parameter should be
appropriate for that type.
Properties
type: string 📄The type of the step.
from: ?Pos 📄The start of the step's range, if any. Which of the three
optional positions associated with a step a given step type
uses differs. The way each of these positions is mapped when
the step is mapped over a position mapping depends
on its role.
to: ?Pos 📄The end of the step's range.
pos: ?Pos 📄The base position for this step.
param: ?any 📄Extra step-type-specific information associated with the step.
Methods
apply(doc: Node) → ?StepResult 📄Applies this step to the given document, returning a result
containing the transformed document (the input document is not
changed) and a PosMap. If the step could not meaningfully be
applied to the given document, this returns null.
invert(oldDoc: Node, map: PosMap) → Step 📄Create an inverted version of this step. Needs the document as it
was before the step, as well as PosMap created by applying the
step to that document, as input.
map(remapping: Mappable) → ?Step 📄Map this step through a mappable thing, returning either a
version of that step with its positions adjusted, or null if
the step was entirely deleted by the mapping.
toJSON() → Object 📄Create a JSON-serializeable representation of this step.
Static properties
fromJSON(schema: Schema, json: Object) → Step 📄Deserialize a step from its JSON representation.
define(type: string, implementation: Object) 📄Define a new type of step. Implementation should have the
following properties:
apply`(doc: Node, step: Step) → ?StepResult- Applies the step to a document.
invert`(step: Step, oldDoc: Node, map: PosMap) → Step
- Create an inverted version of the step.
paramToJSON`(param: ?any) → ?Object
- Serialize this step type's parameter to JSON.
paramFromJSON`(schema: Schema, json: ?Object) → ?any
- Deserialize this step type's parameter from JSON.
Objects of this type are returned as the result of
applying a transform step to a document.
Properties
doc: Node 📄The transformed document.
map: PosMap 📄The position map that describes the correspondence between the
old and the new document.
There are various things that positions can be mapped through.
We'll denote those as 'mappable'. This is not an actual class in
the codebase, only an agreed-on interface.
map(pos: Pos, bias: ?number) → MapResult 📄Map a position through this object. When given, the bias
determines in which direction to move when a chunk of content is
inserted at or around the mapped position.
A position map, holding information about the way positions in
the pre-step version of a document correspond to positions in the
post-step version. This class implements Mappable.
Methods
map(pos: Pos, bias: ?number) → MapResult 📄Map the given position through this map. The bias parameter can
be used to control what happens when the transform inserted
content at (or around) this position—if bias is negative, the a
position before the inserted content will be returned, if it is
positive, a position after the insertion is returned.
invert() → PosMap 📄Create an inverted version of this map. The result can be used to
map positions in the post-step document to the pre-step document.
The return value of mapping a position.
Properties
pos: Pos 📄The mapped version of the position.
deleted: bool 📄Tells you whether the position was deleted, that is,
whether the step removed its surroundings from the document.
A remapping represents a pipeline of zero or more mappings. It
is a specialized data structured used to manage mapping through a
series of steps, typically including inverted and non-inverted
versions of the same step. (This comes up when ‘rebasing’ steps for
collaboration or history management.) This class implements
Mappable.
Constructor
new Remapping(head: ?[PosMap] = [], tail: ?[PosMap] = []) 📄
Properties
head: [PosMap] 📄The maps in the head of the mapping are applied to input
positions first, back-to-front. So the map at the end of this
array (if any) is the very first one applied.
Methods
addToFront(map: PosMap, corr: ?number) → number 📄Add a map to the mapping's front. If this map is the mirror image
(produced by an inverted step) of another map in this mapping,
that map's id (as returned by this method or
addToBack) should be passed as a second
parameter to register the correspondence.
addToBack(map: PosMap, corr: ?number) → number 📄Add a map to the mapping's back. If the map is the mirror image
of another mapping in this object, the id of that map should be
passed to register the correspondence.
map(pos: Pos, bias: ?number) → MapResult 📄Map a position through this remapping, optionally passing a bias
direction.
A change to a document often consists of a series of
steps. This class provides a convenience abstraction to
build up and track such an array of steps. A Transform object
implements Mappable.
The high-level transforming methods return the Transform object
itself, so that they can be chained.
new Transform(doc: Node) 📄Create a transformation that starts with the given document.
steps: [Step] 📄The accumulated steps.
docs: [Node] 📄The individual document versions. Always has a length one more
than steps, since it also includes the original starting
document.
maps: [PosMap] 📄The position maps produced by the steps. Has the same length as
steps.
doc: Node 📄The current version of the transformed document.
before: Node 📄The original input document.
step(step: Step) → ?StepResult 📄Add a step to this transformation. If the step can be
applied to the current document, the result of
applying it is returned, and an element is added to the
steps, docs, and
maps arrays.
map(pos: Pos, bias: ?number) → MapResult 📄Map a position through the whole transformation (all the position
maps in maps), and return the result.
join(at: Pos) → Transform 📄Join the blocks around the given position.
split(pos: Pos, depth: ?number = 1, typeAfter: ?NodeType, attrsAfter: ?Object) → Transform 📄Split the node at the given position, and optionally, if depth is
greater than one, any number of nodes above that. By default, the part
split off will inherit the node type of the original node. This can
be changed by passing typeAfter and attrsAfter.
splitIfNeeded(pos: Pos, depth: ?number = 1) → Transform 📄Split at the given position, if that position isn't already at
the start or end of a node. If depth is greater than one, also do
so for parent positions above the given position.
lift(from: Pos, to: ?Pos = from) → Transform 📄Lift the nearest liftable ancestor of the sibling
range of the given positions out of its
parent (or do nothing if no such node exists).
wrap(from: Pos, to: ?Pos, type: NodeType, wrapAttrs: ?Object) → Transform 📄Wrap the sibling range of the given positions
in a node of the given type, with the given attributes (if
possible).
setBlockType(from: Pos, to: ?Pos, type: NodeType, attrs: ?Object) → Transform 📄Set the type of all textblocks (partly) between from and to to
the given node type with the given attributes.
setNodeType(pos: Pos, type: NodeType, attrs: ?Object) → Transform 📄Change the type and attributes of the node after pos.
delete(from: Pos, to: Pos) → Transform 📄Delete the content between the given positions.
replace(from: Pos, to: Pos, source: Node, start: Pos, end: Pos) → Transform 📄Replace the part of the document between from and to with the
part of the source between start and end.
replaceWith(from: Pos, to: Pos, content: union<Fragment, Node, [Node]>) → Transform 📄Replace the given range with the given content, which may be a
fragment, node, or array of nodes.
insert(pos: Pos, content: union<Fragment, Node, [Node]>) → Transform 📄Insert the given content at the pos.
insertText(pos: Pos, text: string) → Transform 📄Insert the given text at pos, inheriting the marks of the
existing content at that position.
insertInline(pos: Pos, node: Node) → Transform 📄Insert the given node at pos, inheriting the marks of the
existing content at that position.
addMark(from: Pos, to: Pos, mark: Mark) → Transform 📄Add the given mark to the inline content between from and to.
removeMark(from: Pos, to: Pos, mark: ?union<Mark, MarkType> = null) → Transform 📄Remove the given mark, or all marks of the given type, from inline
nodes between from and to.
clearMarkup(from: Pos, to: Pos, newParent: ?NodeType) → Transform 📄Remove all marks and non-text inline nodes, or if newParent is
given, all marks and inline nodes that may not appear as content of
newParent, from the given range.
joinableBlocks(doc: Node, pos: Pos) → bool 📄Test whether the blocks before and after a given position can be
joined.
joinPoint(doc: Node, pos: Pos, dir: ?number = -1) → ?Pos 📄Find an ancestor of the given position that can be joined to the
block before (or after if dir is positive). Returns the joinable
point, if any.
canLift(doc: Node, from: Pos, to: ?Pos) → bool 📄Tells you whether the given positions' sibling
range, or any of its ancestor nodes, can be
lifted out of a parent.
canWrap(doc: Node, from: Pos, to: ?Pos, type: NodeType) → bool 📄Determines whether the sibling range of the
given positions can be wrapped in the given node type.
This module provides a way to register and access functions that
serialize and parse ProseMirror documents to and from
various formats, along with the basic formats required to run the
editor.
These are the formats defined by this module:
"json"- Uses
Node.toJSON and Schema.nodeFromJSON to convert a
document to and from JSON.
"dom"- Parses DOM
Nodes,
serializes to a DOM
fragment.
See
toDOM and fromDOM.
"html"- Serialize to and parse from HTML text. See
toHTML and fromHTML.
"text"- Convert to and from plain text. See
toText and fromText.
The markdown module in the distribution defines an additional format:
"markdown"- Convert to and from CommonMark marked-up
text. See
toMarkdown and fromMarkdown.
To define the way node and mark types are
parsed, you can associate one or more DOM parsing specifications to
them using the register method with the
"parseDOM" namespace, using the HTML node name (lowercase) as
value name. Each of them defines a parsing strategy for a certain
type of DOM node. When "_" is used as name, the parser is
activated for all nodes.
rank: ?number 📄The precedence of this parsing strategy. Should be a number between
0 and 100, which determines when this parser gets a chance relative
to others that apply to the node (low ranks go first). Defaults to
parse: union<string, fn(dom: DOMNode, state: DOMParseState) → ?bool> 📄The function that, given a DOM node, parses it, updating the parse
state. It should return (the exact value) false when it wants to
indicate that it was not able to parse this node. This function is
called in such a way that this is bound to the type that the
parse spec was associated with.
When this is set to the string "block", the content of the DOM
node is parsed as the content in a node of the type that this spec
was associated with.
When set to the string "mark", the content of the DOM node is
parsed with an instance of the mark that this spec was associated
with added to their marks.
A state object used to track context during a parse,
and to expose methods to custom parsing functions.
Properties
options: Object 📄The options passed to this parse.
schema: Schema 📄The schema that we are parsing into.
Methods
insert(type: DOMNode, attrs: NodeType, content: ?Object, [Node]) → Node 📄Insert a node of the given type, with the given content, based on
dom, at the current position in the document.
wrapIn(dom: DOMNode, type: NodeType, attrs: ?Object) 📄Parse the contents of dom as children of a node of the given
type.
wrapMark(inner: DOMNode, mark: Mark) 📄Parse the contents of dom, with mark added to the set of
current marks.
Object used to to expose relevant values and methods
to DOM serializer functions.
Properties
options: Object 📄The options passed to the serializer.
doc: DOMDocument 📄The DOM document in which we are working.
Methods
elt(type: string, attrs: ?Object, ...content: union<string, DOMNode>) → DOMNode 📄Create a DOM node of the given type, with (optionally) the given
attributes and content. Content elements may be strings (for text
nodes) or other DOM nodes.
renderAs(node: Node, tagName: string, tagAttrs: ?Object) → DOMNode 📄Render the content of ProseMirror node into a DOM node with the
given tag name and attributes.
serializeTo(doc: Node, format: string, options: ?Object) → any 📄Serialize the given document to the given format. If options is
given, it will be passed along to the serializer function.
knownTarget(format: string) → bool 📄Query whether a given serialization format has been registered.
defineTarget(format: string, func: fn(Node, ?Object) → any) 📄Register a function as the serializer for format.
parseFrom(schema: Schema, value: any, format: string, options: ?Object) → Node 📄Parse document value from the format named by format. If
options is given, it is passed along to the parser function.
knownSource(format: string) → bool 📄Query whether a parser for the named format has been registered.
defineSource(format: string, func: fn(Schema, any, ?Object) → Node) 📄Register a parser function for format.
fromDOM(schema: Schema, dom: DOMNode, options: ?Object) → Node 📄Parse document from the content of a DOM node. To pass an explicit
parent document (for example, when not in a browser window
environment, where we simply use the global document), pass it as
the document property of options.
fromHTML(schema: Schema, html: string, options: ?Object) → Node 📄Parses the HTML into a DOM, and then calls through to fromDOM.
toDOM(node: Node, options: ?Object) → DOMFragment 📄Serialize the content of the given node to a DOM fragment. When not
in the browser, the document option, containing a DOM document,
should be passed so that the serialize can create nodes.
To define rendering behavior for your own node and
mark types, give them a serializeDOM method. This
method is passed a Node and a DOMSerializer, and should return
the DOM
node that
represents this node and its content. For marks, that should be an
inline wrapping node like <a> or <strong>.
Individual attributes can also define serialization behavior. If an
Attribute object has a serializeDOM method, that will be called
with the DOM node representing the node that the attribute applies
to and the atttribute's value, so that it can set additional DOM
attributes on the DOM node.
nodeToDOM(node: Node, options: ?Object) → DOMNode 📄Serialize a given node to a DOM node. This is useful when you need
to serialize a part of a document, as opposed to the whole
document.
toHTML(node: Node, options: ?Object) → string 📄Serialize a node as an HTML string. Goes through toDOM and then
serializes the result. Again, you must pass a document option
when not in the browser.
fromText(schema: Schema, text: string) → Node 📄Convert a string into a simple ProseMirror document.
toText(doc: Node) → string 📄Serialize a node as a plain text string.
Defines a parser and serializer for
CommonMark text (registered in the
format module under "markdown").
Schema-specific parsing logic can be defined
registering values with parsing information
on mark and node types, using the
"parseMarkdown" namespace.
The name of the registered item should be the
markdown-it token
name that the parser should respond to,
To influence the way the markdown-it parser is initialized and
configured, you can register values under the "configureMarkdown"
namespace. An item with the name "init" will be called to
initialize the parser. Items with other names will be called with a
parser and should return a parser. You could for example configure
a subscript mark to enable the subscript
plugin:
SubMark.register("configureMarkdown", "sub", parser => {
return parser.use(require("markdown-it-sub"))
})
parse: union<string, fn(state: MarkdownParseState, token: MarkdownToken) → Node> 📄The parsing function for this token. It is, when a matching token
is encountered, passed the parsing state and the token, and must
return a Node if the parsing spec was for a node type, and a
Mark if it was for a mark type.
The function will be called so that this is bound to the node or
mark type instance that the spec was associated with.
As a shorthand, parse can be set to a string. You can use
"block" to create a node of the type that this spec was
associated with, and wrap the content between the open and close
tokens in this node.
Alternatively, it can be set to "mark", if the spec is associated
with a mark type, which will cause the content between
the opening and closing token to be marked with an instance of that
mark type.
attrs: ?union<Object, fn(MarkdownParseState, MarkdownToken) → Object> 📄When parse is set to a string, this property can be used to
specify attributes for the node or mark. It may hold an object or a
function that, when called with the parser
state and the token object, returns an
attribute object.
Object used to track the context of a running parse,
and to expose parsing-related methods to node-specific parsing
functions.
Properties
schema: Schema 📄The schema into which we are parsing.
Methods
addText(text: string) 📄Adds the given text to the current position in the document,
using the current marks as styling.
openMark(mark: Mark) 📄Adds the given mark to the set of active marks.
closeMark(mark: Mark) 📄Removes the given mark from the set of active marks.
addNode(type: NodeType, attrs: ?Object, content: ?[Node]) → Node 📄Add a node at the current position.
openNode(type: NodeType, attrs: ?Object) 📄Wrap subsequent content in a node of the given type.
closeNode() → Node 📄Close and return the node that is currently on top of the stack.
getAttr(tok: MarkdownToken, name: string) → any 📄Retrieve the named attribute from the given token.
This is an object used to track state and expose
methods related to markdown serialization. Instances are passed to
node and mark serialization methods (see toMarkdown).
Methods
wrapBlock(delim: string, firstDelim: ?string, node: Node, f: fn()) 📄Render a block, prefixing each line with delim, and the first
line in firstDelim. node should be the node that is closed at
the end of the block, and f is a function that renders the
content of the block.
ensureNewLine() 📄Ensure the current content ends with a newline.
write(content: ?string) 📄Prepare the state for writing output (closing closed paragraphs,
adding delimiters, and so on), and then optionally add content
(unescaped) to the output.
closeBlock(node: Node) 📄Close the block for the given node.
text(text: string, escape: ?bool) 📄Add the given text to the document. When escape is not false,
it will be escaped.
render(node: Node) 📄Render the given node as a block.
renderContent(parent: Node) 📄Render the contents of parent as block nodes.
renderInline(parent: Node) 📄Render the contents of parent as inline content.
esc(str: string, startOfLine: ?bool) → string 📄Escape the given string so that it can safely appear in Markdown
content. If startOfLine is true, also escape characters that
has special meaning only at the start of the line.
repeat(str: string, n: number) → string 📄Repeat the given string n times.
Functions
fromMarkdown(schema: Schema, text: string) → Node 📄Parse a string as CommonMark markup, and
create a ProseMirror document corresponding to its meaning. Note
that, by default, some CommonMark features, namely inline HTML and
tight lists, are not supported.
toMarkdown(doc: Node) → string 📄Serialize the content of the given node to CommonMark.
To define serialization behavior for your own node
types, give them a serializeMarkDown method. It will
be called with a MarkdownSerializer and a Node, and should
update the serializer's state to add the content of the node.
Mark types can define openMarkdown and
closeMarkdown properties, which provide the markup text that
marked content should be wrapped in. They may hold either a string
or a function from a MarkdownSerializer and a Mark to a string.
This module defines a way to attach ‘input rules’ to an editor,
which can react to or transform text typed by the user. It also
comes with a bunch of default rules that can be enabled with the
autoInput option.
autoInput: union<bool, [union<string, Object<?InputRule>>]> 📄Controls the input rules initially active in the
editor. Pass an array of sources, which can be either the string
"schema", to add rules registered on the
schema items (under the namespace "autoInput"), or an object
containing input rules. To remove previously included rules, you
can add an object that maps their name to null.
The value false (the default) is a shorthand for no input rules,
and the value true for ["schema", autoInputRules].
Input rules are regular expressions describing a piece of text
that, when typed, causes something to happen. This might be
changing two dashes into an emdash, wrapping a paragraph starting
with "> " into a blockquote, or something entirely different.
new InputRule(match: RegExp, filter: ?string, handler: union<string, fn(ProseMirror, [string], Pos)>) 📄Create an input rule. The rule applies when the user typed
something and the text directly in front of the cursor matches
match, which should probably end with $. You can optionally
provide a filter, which should be a single character that always
appears at the end of the match, and will be used to only apply
the rule when there's an actual chance of it succeeding.
The handler can be a string, in which case the matched text
will simply be replaced by that string, or a function, which will
be called with the match array produced by
RegExp.exec,
and should produce the effect of the rule.
addInputRule(pm: ProseMirror, rule: InputRule) 📄Add the given input rule to an editor. From now on,
whenever the rule's pattern is typed, its handler is activated.
Note that the effect of an input rule can be canceled by pressing
Backspace right after it happens.
removeInputRule(pm: ProseMirror, rule: InputRule) 📄Remove the given rule (added earlier with addInputRule) from the
editor.
autoInputRules: Object<InputRule> 📄Base set of input rules, enabled by default when autoInput is set
to true.
When given a truthy value, enables the menu bar module for this
editor. The menu bar takes up space above the editor, showing
currently available commands (that have been
added to the menu). To configure the
module, you can pass a configuration object, on which the following
properties are supported:
float: bool = false- When enabled, causes the menu bar to stay visible when the
editor is partially scrolled out of view, by making it float at
the top of the viewport.
groups: [string] = ["inline", "insert", "block", "history"]- Determines the menu groups that are shown in the menu bar.
items: [union<string, [string]>]- Can be used to, rather than getting the commands to display
from menu groups, explicitly provide the full list of commands.
If nested arrays are used, separators will be shown between
items from different arrays.
When given a truthy value, enables the tooltip menu module for this
editor. This menu shows up when there is a selection, and
optionally in certain other circumstances, providing
context-relevant commands.
By default, the tooltip will show inline menu commands (registered
with the menuGroup command property)
when there is an inline selection, and block related commands when
there is a node selection on a block.
The module can be configured by passing an object. These properties
are recognized:
showLinks: bool = true- Causes a tooltip with the link target to show up when the
cursor is inside of a link (without a selection).
selectedBlockMenu: bool = false`- When enabled, and a whole block is selected or the cursor is
inside an empty block, the block menu gets shown.
inlineGroups: [string] = ["inline", "insert"]- The menu groups to show when displaying the menu for inline
content.
inlineItems: [union<string, [string]>]- Instead of using menu groups, this can be used to completely
override the set of commands shown for inline content. If
nested arrays are used, separators will be shown between items
from different arrays.
blockGroups: [string] = ["insert", "block"]- The menu groups to show when displaying the menu for block
content.
blockItems: [union<string, [string]>]- Overrides the commands shown for block content.
The menu module gives meaning to two additional properties of
command specs.
menuGroup: string 📄Adds the command to the menugroup with the given name. The value
may either be just a name (for example "inline" or "block"), or
a name followed by a parenthesized rank ("inline(40)") to control
the order in which the commands appear in the group (from low to
high, with 50 as default rank).
display: Object 📄Determines how a command is shown in the menu. The object should
have a type property, which picks a style of display. These types
are supported:
"icon"- Show the command as an icon. The object may have
{path, width, height} properties, where path is an SVG path
spec,
and width and height provide the viewbox in which that path
exists. Alternatively, it may have a text property specifying
a string of text that makes up the icon, with an optional
style property giving additional CSS styling for the text.
"param"- Render command based on its first and only
parameter, and immediately execute the
command when the parameter is changed. Currently only works for
"select" parameters.
paramTypes: Object<{render: fn(param: CommandParam, value: any) → DOMNode, read: fn(node: DOMNode) → any}> 📄A collection of default renderers and readers for parameter
types, which parameter
handlers can optionally use to prompt for
parameters. render should create a form field for the parameter,
and read should, given that field, return its value.
Used to show tooltips. An instance of this class is a persistent
DOM node (to allow position and opacity animation) that can be
shown and hidden. It is positioned relative to a position (passed
when showing the tooltip), and points at that position with a
little arrow-like triangle attached to the node.
new Tooltip(wrapper: DOMNode, dir: string) 📄Create a new tooltip that lives in the wrapper node, which should
be its offset anchor, i.e. it should have a relative or
absolute CSS position. You'll often want to pass an editor's
wrapper node. dir may be "above",
"below", "right", "left", or "center". In the latter
case, the tooltip has no arrow and is positioned centered in its
wrapper node.
detach() 📄Remove the tooltip from the DOM.
open(node: DOMNode, pos: ?{left: number, top: number}) 📄Make the tooltip visible, show the given node in it, and position
it relative to the given position. If pos is not given, the
tooltip stays in its previous place. Unless the tooltip's
direction is "center", pos should definitely be given the
first time it is shown.
close() 📄Close (hide) the tooltip.
Helper for scheduling updates whenever any of a series of events
happen.
Constructor
new UpdateScheduler(pm: ProseMirror, events: string, start: fn() → ?fn()) 📄Creates an update scheduler for the given editor. events should
be a space-separated list of event names (for example
"selectionChange change"). start should be a function as
expected by scheduleDOMUpdate.
Methods
detach() 📄Detach the event handlers registered by this scheduler.
force() 📄Force an update. Note that if the editor has scheduled a flush,
the update is still delayed until the flush occurs.
Functions
scheduleDOMUpdate(pm: ProseMirror, f: fn() → ?fn() → ?fn()) 📄Schedule a DOM update function to be called either the next time
the editor is flushed, or if no flush happens
immediately, after 200 milliseconds. This is used to synchronize
DOM updates and read to prevent DOM layout
thrashing.
Often, your updates will need to both read and write from the DOM.
To schedule such access in lockstep with other modules, the
function you give can return another function, which may return
another function, and so on. The first call should write to the
DOM, and not read. If a read needs to happen, that should be
done in the function returned from the first call. If that has to
be followed by another write, that should be done in a function
returned from the second function, and so on.
unscheduleDOMUpdate(pm: ProseMirror, f: fn() → ?fn() → ?fn()) 📄Cancel an update scheduled with scheduleDOMUpdate. Calling this with
a function that is not actually scheduled is harmless.
This module implements an API into which a communication channel
for collaborative editing can be hooked. See this
guide for more details and an example.
:: ?Object #path=collab #kind=option
When given, enables the collaborative editing framework for the
editor. Will register itself of the Collab class as
.mod.collab.
If the object given has a version property, that will determine
the starting version number of the collaborative editing.
Options
collab: ?Object 📄When given, enables the collaborative editing framework for the
editor. Will register itself of the Collab class as
.mod.collab.
If the object given has a version property, that will determine
the starting version number of the collaborative editing.
This class accumulates changes that have to be sent to the
central authority in the collaborating group, signals an event when
it has something to send, and makes it possible to integrate
changes made by peers into our local document. It is created and
attached to the editor (under .mod.collab) by setting the
collab option.
Includes the event mixin.
Properties
version: number 📄The version number of the last update received from the central
authority. Starts at 0 or the value of the version property
in the option object, for the editor's value when the option
was enabled.
Methods
hasSendableSteps() → bool 📄Reports whether the editor has any unsent steps.
sendableSteps() → {version: number, doc: Node, steps: [Step]} 📄Provides the data describing the editor's unconfirmed steps. The
version and array of steps are the things you'd send to the
central authority. The whole return value must be passed to
confirmSteps when the steps go through.
confirmSteps(sendable: {version: number, doc: Node, steps: [Step]}) 📄Tells the module that a set of unconfirmed steps have been
accepted by the central authority, and can now be considered
confirmed.
receive(steps: [Step]) → [PosMap] 📄Pushes a set of steps (made by peers and received from the
central authority) into the editor. This will rebase any
unconfirmed steps over these steps.
Returns the position maps produced by applying the
steps.
Events
mustSend() 📄Fired when there are new steps to send to the central
authority. Consumers should respond by calling
sendableSteps and pushing those to the authority.
A set of methods for objects that emit events. Added by calling
eventMixin on a constructor.
on(type: string, handler: fn(...args: [any])) 📄Register an event handler for the given event type.
off(type: string, handler: fn(...args: [any])) 📄Unregister an event handler for the given event type.
signal(type: string, ...args: [any]) 📄Signal an event of the given type, passing any number of
arguments. Will call the handlers for the event, passing them the
arguments.
signalHandleable(type: string, ...args: [any]) 📄Signal a handleable event of the given type. All handlers for the
event will be called with the given arguments, until one of them
returns something that is not the value false. When that
happens, the return value of that handler is returned. If that
does not happen, false is returned.
hasHandler(type: string) → bool 📄Query whether there are any handlers for this event type.
Functions
eventMixin(ctor: fn()) 📄Add the methods in the EventMixin interface to the prototype
object of the given constructor.
Constants
methods
Extends Error.
Superclass for ProseMirror-related errors. Does some magic to
make it safely subclassable even on ES5 runtimes.
Constructor
new ProseMirrorError(message: string) 📄Create an instance of this error type, capturing the current
stack.
Static properties
raise(message: string) 📄Raise an exception of this type, with the given message.
(Somewhat shorter than throw new ..., and can appear in
expression position.)
Extends ProseMirrorError.
Error type used to signal miscellaneous invariant violations.
Extends ProseMirrorError.
Error type used to report name clashes or other violations in
namespacing.