Update useField docs with options #4626
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4626 +/- ##
=======================================
Coverage 89.80% 89.80%
=======================================
Files 93 93
Lines 7657 7657
Branches 1348 1348
=======================================
Hits 6876 6876
Misses 774 774
Partials 7 7 ☔ View full report in Codecov by Sentry. |
logaretm
requested changes
Jan 7, 2024
docs/src/pages/api/use-field.mdx
Outdated
Comment on lines
388
to
391
| | `standalone` | | `label` | | ||
| | `type` | | `validateOnValueUpdate` | | ||
| | `initialValue` | | `keepValueOnUnmount` | | ||
| | | | `syncVModel` | |
There was a problem hiding this comment.
label, validateOnValueUpdate, keepValueOnUnmount and syncVModel are not checkbox/radio specific.
There was a problem hiding this comment.
Apologies for the oversight. I amended my commit and also refactored into a singular column table that will show the Field options. checkedValue and uncheckedValue are suffixed with "(checkbox/radio only)".
Added a simple description of how to use options with useField
logaretm
approved these changes
Jan 15, 2024
|
Thanks! |
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.
Added a simple description of how to use options with useField
🔎 Overview
I was searching for a way to add options (type and label) to the useField function but I had to figure this out on my own since the docs were not clear enough for me.
🤓 Code snippets/examples (if applicable)
// some code✔ Issues affected