Skip to content

refactor(GlChartTooltip): Tooltip calculates its own position

Miguel Rincon requested to merge 2230-charts-tooltip-cannot-display-in-edge-browser into main

What does this MR do?

Related to #2230 (closed)

This refactor modifies the chart tooltip code to make the tooltip responsible for it's own rendering and position by default.

Currently, many charts have a too wide responsibility as they must calculate the position on which their tooltips are shown, which causes code repetition and makes our code prone to errors.

This change only refactors the area chart usage of the tooltip, but a follow up change can clean up duplicated code from other charts. This change is backwards compatible, so user charts can be updated gradually.

Browser testing

I tested this manually on the major browsers just in case, we also have Cypress tests helping us for Chrome and Firefox automatically.

Screenshots or screen recordings

The area chart, which has been migrated but has no change in behavior or appearance:

image

The bar chart, which hasn't been migrated but has no change in behavior or appearance:

image

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.
Edited by Miguel Rincon

Merge request reports