Skip to content

Draft: feat(GlListContainer?!): Create new list component [NAME TBD]

Sascha Eggenberger requested to merge new-card into main

What does this MR do?

Updates the GlCard's appearance to match the «gl-new-card» variant we use across the product, e.g.:

Why this change?

As a next step after updating widgets in the product on issuables and migrating settings pages using lists of items to use the new GlCard style, we need to update the card component in GitLab UI to unify the experience again.

What's new?

  • This MR introduces different variants to GlCard to be more versatile
  • Adds new slots: #actions, #form, #empty
  • Adds new optional props: variant, title, icon, count, description, formClass
  • Keeps the design of the default variant close to the original (no background changes) to make sure we don't visually break things in the product until migration is done in next step (see integration plan below)

Integration plan

  1. Merge this MR to update GlCard
  2. Remove manual overrides from product and switch those instances to the corresponding variants (default / list)
  3. Update custom card integrations/legacy bootstrap integrations to new variants in the product
  4. Set default variant from «Legacy» to «Default»
  5. Create component in Figma
  6. Update Pajamas

Screenshots or screen recordings

Before After
before legacy

Added variants

Variants
Legacy: Default until migration is complete legacy
Default: New default when migration is complete default
List: Same as default but without the spacing on body so placed components can use the full width and height without spacing list
Simple: Simple card without bg colors simple

Added examples

New examples
Slots example_slots
List example example_list
Simple example example_simple

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.

Related to gitlab#398215 (closed)

Edited by Sascha Eggenberger

Merge request reports