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

Radio button usage updates #2126

Merged

Conversation

kingtraceyj
Copy link
Member

@kingtraceyj kingtraceyj commented Feb 4, 2021

Closes #2096

Updating usage docs to the new templates

Changelog

New sections added

  • Added Content
  • Added Behaviors
  • Added Related
  • Added References

Updated sections

  • Updated all images
  • Updated Overview page—added when to use and when not to use
  • Updated Formatting page—added anatomy, alignment, and placement sections

@vercel
Copy link

vercel bot commented Feb 4, 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/carbon-design-system/carbondesignsystem/GgLxN6n747C8NcxKfzukEzxC2ut9
✅ Preview: https://carbondesignsy-git-fork-kingtraceyj-radio-button-usage-u-a71985.vercel.app

Copy link
Member

@tw15egan tw15egan left a comment

Choose a reason for hiding this comment

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

LGTM 👍 ✅

Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

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

Looks good to me! 🚀

Copy link
Contributor

@janchild janchild left a comment

Choose a reason for hiding this comment

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

@kingtraceyj for the description can we change the end of the sentence to read "only one selection from the group can be made." Sorry I didn't pick that up earlier. Reviewing the rest now.

Copy link
Contributor

@janchild janchild left a comment

Choose a reason for hiding this comment

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

@kingtraceyj This looks fantastic. I love the Related section. I just had a couple of very minor content tweaks. Otherwise it's fab!

src/pages/components/radio-button/usage.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@janchild janchild left a comment

Choose a reason for hiding this comment

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

🥂

Copy link
Contributor

@jeanservaas jeanservaas left a comment

Choose a reason for hiding this comment

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

Great job Tracey, just a couple of things!

In this image in particular, I noticed that you have two scales represented, e.g. the header bar is even smaller than that input field at the bottom of the image. So I would try to align the scale of the page content with the header so it looks more realistic as an in-context usage image.

image

You could either show the whole UI like Lauren does with checkbox and just scale the xlg design down to fit (I have a percentage for the 8 column images in that production file)

image

or just make sure you're show part of a real UI, so if any scaling is done, it's done together

Here's an example from button usage:

image

I'd also give these examples a little more room...

image

I'd match the size of the canvas to this one so it can breathe a little more

image

Otherwise looks great!

kingtraceyj and others added 9 commits March 12, 2021 11:50
updated: docs and images
updated all the images
Co-authored-by: Jan Child <44503588+janchild@users.noreply.github.com>
updated alignment copy
updated example image 1 and multiline image 11
@jeanservaas
Copy link
Contributor

Looks great!

@kingtraceyj This is the tiniest little change:

image

Right now the input field looks like it's the same height as the header bar... which would make the input field 48px when it would actually be 40px. To get the relationship right, I'd just grab both an input field and a header bar from the kit and scale them down proportionally just to get that relationship right.

I'm going to approve because I'll be out next week, but just that little update and it'll be perfect!!!

2 similar comments
@jeanservaas
Copy link
Contributor

Looks great!

@kingtraceyj This is the tiniest little change:

image

Right now the input field looks like it's the same height as the header bar... which would make the input field 48px when it would actually be 40px. To get the relationship right, I'd just grab both an input field and a header bar from the kit and scale them down proportionally just to get that relationship right.

I'm going to approve because I'll be out next week, but just that little update and it'll be perfect!!!

@jeanservaas
Copy link
Contributor

Looks great!

@kingtraceyj This is the tiniest little change:

image

Right now the input field looks like it's the same height as the header bar... which would make the input field 48px when it would actually be 40px. To get the relationship right, I'd just grab both an input field and a header bar from the kit and scale them down proportionally just to get that relationship right.

I'm going to approve because I'll be out next week, but just that little update and it'll be perfect!!!

Copy link
Contributor

@jeanservaas jeanservaas left a comment

Choose a reason for hiding this comment

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

i had one little tweak and you made it! Great work!

@kingtraceyj kingtraceyj merged commit b74ab46 into carbon-design-system:main Mar 12, 2021
natashadecoste pushed a commit to natashadecoste/carbon-website that referenced this pull request May 19, 2021
* Update usage.mdx

* Update usage.mdx

* Update usage.mdx

* Updated docs and images

updated: docs and images

* Radio button image update

updated all the images

* Update src/pages/components/radio-button/usage.mdx

Co-authored-by: Jan Child <44503588+janchild@users.noreply.github.com>

* Update usage.mdx

updated alignment copy

* Update usage.mdx

* image updates

updated example image 1 and multiline image 11

* updated: image

Co-authored-by: Jan Child <44503588+janchild@users.noreply.github.com>
natashadecoste pushed a commit to natashadecoste/carbon-website that referenced this pull request May 19, 2021
* Update usage.mdx

* Update usage.mdx

* Update usage.mdx

* Updated docs and images

updated: docs and images

* Radio button image update

updated all the images

* Update src/pages/components/radio-button/usage.mdx

Co-authored-by: Jan Child <44503588+janchild@users.noreply.github.com>

* Update usage.mdx

updated alignment copy

* Update usage.mdx

* image updates

updated example image 1 and multiline image 11

* updated: image

Co-authored-by: Jan Child <44503588+janchild@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[radio button] update usage tab docs
5 participants