diff --git a/docs/api/transforms.md b/docs/api/transforms.md index 11de3c4e7..31b4620fb 100644 --- a/docs/api/transforms.md +++ b/docs/api/transforms.md @@ -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?)`