1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-13 18:53:59 +02:00

Remove redundant material from the main Slate React docs

This commit is contained in:
Sunny Hirai
2023-04-12 23:05:41 -07:00
parent 67e8709f45
commit 3d1c6936dc

View File

@@ -7,39 +7,4 @@ This sub-library contains the React-specific logic for Slate.
- [Hooks](./hooks.md)
- [Slate](./slate.md)
- [Editable](./editable.md)
- Usage (under construction)
- [Event Handling](./event-handling.md)
## Components
React components for rendering Slate editors
### `RenderElementProps`
`RenderElementProps` are passed to the `renderElement` handler.
### `RenderLeafProps`
`RenderLeafProps` are passed to the `renderLeaf` handler.
### `Editable`
The main Slate editor.
#### Event Handling
### `DefaultElement(props: RenderElementProps)`
The default element renderer.
### `DefaultLeaf(props: RenderLeafProps)`
The default custom leaf renderer.
### `Slate(props: { editor: ReactEditor, value: Node[], children: React.ReactNode, onChange: (value: Node[]) => void })`
A wrapper around the provider to handle `onChange` events, because the editor is a mutable singleton so it won't ever register as "changed" otherwise.
## Utils
Private convenience modules
- [Event Handling](./event-handling.md)