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

Docs: improve Switch component documentation #1687

Merged
merged 3 commits into from
Apr 29, 2021

Conversation

flo-sch
Copy link
Collaborator

@flo-sch flo-sch commented Apr 28, 2021

  • docs(components): update Switch documentation page
    • illustrate how to use input state with Emotion's nest selector
    • add example with external label

Relates to #1671

- illustrate how to use input state with Emotion's nest selector
- add example with external label
@vercel
Copy link

vercel bot commented Apr 28, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/systemui/theme-ui/3pc7jXrzLLX59PsuWJ4VXiHjoB5d
✅ Preview: https://theme-ui-git-fork-flo-sch-docs-switchstate-selector-systemui.vercel.app

@flo-sch
Copy link
Collaborator Author

flo-sch commented Apr 28, 2021

Not sure if that use-case deserves a unit-test as well?

@hasparus
Copy link
Member

hasparus commented Apr 28, 2021

Not sure if that use-case deserves a unit-test as well?

It wouldn't hurt but it's fine, I think.

Okay, apart from my nitpick I have no more comments. This looks like it's good to merge.

@hasparus hasparus added the documentation Changes only affect the documentation label Apr 28, 2021
@flo-sch
Copy link
Collaborator Author

flo-sch commented Apr 28, 2021

Fixed :)

@hasparus
Copy link
Member

Okay, @lachlanjc — the docs are your domain so I'll leave this for you.

Copy link
Member

@lachlanjc lachlanjc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! A few edits but let’s get this out there.

packages/docs/src/pages/components/switch.mdx Outdated Show resolved Hide resolved
packages/docs/src/pages/components/switch.mdx Outdated Show resolved Hide resolved
packages/docs/src/pages/components/switch.mdx Outdated Show resolved Hide resolved
@flo-sch
Copy link
Collaborator Author

flo-sch commented Apr 29, 2021

Thanks @lachlanjc for the feedbacks :)

@lachlanjc lachlanjc merged commit 48578e4 into system-ui:develop Apr 29, 2021
@lachlanjc
Copy link
Member

Yay! Appreciate your work here.

@hasparus
Copy link
Member

hasparus commented May 5, 2021

🚀 PR was released in v0.8.0 🚀

@hasparus hasparus added the released This issue/pull request has been released. label May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants