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

Use extended Editor type in useSlateWithV return type (#5763)

Browse Source 
* Use extended `Editor` type in `useSlateWithV` return type

So it matches the return types of `useSlate` and `useSlateStatic`. The
`useSlateWithV` return object's `editor` property is currently typed as
just a `ReactEditor`, which causes type errors in our app when we try to
use it as the extended `Editor` type.

* Fix return types in "Editor hooks" docs
This commit is contained in:
Ty Mick
2024-11-19 10:14:47 -08:00
committed by GitHub
parent 49ba21a7ba
commit 644ebdc8f5
3 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/libraries/slate-react/hooks.md
View File

@@ -28,15 +28,15 @@ Get the current `selected` state of an element.
### Editor hooks
#### `useSlate(): ReactEditor`
#### `useSlate(): Editor`
Get the current editor object from the React context. Re-renders the context whenever changes occur in the editor.
#### `useSlateWithV(): { editor: ReactEditor, v: number }`
#### `useSlateWithV(): { editor: Editor, v: number }`
The same as `useSlate()` but includes a version counter which you can use to prevent re-renders.
#### `useSlateStatic(): ReactEditor`
#### `useSlateStatic(): Editor`
Get the current editor object from the React context. A version of useSlate that does not re-render the context. Previously called `useEditor`.