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

Incorrect example shown in the Button component #2638

Closed
tomwaterton opened this issue Nov 12, 2021 · 2 comments · Fixed by #3331
Closed

Incorrect example shown in the Button component #2638

tomwaterton opened this issue Nov 12, 2021 · 2 comments · Fixed by #3331

Comments

@tomwaterton
Copy link
Contributor

Summary

Relevant information

Link to the page and section this issue relates to: Components > Button > Content

The guidance correctly says that best practice is to use the {verb} + {noun} content formula on buttons (except in the case of common actions like “Done”, “Close”, “Cancel”, “Add”, or “Delete”).

All well and good.

Then there is a good and bad example image provided:

Screenshot 2021-11-12 at 06 19 41

The good example is fine and helpful.

However, in the case of the bad example, the caption reads

Do not use only a noun as a button label.

Yet the image does not show a button label with just a noun used. What it shows is a button with the label Create (a verb).

I suggest that we need to do one of the following to fix this:

  • Replace the "bad" example image with an image that shows a button with a label that only used a noun. For example, a button with the label Dashboard or Report or some such (which clearly would be bad and wrong — in such cases it would appear that a link to another page in the UI was being provided but incorrectly styled as a button)... However, I do question whether we really need to provide a bad example of this type, as I don't remember ever seeing any IBM product where someone had used just a noun on its own as a button label.
  • So, the other option would be to just keep the good example and simply remove the bad example.
@aagonzales
Copy link
Member

Update the button label in the bad image example to say "Resources" instead of "create" to match example text.

@aagonzales
Copy link
Member

Hey team! Please add your planning poker estimate with ZenHub @laurenmrice @thyhmdo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants