Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make onChange prop optional, update examples and docs to treat slate as uncontrolled #4922

Merged
merged 2 commits into from
Apr 3, 2022

Conversation

BitPhinix
Copy link
Contributor

Description
Makes the <Slate/> onChange prop optional, updates the docs to treat the <Slate/> component as uncontrolled to avoid confusion.

Context
Ever since #4540 slate is in a weird half state. The API and docs suggest it's controlled as it requires a onChange and value prop and all examples keep a record of the state outside the component in a useState. This causes a lot of confusion, especially for people new to slate (see e.g. #4812) without any good reason.

Checks

  • The new code matches the existing patterns and styles.
  • The tests pass with yarn test.
  • The linter passes with yarn lint. (Fix errors with yarn fix.)
  • The relevant examples still work. (Run examples with yarn start.)
  • You've added a changeset if changing functionality. (Add one with yarn changeset add.)

@changeset-bot
Copy link

changeset-bot bot commented Mar 31, 2022

🦋 Changeset detected

Latest commit: c520c5e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
slate-react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants