From 34776c6e01c0fe3bd5c8e2599ddee1b981ee4e11 Mon Sep 17 00:00:00 2001 From: Sunny Hirai Date: Thu, 13 Apr 2023 09:23:20 -0700 Subject: [PATCH] Normalize Slat and Editable component documentation. Add under construction message to Editable component. --- docs/libraries/slate-react/editable.md | 4 ++++ docs/libraries/slate-react/slate.md | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/libraries/slate-react/editable.md b/docs/libraries/slate-react/editable.md index 269c6ece5..b5ab11cf7 100644 --- a/docs/libraries/slate-react/editable.md +++ b/docs/libraries/slate-react/editable.md @@ -4,6 +4,8 @@ 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. ```typescript @@ -22,3 +24,5 @@ export type EditableProps = { disableDefaultStyles?: boolean } & React.TextareaHTMLAttributes ``` + +_NOTE: Detailed breakdown of Props not completed. Refer to the source code at the moment. Under construction._ diff --git a/docs/libraries/slate-react/slate.md b/docs/libraries/slate-react/slate.md index 226f41307..b5b9e2810 100644 --- a/docs/libraries/slate-react/slate.md +++ b/docs/libraries/slate-react/slate.md @@ -4,6 +4,8 @@ The `Slate` component must include somewhere in its `children` the `Editable` component. +### Props + ```typescript type SlateProps = { editor: ReactEditor @@ -13,8 +15,6 @@ type SlateProps = { } ``` -### Slate Props - #### `props.editor: ReactEditor` An instance of `ReactEditor`