Skip to content
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

Add usage guidance for select vs combobox vs radio #2391

Merged
merged 7 commits into from
Sep 11, 2024

Conversation

jattasNI
Copy link
Contributor

@jattasNI jattasNI commented Sep 11, 2024

Pull Request

🀨 Rationale

I needed an example of component usage guidance for an NITech presentation

πŸ‘©β€πŸ’» Implementation

Capture my understanding of when to use select, combobox, and radio in each of their MDX files.

I moved the combobox description from storybook to mdx because it was annoying to format large markdown strings from code.

Updated language for existing usage guidance to match new pattern.

  • my secret motivation is working around a prettier bug that puts tags near the end of a line in a new paragraph, leading to ugly docs. I couldn't find a syntax to prettier-ignore in mdx files. nor can other people
image

πŸ§ͺ Testing

Local storybook

βœ… Checklist

  • I have updated the project documentation to reflect my changes or determined no changes are needed.

@jattasNI jattasNI marked this pull request as ready for review September 11, 2024 17:06
@rajsite
Copy link
Member

rajsite commented Sep 11, 2024

@fredvisser straightforward change to docs that I don't think are controversial. Bypassing but if concerns can address in follow-up.

@rajsite rajsite merged commit 9af12f0 into main Sep 11, 2024
13 checks passed
@rajsite rajsite deleted the select-item-usage-guidance branch September 11, 2024 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants