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

Normalize Slat and Editable component documentation. Add under construction message to Editable component.

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-13 09:23:20 -07:00
parent 36ea10b88d
commit 34776c6e01
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/libraries/slate-react/editable.md
View File

@@ -4,6 +4,8 @@
The `Editable` component is the main editing component. Note that it must be inside a `Slate` component. The `Editable` component is the main editing component. Note that it must be inside a `Slate` component.
### Props
It takes as its props, any props accepted by a Textarea element plus the following props. It takes as its props, any props accepted by a Textarea element plus the following props.
```typescript ```typescript
@@ -22,3 +24,5 @@ export type EditableProps = {
disableDefaultStyles?: boolean disableDefaultStyles?: boolean
} & React.TextareaHTMLAttributes<HTMLDivElement> } & React.TextareaHTMLAttributes<HTMLDivElement>
``` ```
_NOTE: Detailed breakdown of Props not completed. Refer to the source code at the moment. Under construction._

4
docs/libraries/slate-react/slate.md
View File

@@ -4,6 +4,8 @@
The `Slate` component must include somewhere in its `children` the `Editable` component. The `Slate` component must include somewhere in its `children` the `Editable` component.
### Props
```typescript ```typescript
type SlateProps = { type SlateProps = {
editor: ReactEditor editor: ReactEditor
@@ -13,8 +15,6 @@ type SlateProps = {
} }
``` ```
### Slate Props
#### `props.editor: ReactEditor` #### `props.editor: ReactEditor`
An instance of `ReactEditor` An instance of `ReactEditor`