Add dark-src and light props to figure-img component

Pedro Moreira da Silvarequested to merge
figure-img-dark-light-mode-support into main

What does this MR do?

As a follow-up to !5780 (comment 3217581620), add dark-src and light props to figure-img component to ensure proper contrast, regardless of mode.

Add a dark-src prop that conditionally renders a different image based on the active color mode. When dark mode is enabled and dark-src is provided, it is used instead of src. Existing usages with only src continue to work unchanged.

Add a light prop that applies a light background to the figure, mirroring the existing dark prop behavior.

Add tests for the figure-img component covering all props, slots, and dark mode switching behavior.

Update README and example page documentation to describe the dark, light, and dark-src props.

Screenshots or screen recordings

After screenshots show 3 images as examples:

  1. Figure that toggles between light and dark images based on mode.
  2. Light figure that maintains light background, regardless of mode.
  3. Dark figure that maintains dark background, regardless of mode.
Before (Dark) After (Light) After (Dark)
CleanShot 20260403121532@2x.png CleanShot 20260403121500@2x.png CleanShot 20260403121509@2x.png

Integrations

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

  • The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
    • For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
  • Relevant label(s) are applied to the MR.
  • The MR is added to a milestone.
  • Added the ~"component:*" label(s) if applicable.
  • A changeset is added when this MR will do a patch, minor, or major update. More information can be found in doc/publishing-packages.md.

Components

  • GitLab UI's contributing guidelines.
  • If the MR changes a component's API, integration MR(s) have been opened (see integrations above).

Documentation

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.

Slack message

Enhanced by https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.com/-/merge_requests/5814. to allow toggling between light and dark images depending on mode. After that MR is merged, When you add images to Pajamas docs, to ensure proper contrast in light and dark modes, use these new attributes in the `figure-img` component:

* `dark-src` for the dark mode version of the image. Must be paired with `src` for the light mode image. This automatically shows the right image based on the current mode.
* `dark` attribute if you don't have a light mode image and want to ensure contrast of a dark mode image, regardless of mode.
* `light` attribute — same as `dark` but for light-mode-only images.
Edited by Pedro Moreira da Silva

Merge request reports