mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-11 01:33:58 +02:00
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# Slate Component
|
|
|
|
## `Slate(props: SlateProps): JSX.Element`
|
|
|
|
The `Slate` component must include somewhere in its `children` the `Editable` component.
|
|
|
|
### Props
|
|
|
|
```typescript
|
|
type SlateProps = {
|
|
editor: ReactEditor
|
|
value: Descendant[]
|
|
children: React.ReactNode
|
|
onChange?: (value: Descendant[]) => void
|
|
onSelectionChange?: (selection: Selection) => void
|
|
onValueChange?: (value: Descendant[]) => void
|
|
}
|
|
```
|
|
|
|
#### `props.editor: ReactEditor`
|
|
|
|
An instance of `ReactEditor`
|
|
|
|
#### `props.value: Descendant[]`
|
|
|
|
The initial value of the Editor.
|
|
|
|
This prop is deceptively named.
|
|
|
|
Slate once was a controlled component (i.e. it's contents were strictly controlled by the `value` prop) but due to features like its edit history which would be corrupted by direct editing of the `value` it is no longer a controlled component.
|
|
|
|
#### `props.children: React.ReactNode`
|
|
|
|
The `children` which must contain an `Editable` component.
|
|
|
|
#### `props.onChange: (value: Descendant[]) => void`
|
|
|
|
An optional callback function which you can use to be notified of changes in the editor's value.
|
|
|
|
#### `props.onValueChange?: (value: Descendant[]) => void`
|
|
|
|
`props.onChange` alias.
|
|
|
|
#### `props.onSelectionChange?: (selection: Selection) => void`
|
|
|
|
An optional callback function which you can use to be notified of changes of the editor's selection.
|