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

Tooltip: Usage tab #3412

Closed
19 tasks done
Tracked by #13521
sstrubberg opened this issue Mar 2, 2023 · 0 comments
Closed
19 tasks done
Tracked by #13521

Tooltip: Usage tab #3412

sstrubberg opened this issue Mar 2, 2023 · 0 comments

Comments

@sstrubberg
Copy link
Member

sstrubberg commented Mar 2, 2023

Ref issue: #3332
Ref Usage tab PDF comments: https://ibm.ent.box.com/file/1000660824957?s=p07zoqxau8xw7ounitiwr9ha2i5tyqsj


Usage tab

Overall high level comments

  • Remove all image examples and references using the info icon.
  • Remove most references of "popover" to clean up content.

Description

  • Update wording

Overview

  • Update image to use the image that is currently in the "When to use" section. And rewrite paragraph as follows:

Although Carbon tooltips previously allowed for interactive elements such as buttons and links, do not include these elements in tooltips; use toggle tips instead.

  • When to use: Reword the first line "Describe icon buttons", to be more along the lines of "Expose names of controls that lack labels." Remove image.
  • When not to use: Change first don't image to have focus on the input field, to which it then reveals the helper text in a tooltip.
  • Tooltips versus Toggletips: Add a image to visually show the difference between the two.
  • Variants: Remove "Standard tooltip". Remove from content and image example.

Formatting

  • Standard tooltip anatomy: Update section to clearly state content in this tooltip can not be critical to user workflows/completing tasks. It is simply additional/option information for the user to view.
  • Definition tooltip anatomy: Specify the underline is dotted and that it can be activated on hover or focus.
    Placement:
    • To be placed in view. Omit the word "properly".
    • The image caption should say "Tooltip containers can be automatically or manually positioned to the right, left, bottom, or top."
    • The paragraph under the image is confusing and talks about Toggletips and not Tooltips, revise this section more.
    • The image under this section should have a period in the tooltip.

Content

  • Text: Revise section with PDF comments.

Universal behaviors

  • Keyboard: Revise section with PDF comments.
  • Screen readers: Remove section.

Standard tooltip

  • Add more guidance of when and why to use this.

Icon button and Definition tooltip

  • Revise section with PDF comments.
@sstrubberg sstrubberg moved this to ⏱ Backlog in Design System Mar 2, 2023
@sstrubberg sstrubberg added this to the 2023 Q2 milestone Mar 29, 2023
@sstrubberg sstrubberg modified the milestones: 2023 Q2, 2023 Q3 Jun 28, 2023
@laurenmrice laurenmrice self-assigned this Jun 28, 2023
@laurenmrice laurenmrice changed the title Tooltip: docs updates Tooltip: Usage tab Jul 5, 2023
@laurenmrice laurenmrice moved this from ⏱ Backlog to 🏗 In Progress in Design System Jul 5, 2023
@laurenmrice laurenmrice moved this from 🏗 In Progress to 🚦 In Review in Design System Jul 19, 2023
@laurenmrice laurenmrice moved this from 🚦 In Review to 🏗 In Progress in Design System Jul 31, 2023
@laurenmrice laurenmrice moved this from 🏗 In Progress to 🚦 In Review in Design System Aug 22, 2023
@laurenmrice laurenmrice moved this from 🚦 In Review to ✅ Done in Design System Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

2 participants