Skip to content

feat(GlPopover): top placement by default

Miguel Rincon requested to merge mrincon-default-popover-placement into main

What does this MR do?

Before, we inherited the default 'right' placement from Vue Bootstrap, but this was not correct in our design system.

This MR moves the popover to be above the element by default.

image

By default, popovers should be placed above the referring element.

Source: https://design.gitlab.com/components/popover#appearance, https://bootstrap-vue.org/docs/components/popover#comp-ref-b-popover-props

Related: gitlab#350184 (comment 897196975)

Impact on gitlab-org/gitlab

A cursory check shows that many usages of <gl-popover> in gitlab-org/gitlab define a placement already, so the impact of this change is limited: to about 10 popovers in our project.

  • Usages of gl-popover with placement (<gl-popover(.|\n)*?placement(.|\n)*?>): 60 results in 56 files
  • All usages gl-popover <gl-popover(.|\n)*?(.|\n)*?>: 70 results in 66 files

(This search is not exactly precise, just an idea of the order of magnitude of changes)

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • 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 in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • 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