1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-18 21:21:21 +02:00

docs: clarifies not setting editor values directly & plugin order (#4571)

* Updates "Saving to a Database" example to distinguish actual content changes.

* Update docs/walkthroughs/06-saving-to-a-database.md

* Update docs/walkthroughs/06-saving-to-a-database.md

* Update docs/walkthroughs/06-saving-to-a-database.md

* Runs prettier

* docs: clarifies not setting editor values directly & plugin order

* Changes reccommended order of withReact & withHistory, to match current knowleged

Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
This commit is contained in:
Doug Reeder
2021-10-11 20:40:38 -04:00
committed by GitHub
parent 4b2e4000d6
commit 43e740c88d
4 changed files with 20 additions and 0 deletions

View File

@@ -33,10 +33,12 @@ It is slightly more complex than the others, because it contains all of the top-
The `children` property contains the document tree of nodes that make up the editor's content.
The `selection` property contains the user's current selection, if any.
Don't set it directly; use [Transforms.select](04-transforms#selection-transforms)
The `operations` property contains all of the operations that have been applied since the last "change" was flushed. \(Since Slate batches operations up into ticks of the event loop.\)
The `marks` property stores formatting to be applied when the editor inserts text. If `marks` is `null`, the formatting will be taken from the current selection.
Don't set it directly; use `Editor.addMark` and `Editor.removeMark`.
## Overriding Behaviors

View File

@@ -87,6 +87,12 @@ yarn lint
This will catch TypeScript, Prettier, and Eslint errors.
```text
yarn fix
```
This will fix Prettier and Eslint errors.
## Running integration tests
To run integrations with [cypress](https://github.com/cypress-io/cypress), first run `yarn start` to run the examples website, then run `yarn cypress:open` in a separate session to open the cypress GUI.

View File

@@ -13,3 +13,9 @@ This sub-library tracks changes to the Slate value state over time, and enables
## `withHistory`
The `withHistory` plugin keeps track of the operation history of a Slate editor as operations are applied to it, using undo and redo stacks.
When used with `withReact`, `withHistory` should be applied inside. For example:
```javascript
const editor = useMemo(() => withReact(withHistory(createEditor())), [])
```

View File

@@ -180,6 +180,12 @@ React-specific plugins for Slate editors
Adds React and DOM specific behaviors to the editor.
When used with `withHistory`, `withReact` should be applied outside. For example:
```javascript
const editor = useMemo(() => withReact(withHistory(createEditor())), [])
```
## Utils
Private convenience modules