Chris Nicholas
70166d6386
Add "Enabling Collaborative Editing" Yjs guide to the docs ( #5505 )
...
* feat: Making a start
* feat: Draft guide, showing all Yjs, then Liveblocks, then Slate-yjs
* feat: Fixed code snippets
* feat: websocket -> WebSocket
* feat: Renaming page
* feat: Title change
* feat: Add provider to resources
* feat: Clarity
* feat: Update Plate link
* feat: Mention Yjs providers
* feat: Actually update the Plate link
Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
---------
Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
2023-09-05 10:23:24 -07:00
Sunny Hirai
ca77e934bc
Add docs for as in Editable
2023-07-24 02:27:57 -07:00
Sunny Hirai
8effdf92cd
Update Editable docs but with more concise documentation
2023-07-24 02:23:11 -07:00
Sunny Hirai
61ecfea24e
Improve the Editable docs
2023-07-24 02:16:30 -07:00
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
Dylan Schiemann
25e5eee4af
Fix docs typo for unref ( #5448 )
2023-06-12 18:58:28 -07:00
Brian Bucknam
5eb589dbbb
Use mark functions for docs and examples ( #5441 )
...
When documenting how to apply character-level styling, use `addMark` and `removeMark` instead of `setNodes`. This avoids new users creating code that only works in the simplest cases.
Similarly, update the Hovering Toolbar example to apply marks instead of setting nodes.
This change was prompted by a discussion on Slack where the developer was disappointed that `markableVoid` did not appear to be working. The problem was they were using `setNodes` to apply Marks, and did not use the same `match` function that `addMark` uses.
2023-06-12 15:08:10 -07:00
Davi Alexandre
a94d64ec09
missed import Element from slate ( #5446 )
...
Not importing it results in:
Property 'isElement' does not exist on type '{ new (): Element; prototype: Element; }'.ts(2339)
2023-06-12 15:06:24 -07:00
Ivan Voskoboinyk
91e388ecd9
Rename <Slate> component value prop to initialValue ( #5421 )
...
* Rename `slate-react` Slate component `value` prop to `initialValue`
Fixes #4992
* Update documentation: `value` -> `initialValue`
* Add a changeset record
* Make props order consistent
2023-05-26 07:53:39 -07:00
Ravi Lamkoti
869d1240d3
chore: rename imageElmnts to imageElements in 04-transforms.md ( #5431 )
...
It will make code more readable and character difference is very less so it's worth changing.
2023-05-25 10:55:24 -07:00
Ziad Beyens
01f0210bcc
Consistent insert* methods ( #5415 )
...
* feat: add reviewpad.yml file
* Update reviewpad.yml
* ✨ options to `Editor.insert*`
* 📝 options to `Editor.insert*`
* ✨ getDefaultInsertLocation
* ✨ getDefaultInsertLocation
* ✨ getDefaultInsertLocation
* 📝 consistent selection
* Create tasty-lizards-remain.md
* Update tasty-lizards-remain.md
---------
Co-authored-by: reviewpad[bot] <104832597+reviewpad[bot]@users.noreply.github.com>
Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
2023-05-06 15:41:42 -07:00
Cyrille Perois
48c18b5368
docs(walkthroughs): fix broken code example ( #5409 )
...
The `match` condition was updated between two examples. The later didn't work because it was missing a part of the condition.
2023-05-05 04:04:05 -07:00
trevorbye
161af4c70d
Update 01-installing-slate.md ( #5388 )
...
add initial value with children so other examples don't break
2023-04-18 05:01:19 -07:00
Vitomir Budimir
00bce4c880
docs(walkthroughs): fix incomplete code block keyboard shortcut example ( #5392 )
2023-04-18 05:01:02 -07:00
Sunny Hirai
832e75f47a
docs: Add details about the scrollSelectionIntoView prop for the Editable component
2023-04-17 14:46:17 -07:00
Sunny Hirai
3c4e4b6ab3
Remove export from EditableProps in docs
2023-04-13 09:42:39 -07:00
Sunny Hirai
20cff0e35d
Add props. prefix to Slate component docs where it was missing
2023-04-13 09:38:46 -07:00
Sunny Hirai
34776c6e01
Normalize Slat and Editable component documentation. Add under construction message to Editable component.
2023-04-13 09:23:20 -07:00
Sunny Hirai
36ea10b88d
Add return types to Slate React components
2023-04-13 09:18:48 -07:00
Sunny Hirai
0faa1476c1
Fix typo in Slate Component docs
2023-04-13 09:16:02 -07:00
Sunny Hirai
db3e0f8a81
Rename Slate and Editable to Slate Component and Editable Component in table of contents to improve discoverability
2023-04-13 09:14:48 -07:00
Sunny Hirai
cc2000b583
Provide a more detailed description of useSlateSelector in docs
2023-04-13 09:13:19 -07:00
Sunny Hirai
c6b7db2e13
Organize hooks documentation and add subheadings
2023-04-13 09:10:12 -07:00
Sunny Hirai
d193160fbd
Add return values to SlateReact hooks documentation
2023-04-13 09:07:35 -07:00
Sunny Hirai
5f1baec200
Add return types to documentation of ReactEditor
2023-04-13 08:47:53 -07:00
Sunny Hirai
3d1c6936dc
Remove redundant material from the main Slate React docs
2023-04-12 23:05:41 -07:00
Sunny Hirai
67e8709f45
Add separate page for Slate component in docs
2023-04-12 23:03:19 -07:00
Sunny Hirai
161c9d8f45
Fix table of contents for doc related to Slate React
2023-04-12 22:47:16 -07:00
Sunny Hirai
0e34b35aed
Fix typo in ReactEditor docs
2023-04-12 22:45:50 -07:00
Sunny Hirai
036d58fa98
Add Editable and event handling docs for Slate React
2023-04-12 22:44:50 -07:00
Sunny Hirai
76544747e8
Remove plugins section from main SlateReact docs because it is redundant
2023-04-12 22:26:46 -07:00
Sunny Hirai
36abe94ded
Improve the documentation for withReact plugin
2023-04-12 22:26:11 -07:00
Sunny Hirai
f80ecaf165
Extract SlateReact hooks documentation onto its own page
2023-04-12 22:20:54 -07:00
Sunny Hirai
083424eeb0
Extract ReactEditor docs into its own page and organize the methods with subheadings
2023-04-12 22:14:00 -07:00
Sunny Hirai
92b03170f7
Add docs for with-react
2023-04-12 22:01:59 -07:00
Sunny Hirai
cf5563a74d
Move SlateReact docs into a separate folder slate-react
2023-04-12 21:47:10 -07:00
Sunny Hirai
2f3fb37ffc
Add withHistory page to docs, reorganize the History docs in general and update Summary.md
2023-04-12 21:44:53 -07:00
Sunny Hirai
f89aca22f6
Improve table of content links inside Operation Types docs
2023-04-12 19:09:56 -07:00
Sunny Hirai
4383127876
Reorganize Operation docs
2023-04-12 19:06:18 -07:00
Sunny Hirai
2ba167eadb
Add API reference for Operation types
2023-04-12 18:50:52 -07:00
Sunny Hirai
dd2dfbdfc7
Prefix operation static methods in docs with Operation.
2023-04-12 09:37:38 -07:00
Sunny Hirai
7c2beea54e
Update Operation docs to add a table of contents and to fix the heading names
2023-04-12 09:34:31 -07:00
Sunny Hirai
0861663a5c
Add links in SlateHistory main docs
2023-04-11 23:16:56 -07:00
Sunny Hirai
72d2d84b85
Improve docs for the main page for SlateHistory with more descriptions
2023-04-11 23:14:49 -07:00
Sunny Hirai
8a17891998
A few improvements to HistoryEditor docs including fixing a link
2023-04-11 23:10:58 -07:00
Sunny Hirai
feab2c4f46
Add docs for HistoryEditor
2023-04-11 23:07:32 -07:00
Sunny Hirai
5f56c2bc26
Flesh out docs for Slate History with methods
2023-04-11 18:35:58 -07:00
Sunny Hirai
7b5949ccc9
Add beginning of History docs to Slate docs
2023-04-11 18:23:16 -07:00
Alexey Volkov
26ace0db28
docs(concepts): fix code example on the Editor page ( #5377 )
2023-04-03 11:01:50 -07:00
Amandeep Singh
1d8010be85
Fix the nodeName from lower to upper case ( #5348 )
...
The node name should be `STRONG` instead of `strong` in the example deserialize function.
2023-03-08 06:51:37 -07:00
