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

Improve the documentation for withReact plugin

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-12 22:26:11 -07:00
parent f80ecaf165
commit 36abe94ded
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/libraries/slate-react/with-react.md
View File

@@ -1,17 +1,17 @@
# withReact
The `withReact` plugin enables Slate to work in a React environment. Currently, React is the only first class implementation of Slate available.
Adds React and DOM specific behaviors to the editor.
### `withReact<T extends Editor>(editor: T, clipboardFormatKey = 'x-slate-fragment'): T & ReactEditor`
Add `ReactEditor` to an instance of any `Editor`.
The `clipboardFormatKey` option allows you to customize the `DataTransfer` type when Slate data is copied to the clipboard. By default, it is `application/x-slate-fragment` but it can be customized using this option.
This can be useful when a user copies from one Slate editor to a differently configured Slate editor. This could cause nodes to be inserted which are not correctly typed for the receiving editor, corrupting the document. By customizing the `clipboardFormatKey` one can ensure that the raw JSON data isn't cpied between editors with different schemas.
Example with `withHistory`:
When used with withHistory, withReact should be applied outside. For example:
```typescript
const [editor] = useState(() => withReact(withHistory(createEditor())))
```
##### `clipboardFormatKey` option
The `clipboardFormatKey` option allows you to customize the `DataTransfer` type when Slate data is copied to the clipboard. By default, it is `application/x-slate-fragment` but it can be customized using this option.
This can be useful when a user copies from one Slate editor to a differently configured Slate editor. This could cause nodes to be inserted which are not correctly typed for the receiving editor, corrupting the document. By customizing the `clipboardFormatKey` one can ensure that the raw JSON data isn't cpied between editors with different schemas.