mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-18 21:21:21 +02:00
Code Issues Releases Wiki Activity

Add documentation for options.split in Transforms.wrapNodes

Browse Source
This commit is contained in:
Sunny Hirai
2021-05-21 18:23:33 -07:00
parent b5f3678a05
commit 29051c8fc0
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/transforms.md
View File

@@ -62,7 +62,11 @@ Options supported: `NodeOptions & {height?: number, always?: boolean}`
Wrap nodes at the specified location in the `element` container. If no location is specified, wrap the selection.
Options supported: `NodeOptions & {split?: boolean}`. For `options.mode`, `'all'` is also supported.
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.
#### `Transforms.unwrapNodes(editor: Editor, options?)`