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
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
Samy Rahmani
56ab505485
Added missing brackets to resolve inconsistancy ( #5097 )
2022-08-22 17:15:40 -07:00
Gabin Aureche
22308b3417
Replace useMemo with useState in the docs ( #5022 )
...
* Replace useMemo with useState
* Fix formatting
2022-06-11 07:58:19 -07:00
Gabin Aureche
a66c7315a3
Replace useState with useMemo in the "Installing Slate" walkthrough ( #5020 )
...
* Update 01-installing-slate.md
* Revert changes to types definitions
2022-06-07 21:31:52 -07:00
James
34cfc1c704
closed bracket on complete code example ( #4950 )
2022-04-19 08:48:22 -07:00
Eric Meier
f17413086e
Update examples in docs, editable voids example ( #4925 )
...
* Update examples in docs, editable voids example
* Update typescript docs
2022-04-03 09:57:38 -07:00
Eric Meier
9892cf0ffb
Make onChange prop optional, update examples and docs to treat slate as uncontrolled ( #4922 )
...
* Make onChange prop optional, update examples and docs to treat slate as uncontrolled
* Add changeset
2022-04-03 08:52:32 -07:00
Antonio Sanchez Gomez
51e02de9de
Update docs to reflect Slate is an uncontrolled component ( #4768 )
...
* Updated documentation
* Update docs/walkthroughs/01-installing-slate.md
Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org >
* fix: formatting errors
Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org >
2022-01-10 03:42:46 -07:00
Desmond Brand
1b0e7c6b92
Docs shouldn't useMemo for editor ( #4766 )
...
As already discussed almost a year ago in #3198 , `useMemo` doesn't guarantee persistence. This breaks Fast Refresh.
`useState` without a setter is a straightforward fix that avoids dependencies; let's get the docs updated so Fast Refresh works again.
Fixes #3198
2022-01-08 04:34:40 -07:00
meri-leeworthy
5dc9dc5227
missing dependency ( #4656 )
2021-11-15 02:02:51 -07:00
Hadrien
81cb2ae659
Fix code sample ( #4558 )
...
It's an array of CutsomElement, TS complains about it
2021-09-29 06:08:09 -07:00
ilovecommits
81d62e129d
Remove unused useEffect import ( #4406 )
...
It's imported, but not actually being used.
2021-08-04 22:02:14 -07:00
ilovecommits
f3b316e816
Fix display bug in GitBook ( #4402 )
...
It appears that GitBook doesn't support ```typescript jsx. See https://docs.slatejs.org/walkthroughs/01-installing-slate
2021-08-04 21:53:37 -07:00
Sunny Hirai
c3c3670c8b
docs: Fix installing slate to pass prettier
2021-07-08 22:51:10 -07:00
Coury Ditch
03eed53cf1
Fix typescript docs ( #4303 )
...
* Add docs on annotations for useState and initial editor value
* Typescript docs: Use initialValue
2021-07-08 19:50:13 -07:00
Scott Grant
b9f07af5ac
Updates outdated TypeScript link in first walkthrough document ( #4197 )
2021-04-13 11:04:45 -04:00
Michal Srb
734bfb5788
Stop basic installation from throwing typescript errors ( #4185 )
2021-04-13 10:12:42 -04:00
Sunny Hirai
d0ea3ccb5e
docs: Fix link in installing slate
2021-04-06 21:44:48 -07:00
Sunny Hirai
a47c35cd95
merge
2021-04-01 18:13:48 -07:00
Ian Storm Taylor
a38957b849
GitBook: [main] 58 pages and 7 assets modified
2021-04-01 23:20:52 +00:00
Sunny Hirai
4b92b752ef
docs: Added TypeScript info to the Installing Slate walkthrough
2021-03-30 14:58:31 -07:00
Sunny Hirai
08275f68f3
Custom TypeScript Types ( #3835 )
...
This PR adds better TypeScript types into Slate and is based on the proposal here: https://github.com/ianstormtaylor/slate/issues/3725
* Extend Slate's types like Element and Text
* Supports type discrimination (ie. if an element has type === "table" then we get a reduced set of properties)
* added custom types
* files
* more extensions
* files
* changed fixtures
* changes eslint file
* changed element.children to descendant
* updated types
* more type changes
* changed a lot of typing, still getting building errors
* extended text type in slate-react
* removed type assertions
* Clean up of custom types and a couple uneeded comments.
* Rename headingElement-true.tsx.tsx to headingElement-true.tsx
* moved basetext and baselement
* Update packages/slate/src/interfaces/text.ts
Co-authored-by: Brent Farese <25846953+BrentFarese@users.noreply.github.com >
* Fix some type issues with core functions.
* Clean up text and element files.
* Convert other types to extended types.
* Change the type of editor.marks to the appropriate type.
* Add version 100.0.0 to package.json
* Revert "Add version 100.0.0 to package.json"
This reverts commit 329e44e43d25846953+BrentFarese@users.noreply.github.com >
* Fix some type issues with core functions.
* Clean up text and element files.
* Convert other types to extended types.
* Change the type of editor.marks to the appropriate type.
* Run linter.
* Remove key:string uknown from the base types.
* Clean up types after removing key:string unknown.
* Lint and prettier fixes.
* Implement custom-types
Co-authored-by: mdmjg <mdj308@nyu.edu >
* added custom types to examples
* reset yarn lock
* added ts to fixtures
* examples custom types
* Working fix
* ts-thesunny-try
* Extract interface types.
* Fix minor return type in create-editor.
* Fix the typing issue with Location having compile time CustomTypes
* Extract types for Transforms.
* Update README.
* Fix dependency on slate-history in slate-react
Co-authored-by: mdmjg <mdj308@nyu.edu >
Co-authored-by: Brent Farese <brentfarese@gmail.com >
Co-authored-by: Brent Farese <25846953+BrentFarese@users.noreply.github.com >
Co-authored-by: Tim Buckley <timothypbuckley@gmail.com >
2020-11-24 12:30:06 -08:00
Ali Muqaddas
9834fe4e95
Fix: ESlint Error ( #3688 )
...
Value is defined in the upper scope
2020-05-17 08:51:07 -07:00
Kirk Swenson
f6bfe034d7
Fix typos and other minor issues in docs ( #3597 )
...
Fixed typos and grammatical errors in the documentation
2020-04-10 09:05:03 -07:00
Ken Aoki
5da89b8656
Update 01-installing-slate.md ( #3554 )
2020-03-24 18:12:06 -07:00
Xleine
217bdd611b
fix some doc's bug (with v0.57.1) ( #3393 )
...
* fix: code blocks's info string
this info string. should be `jsx`
* fix: editor's exec invoke
now, editor.exec() is not available in Slate v0.57.1
so, use editor.insertText() to instead it
* refactor: delete a nerver used value
* update add new chinese translate
update chinese translate to `v0.57.1`
Co-authored-by: Ian Storm Taylor <ian@ianstormtaylor.com >
2020-01-27 15:24:15 -05:00
David Calhoun
27db5e6c45
docs: walkthroughs: make implicit React dependencies explicit ( #3402 )
2020-01-27 15:21:08 -05:00
Ian Storm Taylor
6552da940a
Add format_text command, and editor.marks state ( #3308 )
...
* add format_text command, refactor command extensions
* update onChange to not receive selection
* update docs
* fix tests
2019-12-12 15:37:55 -05:00
Ian Storm Taylor
be8b7222ee
update walkthroughs
2019-12-06 12:06:53 -05:00
Ian Storm Taylor
124ff37c3a
update docs
2019-12-05 12:52:52 -05:00
Ian Storm Taylor
4c03b497d9
remove marks, in favor of text properties ( #3235 )
...
* remove marks, in favor of text properties
* fix lint
* fix more examples
* update docs
2019-12-05 11:21:15 -05:00
sherwinyu
2ad7735869
Fix typos in Installing Slate walkthrough ( #3168 )
2019-11-29 15:07:16 -05:00
Matt Mazzola
d457bc52b9
Docs fixes for 0.50.0 ( #3133 )
...
* docs: typos
* docs: markdown inline code formatting
https://meta.stackexchange.com/questions/82718/how-do-i-escape-a-backtick-within-in-line-code-in-markdown
* docs: remove unused value, move comment, add deps to callback
* docs: add deps to renderMark callback
2019-11-28 10:37:35 -05:00
Ian Storm Taylor
4ff6972096
Next ( #3093 )
...
* remove some key usage from core, refactor Operations.apply
* undeprecate some methods
* convert more key usage to paths
* update deprecations
* convert selection commands to use all paths
* refactor word boundary selection logic
* convert many at-range commands to use paths
* convert wrapBlock and wrapInline to not use keys
* cleanup
* remove chainability from editor
* simplify commands, queries and middleware
* convert deleteAtRange
* remove key usage from schema, deprecate *ByKey methods
* migrate *ByKey tests, remove index from *ByPath signatures
* rename at-current-range tests
* deprecate mode key usage, migrate more tests away from keys
* deprecate range and point methods which rely on keys to work
* refactor insertBlock, without fixing warnings
* add pathRef/pointRef, fix insertBlock/Inline deprecations, work on insertFragment
* refactor insertFragment
* get rich-text example rendering
* fix lint
* refactor query files, fix more tests
* remove unused queries, refactor others
* deprecate splitDescendantsByPath
* merge master
* add typescript, convert slate, slate-hyperscript, slate-plain-serializer
* add Point, Path, Range, Annotation tests
* add Annotation, Change, Element, Fragment, Mark, Range, Selection, Value interfaces tests
* add Operation and Text tests
* add Node tests
* get operations and normalization tests working for slate
* get *AtPath command tests passing
* rename *AtPath command tests
* rename
* get *AtPoint tests working
* rename
* rename
* add value queries tests
* add element, mark and path queries tests
* convert most on-selection tests
* convert on-selection commands
* rename
* get addMarks and delete commands working
* rename
* rename
* rename
* refactor value.positions(), work on delete tests
* progress on delete tests
* more delete work
* finish delete tests
* start converting to at-based commands
* restructure query tests
* restructure operations tests
* more work converting to multi-purpose commands
* lots of progress on converting to at-based commands
* add unwrapNodes
* remove setValue
* more progress
* refactor node commands to use consistent matching logic
* cleanup, get non-fragment commands passing
* remove annotations and isAtomic
* rename surround/pluck to cover/uncover
* add location concept, change at-path to from-path for iterables
* refactor batches
* add location-based queries
* refactor hanging logic
* more location query work
* renaming
* use getMatch more
* add split to wrap/unwrap
* flip levels/ancestors ordering
* switch splitNodes to use levels
* change split to always:false by default
* fix tests
* add more queries tests
* fixing more delete logic
* add more splitNodes tests
* get rest of delete tests passing
* fix location-based logic in some commands
* cleanup
* get previous packages tests passing again
* add slate-history package
* start slate-schema work
* start of react working
* rendering fixes
* get rich and plain text examples working
* get image example working with hooks and dropping
* refactor onDrop to be internal
* inline more event handlers
* refactor lots of event-related logic
* change rendering to use render props
* delete unused stuff
* cleanup dom utils
* remove unused deps
* remove unnecessary packages, add placeholder
* remove slate-react-placeholder package
* remove unused dep
* remove unnecessary tests, fix readonly example
* convert checklists example
* switch to next from webpack
* get link example working
* convert more examples
* preserve keys, memoized leafs/texts, fix node lookup
* fix to always useLayoutEffect for ordering
* fix annotations to be maps, memoize elements
* remove Change interface
* remove String interface
* rename Node.entries to Node.nodes
* remove unnecessary value queries
* default to selection when iterating, cleanup
* remove unused files
* update scroll into view logic
* fix undoing, remove constructor types
* dont sync selection while composing
* add workflows
* remove unused deps
* convert mentions example
* tweaks
* convert remaining examples
* rename h to jsx, update schema
* fix schema tests
* fix slate-schema logic and tests
* really fix slate-schema and forced-layout example
* get start of insertFragment tests working
* remove Fragment interface
* remove debugger
* get all non-skipped tests passing
* cleanup deps
* run prettier
* configure eslint for typescript
* more eslint fixes...
* more passing
* update some docs
* fix examples
* port windows undo hotkey change
* fix deps, add basic firefox support
* add event overriding, update walkthroughs
* add commands, remove classes, cleanup examples
* cleanup rollup config
* update tests
* rename queries tests
* update other tests
* update walkthroughs
* cleanup interface exports
* cleanup, change mark transforms to require location
* undo mark transform change
* more
* fix tests
* fix example
* update walkthroughs
* update docs
* update docs
* remove annotations
* remove value, move selection and children to editor
* add migrating doc
* fix lint
* fix tests
* fix DOM types aliasing
* add next export
* update deps, fix prod build
* fix prod build
* update scripts
* update docs and changelogs
* update workflow and pull request template
2019-11-27 20:54:42 -05:00
