Skip to content

feat(GlTooltip): add custom global container selector

Stanislav Lashmanovrequested to merge
slashmanov/custom-default-container-for-gl-tooltip into main

What does this MR do?

This MR adds a customizable global container selector for GlTooltip component and directive.

This change is important to mitigate performance issues caused by GlTooltip. Specifically, GlTooltip can cause excessive layout recalculations (Tooltips cause complete page reflow section) because it is placed at the end of <body> and triggers offsetParent on that element, which itself causes a global style recalculation of the whole page.

image

This is very expensive for pages with lots of elements, so we have to find a new location to render tooltips.

A new setGlTooltipDefaultContainer function will allow us to do just that: we can set a custom container selector which will hold all tooltips and not cause excessive style calculations (offsetParent will be cheaper on any other non-root element). Custom container argument is still respected and can override the default container.

Screenshots or screen recordings

No visual change.

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 Stanislav Lashmanov

Merge request reports