-
Notifications
You must be signed in to change notification settings - Fork 14k
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
chore: Add docs to the Select component props #17171
Conversation
Codecov Report
@@ Coverage Diff @@
## master #17171 +/- ##
=======================================
Coverage 76.95% 76.95%
=======================================
Files 1038 1038
Lines 55597 55597
Branches 7585 7585
=======================================
Hits 42787 42787
Misses 12560 12560
Partials 250 250
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
@@ -82,17 +82,80 @@ export type OptionsPagePromise = ( | |||
) => Promise<OptionsTypePage>; | |||
|
|||
export interface SelectProps extends PickedSelectProps { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a description to the component as well? Some things that can be in the description:
- The different modes of operation (static and async)
- The differences and motivation that lead us to increment the default Ant Design Select.
- The reasoning/criteria for not exposing some props but instead using default values (simplification, standard behavior)
- A reference to the Storybook file
- A reference to the Ant Design API for the other properties
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @michael-s-molina. I added the description. Please have a look
This is looking great! The bar for this component is definitely high with the docs, storybook and tests 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! Thanks for the awesome work!
SUMMARY
This PR adds documentation for the custom properties of the Select component.
ADDITIONAL INFORMATION