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

Flesh out docs for Slate History with methods

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-11 18:35:58 -07:00
parent 7b5949ccc9
commit 5f56c2bc26
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/history/history.md
View File

@@ -2,6 +2,10 @@
The `History` object contains the undo and redo history for the editor.
It can be accessed from an `Editor` instance as the property `history`.
This property is only available on the `Editor` if the editor was instantiated using the `withHistory` method which adds undo/redo functionality to the Slate editor.
```typescript
export interface History {
redos: Batch[]
@@ -14,6 +18,10 @@ interface Batch {
}
```
It can be accessed from an `Editor` instance as the property `history`.
- [Static Methods](history.md#static-methods)
This property is only available on the `Editor` if it was instantiated using the `withHistory` method which adds undo/redo functionality to the Slate editor.
## Static Methods
#### `History.isHistory(value: any): value is History`
Returns `true` if the passed in `value` is a `History` object and also acts as a type guard for `History`.