mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-02-20 07:04:39 +01:00
Code Issues Releases Wiki Activity

docs: Try putting options in a list in Transforms API for better readability

Browse Source
This commit is contained in:
Sunny Hirai 2021-05-25 20:00:13 -07:00
parent 7e736c9138
commit b3784e451d
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api/transforms.md
View File

@ -68,9 +68,8 @@ Wrap nodes at the specified location in the `element` container. If no location
Options supported: `NodeOptions & {split?: boolean}`.
For `options.mode`, `'all'` is also supported.
The `options.split` option indicates that it's okay to split a node in order to wrap the location. For example, if `ipsum` was selected in a `Text` node with `lorem ipsum dolar`, `split: true` would wrap the word `ipsum` only, resulting in splitting the `Text` node. If `split: false`, the entire `Text` node `lorem ipsum dolar` would be wrapped.
- `options.mode`: `'all'` is also supported.
- `options.split` indicates that it's okay to split a node in order to wrap the location. For example, if `ipsum` was selected in a `Text` node with `lorem ipsum dolar`, `split: true` would wrap the word `ipsum` only, resulting in splitting the `Text` node. If `split: false`, the entire `Text` node `lorem ipsum dolar` would be wrapped.
#### `Transforms.unwrapNodes(editor: Editor, options?)`