Skip to content

feat(GlCollapsibleListbox): Allow listbox options to have a null value

Miguel Rinconrequested to merge
mricon-accept-null-option-values into main

What does this MR do?

This fix allows the listbox items to accept "null" values, which can represent a "no value" or "default" state.

Thoughts

  1. This change is backwards compatible.
  2. In !3235 (comment 1245509459) we discussed the type of value, and I didn't see anything that could prevent us from having a null

Why now?

In some cases, like gitlab#469599 (closed), we present lists of filters which include an "any" option or "none" options, that cannot be correctly represented with the current listbox options. I would like to create lists like:

image

With the following data structure:

items = [
  { value: null, text: "All branches" }
  { value: "main", text: "main" }
  { value: "feature-branch", text: "feature-branch" }
]

In gitlab!185800 (merged) I hacked a fix to a related bug, so a "null" value would be represented by the empty string, but an empty string is not the right representation for "none selected". I leverage the fact that a branch cannot be an empty string "", but in other kinds of data an empty string might mean something different from "none selected".

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 Miguel Rincon

Merge request reports