Skip to content

Draft: Proposal: Label tooltip improvements

Chad Lavimoniere requested to merge 2431-2434-label-tooltip-improvements into main

What does this MR do?

This MR proposes a few improvements to Label description tooltips:

  • Always show label title in tooltip when there is a description ( #2434)
  • When a url is present in the label description, render a link in the tooltip ( #2431 (closed))

One point of conversation is that this change would remove the callout that indicates that the label is a scoped label. It is not clear whether or not that is an important distinction to make in the label tooltip, but text can be added back to the tooltip to distinguish if it is necessary.

Screenshots or screen recordings

Type Before After
Regular label with description Screenshot_2023-12-06_at_14.23.17 Screenshot_2023-12-06_at_14.22.10
Scoped label with description Screenshot_2023-12-06_at_14.22.59 Screenshot_2023-12-06_at_14.22.31
Real world example from our team Screenshot_2023-12-06_at_14.00.48 Screenshot_2023-12-06_at_14.48.49

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above).
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.

To reproduce

  1. Check out this branch locally 
    git fetch origin
git checkout -b '2431-2434-label-tooltip-improvements' 'origin/2431-2434-label-tooltip-improvements'
  2. yarn storybook and navigate to http://localhost:9001/?path=/docs/base-label--docs
  3. In the storybook controls, enter a description that contains a url, for example Hello world https://gitlab.com
  4. Hover over the label to reveal the tooltip
  5. Toggle the "scoped" boolean in the storybook controls and edit the label title to something like scoped::label
  6. Hover over the label to reveal the tooltip again

Closes #2431 (closed) Closes #2434

Edited by Chad Lavimoniere

Merge request reports