Skip to content

fix(GlModal): Define GlModal model

Enrique Alcántara requested to merge define-gl-modal-model into main

What does this MR do?

Defines a model for the modal component that allows using the v-model directive to control the modal’s visibility. The purpose of enabling v-model in the modal component is improving the maintainability of unit tests that interact with the Modal component.

We often follow the pattern of "manually" showing/hiding modals using $refs. The disadvantage of this approach is that it isn’t easy to test unless we inspect the vm object in unit tests.

Using v-model and data binding allows us to test the visibility of the Modal by just checking the value of the visible property.

Integration MR: gitlab!62930 (closed)

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 Enrique Alcántara

Merge request reports