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

Updates docs/reference/models/transform.md (#525)

Browse Source 
Auto commit by GitBook Editor
This commit is contained in:
Sunny Hirai 2016-12-16 18:14:36 -08:00 committed by Ian Storm Taylor
parent 1dbfea4499
commit d3095145da
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference/models/transform.md
View File

@ -13,6 +13,7 @@ Transform methods can either operate on the [`Document`](./document.md), the [`S
- [Methods](#methods)
- [`apply`](#apply)
- [`call`](#call)
- [Current State Transforms](#current-state-transforms)
- [`deleteBackward`](#deletebackward)
- [`deleteForward`](#deleteforward)
@ -96,6 +97,23 @@ Applies all of the current transform steps, returning the newly transformed [`St
- `save: Boolean` — override the editor's built-in logic of whether to create a new snapshot in the history, that can be reverted to later.
### `call`
`call(customTransform: Function, ...arguments) => Transform`
This method calls the provided function argument `customTransform` with the current instance of the `Transform` object as the first argument and passes through the remaining arguments.
The function signature for `customTransform` is:
`customTransform(transform: Transform, ...arguments)`
The purpose of `call` is to enable custom transform methods to exist and called in a chain. For example:
```
return state.transform()
.call(myCustomInsertTableTransform, columns, rows)
.focus()
.apply()
```
## Current State Transforms