main
Walkthroughs
Concepts
Commands
While editing richtext content, your users will be doing things like inserting text, deleting text, splitting paragraphs, adding formatting, etc. Under the cover these edits are expressed using transforms and operations. But at a high level we talk about them as "commands".
Commands are the high-level actions that represent a specific intent of the user. They are represented as helper functions on the
Editor interface. A handful of helpers are included in core for common richtext behaviors, but you are encouraged to write your own that model your specific domain.For example, here are some of the built-in commands:
1
Editor.insertText(editor, 'A new string of text to be inserted.')
2
​
3
Editor.deleteBackward(editor, { unit: 'word' })
4
​
5
Editor.insertBreak(editor)
Copied!
But you can (and will!) also define your own custom commands that model your domain. For example, you might want to define a
formatQuote command, or an insertImage command, or a toggleBold command depending on what types of content you allow.Commands always describe an action to be taken as if the user was performing the action. For that reason, they never need to define a location to perform the command, because they always act on the user's current selection.
🤖 The concept of commands is loosely based on the DOM's built-inexecCommandAPIs. However Slate defines its own simpler (and extendable!) version of the API, because the DOM's version is too opinionated and inconsistent.
Under the covers, Slate takes care of converting each command into a set of low-level "operations" that are applied to produce a new value. This is what makes collaborative editing implementations possible. But you don't have to worry about that, because it happens automatically.
Custom Commands
When defining custom commands, you can create your own namespace:
1
const MyEditor = {
2
...Editor,
3
​
4
insertParagraph(editor) {
5
// ...
6
},
7
}
Copied!
When writing your own commands, you'll often make use of the
Transforms helpers that ship with Slate.Transforms
Transforms are a specific set of helpers that allow you to perform a wide variety of specific changes to the document, for example:
1
// Set a "bold" format on all of the text nodes in a range.
2
Transforms.setNodes(
3
editor,
4
{ bold: true },
5
{
6
at: range,
7
match: node => Text.isText(node),
8
split: true,
9
}
10
)
11
​
12
// Wrap the lowest block at a point in the document in a quote block.
13
Transforms.wrapNodes(
14
editor,
15
{ type: 'quote', children: [] },
16
{
17
at: point,
18
match: node => Editor.isBlock(editor, node),
19
mode: 'lowest',
20
}
21
)
22
​
23
// Insert new text to replace the text in a node at a specific path.
24
Transforms.insertText(editor, 'A new string of text.', { at: path })
25
​
26
// ...there are many more transforms!
Copied!
The transform helpers are designed to be composed together. So you might use a handful of them for each command.
Last modified 1yr ago
Copy link