feat(switch): update API to match Checkbox package #2753
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 9f30835 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
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 |
github-actions
bot
added
the
Status: Do Not Merge
TheSisb
changed the title
TheSisb
changed the title
github-actions
bot
added
Area: Components
✅ Deploy Preview for paste-theme-designer ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for paste-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 9f30835:
|
|
Size Change: +718 B (0%) Total Size: 753 kB
ℹ️ View Unchanged
|
|
Test summaryRun details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
github-actions
bot
added
Area: Doc Site
nkrantz
reviewed
Oct 21, 2022
shleewhite
reviewed
Oct 24, 2022
shleewhite
previously approved these changes
Oct 25, 2022
TheSisb
added
🚀 merge it!
🕵🏻♀️ Run website visual regression
ghost
previously approved these changes
Oct 26, 2022
SiTaggart
reviewed
Oct 26, 2022
| '@twilio-paste/core': major | ||
| --- | ||
|
|
||
| [Switch] Updated Switch component API to match other form components in Paste. |
There was a problem hiding this comment.
praise: excellently detailed changelog!
SiTaggart
previously approved these changes
Oct 26, 2022
kelseycavitt
approved these changes
Oct 26, 2022
SiTaggart
approved these changes
Oct 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
API changes:
SwitchContainerhas been replaced withSwitchGroupSwitchGroupprops changes:id?: stringlabel: ReactNode- use the newlegendprop instead.legend: string | NonNullable<React.ReactNode>to replace the oldlabelprop.errorText?: string | React.ReactNodeto handle error states.orientation?: 'vertical' | 'horizontal;to set children orientation.i18nRequiredLabel?: stringto change the required label for internationalization.name: stringto label the switch group for forms.onChange?: (checked: boolean) => voidto handle changes to any child Switch's checked state in a single function.helpTextprop now accepts a string.requiredprop is now optional.elementprop default value changed toSWITCH_GROUPfromSWITCH_CONTAINERSwitchprops changes:childrenprop type changed toNonNullable<React.ReactNode>hasError?: booleanto handle error states.helpText?: string | React.React.Nodeto add additional context to a switch.checked?: booleanto use the Switch in a controlled manner.defaultChecked?: booleanto set the default checked value in an uncontrolled manner.Todo