-
-
Notifications
You must be signed in to change notification settings - Fork 262
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
Alphabetize prop names in documentation #1891
Comments
I'm opposed to this. Props are purposefully listed with the most relevant/important. In the docs, reactive vars are listed first. Generally, props should be sorted by importance, relevance, then grouped by similarity. |
For example - yes, it's easier to initially find a prop in an alphabetized list, but it's inefficient beyond that. A prop like hideLabel naturally follows labelText. If alphabetized, hideLabel would appear before labelText. Props like invalidText and warnText should also be close in proximity. |
@metonym fair enough, the rationale is sound. Seeing most-used props first does provide good quality of life to users, myself included. I don't see a way to ensure this ordering via linting or docs generation, but that's ok. |
I added a "Prop ordering" rule in #1621 so that this is captured somewhere. We can continue to discuss ordering in that proposal. |
This is blocked by #1629
In the component docs, the API section will render prop names in the order they're defined.
The text was updated successfully, but these errors were encountered: