Allow defaultChecked to be used in Checkbox #2600
Open
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: f4ed28c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
Size Change: +37 B (0%) Total Size: 1.41 MB
ℹ️ View Unchanged
|
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| '@leafygreen-ui/checkbox': patch | |||
There was a problem hiding this comment.
I think this would be a minor change, since it adds a feature
There was a problem hiding this comment.
Okay!! Should I change it manually to minor in this file or should I run the script again to change it?
| @@ -50,6 +50,7 @@ function Checkbox({ | |||
| id: idProp, | |||
| indeterminate: indeterminateProp, | |||
| label = '', | |||
| defaultChecked = false, | |||
There was a problem hiding this comment.
I believe other components use initialValue (e.g. Combobox). Unsure whether consistency with other LG components or with HTML checkbox api is more valuable
There was a problem hiding this comment.
The Text Area uses defaultValue. I would vote to use defaultValue across all components to meet HTML naming rule.
There was a problem hiding this comment.
I don't have a strong opinion; I'll defer to @TheSonOfThomp since you regularly work in this repo.
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.
✍️ Proposed changes
Allows Checkbox to default to true when uncontrolled. Currently, if the checkbox is uncontrolled, it only supports starting in a false state. However, there are cases where we want to have the checkbox be uncontrolled, but start in a true state.
In essence, this would support usage of the defaultChecked property!
✅ Checklist
For bug fixes, new features & breaking changes
yarn changesetand documented my changesLet me know if there's anything I can do!! Also, feel free to close if it's not something that's right for leafy green :D it would just be a really useful feature for us on the MANA team!