-
Notifications
You must be signed in to change notification settings - Fork 67
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
Added combo box guidance #3775
Added combo box guidance #3775
Conversation
babsdenney
commented
Feb 3, 2025
- Added combo box documentation page under the forms sub-menu
- Documentation under search input and select that needs to be updated once we finalize the combo box guidance
- Added a combo box documentation page under the forms sub menu - Found some documentation under search input and select that needs updating once we finalize the combo box guidance
- Added figma link to combo box guidance page
- Fixed some links - Added some related components
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.
This looks great Barb!! There is only one small thing I see that is different than Storybook: on the error state, it looks like there is a red rule line on the left hand side that is not present in this documentation:
src/_components/form/index.md
Outdated
@@ -7,6 +7,7 @@ intro-text: "Form controls allow users to enter information." | |||
status: use-deployed | |||
sub-pages: | |||
- sub-page: Autosave | |||
- sub-page: Combo box |
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 keep these alphabetical and move Combo Box after Checkbox?
src/_components/search-input.md
Outdated
@@ -51,6 +51,7 @@ web-component: va-search-input | |||
### When to consider something else | |||
|
|||
* When free text input is allowed, do not use type-ahead in form fields where the user might assume they are limited to selecting a suggested term. Alternatively, provide a clear way for the user to add an entry if you do use type-ahead in a form field. | |||
* If you have less or around a 100 options, consider using a different approach, such as using the [combo box]({{ site.baseurl }}/components/form/combo-box) component to help users find what they need. |
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.
If you have less or around a 100 options...
This reads a tad bit odd to me. Do we mean "If there are approximately 100 options or less..."?
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.
The docs look good to me, thanks!
I think we may want to make a shared piece of content that we can include on the Form > Select, Form > Radio button, and Form > Combo box pages with a title like "Choosing the right component for the task" The content of that is something like the following: Options
We can discuss the ranges and numbers here, but this is my best effort at the moment (which is no doubt clouded by cold medicine). |
- Added shared select option guidance to radio button, select, combo-box, and search input components - Updated order of menu for combo box
@LWWright7 Thank you! I'm not sure if maybe I'm seeing something different. I see the red line on the left in the documentation. Is that what you are referring to? |
@danbrady @humancompanion-usds This is ready for re-review. |
@babsdenney The deployment link for your PR looks like this to me, without the red line... 🤔 (screenshot below). The screen shot I included in my previous comment is from this Storybook link. |
FYI - Added #3787 for the missing red, vertical line issue. |
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.
LGTM!