chore: clarify error about children of Form.Item with name
#38038
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
This is a common error and the message as written was not very clear. This should be more helpful pointing people in the right direction
|
|
Referring to "render props" is confusing because the docs don't explain what that is, and it's not really a prop.
Also improve the test names for some
Missed a couple messages
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #38038 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 444 444
Lines 8231 8217 -14
Branches 2488 2491 +3
=========================================
- Hits 8231 8217 -14
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
afc163
reviewed
Oct 17, 2022
components/form/FormItem/index.tsx
Outdated
| warning( | ||
| false, | ||
| 'Form.Item', | ||
| 'A `Form.Item` with a `name` prop must have a single child element. For information on how to render more complex form items, see https://ant.design/components/form/#components-form-demo-complex-form-control.' |
There was a problem hiding this comment.
There was a problem hiding this comment.
Cool, I've opened a PR to add a couple links for these error messages, I'll update this PR when that is merged 👍
cincodenada
changed the title
namename
afc163
reviewed
Nov 4, 2022
afc163
reviewed
Nov 4, 2022
afc163
reviewed
Nov 4, 2022
afc163
approved these changes
Nov 7, 2022
elevensky
pushed a commit
to elevensky/ant-design
that referenced
this pull request
Nov 12, 2022
…ign#38038) * Clarify error about children of Form.Item with `name` This is a common error and the message as written was not very clear. This should be more helpful pointing people in the right direction * Update error message in test * Clarify more error messages Referring to "render props" is confusing because the docs don't explain what that is, and it's not really a prop. * Update tests for new error messages Also improve the test names for some * Further test message updates Missed a couple messages * Add short URLs * Update test error messages * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Ell Bradshaw <joelbr@tailormed.co> Co-authored-by: afc163 <afc163@gmail.com>
19 tasks
elevensky
pushed a commit
to elevensky/ant-design
that referenced
this pull request
Nov 22, 2022
…ign#38038) * Clarify error about children of Form.Item with `name` This is a common error and the message as written was not very clear. This should be more helpful pointing people in the right direction * Update error message in test * Clarify more error messages Referring to "render props" is confusing because the docs don't explain what that is, and it's not really a prop. * Update tests for new error messages Also improve the test names for some * Further test message updates Missed a couple messages * Add short URLs * Update test error messages * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Ell Bradshaw <joelbr@tailormed.co> Co-authored-by: afc163 <afc163@gmail.com>
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.
[中文版模板 / Chinese template]
🤔 This is a ...
🔗 Related issue link
No issue directly related, but this issue is indirectly about it: #25150
💡 Background and solution
Existing message is confusingly phrased in English, and doesn't really describe the problem or how to fix it.
📝 Changelog
☑️ Self-Check before Merge