Skip to content

feat(GlTokenSelector): Add `showAddNewAlways` prop

Zack Cuddy requested to merge cuddyz-token-selector-support-new-button-always into main

What does this MR do?

Implemented to provide solution for customer: gitlab#386864 (closed)

This MR adds the prop showAddNewAlways to GlTokenSelector which enables the ability for users to add new tokens regardless if there are currently results in the list.

Implementation Goals

Overall the goal of this MR is to allow for the Addition of Tokens to be made possible even if results exists in the list. Additionally the follow technical changes were added:

  1. Isolate a SSoT for when a token can be added or not in the token_selector.vue. From here we simply manage this Boolean throughout the component rather than duplicating checks throughout both the selector and the selector dropdown.
  2. Properly treat the user defined token dropdown item as a list item in the dropdown. This allows for proper keyboard navigation and tab to exist the dropdown as intended.
  3. By treating the user defined token dropdown item as an item in the list we can remove the bulk of the conditional logic in our event handlers that have alternative paths for user defined tokens. In this the user defined token gets treated the same.

Additionally, this change works to refine the Storybook a bit with more examples and documentation around user created tokens and how to use them.

Screenshots or screen recordings

Before After
Bug Fix Before_-_BUG After_-_Bug_Fix

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 Zack Cuddy

Merge request reports