[go: up one dir, main page]

chore: fix storybook vue 3 GlToggle

Marina Mostirequested to merge
marina.mosti-2618-toggle-vue3-sb into main

What does this MR do?

Fixes the GlToggle storybook entry

The original issue incorrectly assumes that GlToggle needs to be updated to work with Vue 3. However with vue/compat we have successfully used the component throughout the Switchboard codebase several times.

Updating the component to use update:modelValue bindings would only work if we want to prepare fully for non-compat mode, but since that is further down the line at this point we can ensure at least that the component is working under compat.

The underlying problem here is storybook, this is a known issue with Vue 3 since version 7 where the bindings of the args need to be done differently.

To be able to accomplish this a new env variable prefixed by STORYBOOK_ needs to be created, as VUE_ and other env variables are not caught by storybook at all. The configuration within main.js allows us to rename this to USE_VUE_3 which is what we are already using in other places - so I kept this for consistency.

Screenshots or screen recordings

Vue 2 Vue 3
Screen_Recording_2024-11-14_at_15.49.12 Screen_Recording_2024-11-14_at_15.53.32

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.

Merge request reports