mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-06 07:17:27 +02:00
Code Issues Releases Wiki Activity
Files
main
slate/docs/libraries/slate-react/with-react.md
Ben Dahl 711c2298dd Fix a few typos in the docs (#5463) 
* fix: typo in with-react docs

* fix: typo in range docs

* fix: typo in faq docs

* fix: typo in react-editor docs
2023-06-30 00:03:00 -07:00

946 B
Raw Permalink Blame History

withReact

Adds React and DOM specific behaviors to the editor.

withReact<T extends Editor>(editor: T, clipboardFormatKey = 'x-slate-fragment'): T & ReactEditor

When used with withHistory, withReact should be applied outside. For example:

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 copied between editors with different schemas.