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

Improve docs for the main page for SlateHistory with more descriptions

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-11 23:14:49 -07:00
parent 8a17891998
commit 72d2d84b85
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/libraries/slate-history.md
View File

@@ -2,20 +2,20 @@
This sub-library tracks changes to the Slate value state over time, and enables undo and redo functionality. This sub-library tracks changes to the Slate value state over time, and enables undo and redo functionality.
## `History`
`History` objects hold all of the operations that are applied to a value, so they can be undone or redone as necessary.
## `HistoryEditor`
`HistoryEditor` contains helpers for history-enabled editors.
## `withHistory` ## `withHistory`
The `withHistory` plugin keeps track of the operation history of a Slate editor as operations are applied to it, using undo and redo stacks. The `withHistory` plugin adds the `HistoryEditor` to an `Editor` instance and keeps track of the operation history of a Slate editor as operations are applied to it, using undo and redo stacks.
When used with `withReact`, `withHistory` should be applied inside. For example: When used with `withReact`, `withHistory` should be applied inside. For example:
```javascript ```javascript
const [editor] = useState(() => withReact(withHistory(createEditor()))) const [editor] = useState(() => withReact(withHistory(createEditor())))
``` ```
## `HistoryEditor`
`HistoryEditor` is the Editor with history related methods and the `History` object property. It also contains static helpers for history-enabled editors.
## `History`
`History` objects accessed at `editor.history` on a `HistoryEditor` holds all of the operations that are applied to a value, so they can be undone or redone as necessary.