Image component refactor

[joshfarrant]

Summary

Refactor Image component to simplify its API, improve maintainability, and reduce the number of edge-cases due to conflicting props.

List of notable changes:

• Fixed the border radius of the Card.Image component. It was previously possible for the div that wraps the image and the image itself to have different border radii (that's not a word I get to write often).
• Removed the as, media, and sources props, as well code paths which render a <picture> element. This element added complexity to the implementation without providing any real benefit over a native HTML approach. If a user wants to use a <picture> element with the updated Image component, they can simply use the <picture> element directly, for example:

  <picture>
    <source srcSet="..." media="..." />
    <Image src="..." alt="..." />
  </picture>

What should reviewers focus on?

• Ensure that there are no visual regressions on components which use the Image component
• Ensure that any components which relied on now removed props (aspectRatio, as, media, and sources) are updated to use the new API
• Ensure that the Card.Image component is still styled correctly after the changes

Supporting resources (related issues, external links, etc):

• 🐛 [BUG] - Image as picture does not use the "height" prop #604

Contributor checklist:

• All new and existing CI checks pass
• Tests prove that the feature works and covers both happy and unhappy paths
• Any drop in coverage, breaking changes or regressions have been documented above
• New visual snapshots have been generated / updated for any UI changes
• All developer debugging and non-functional logging has been removed
• Related issues have been referenced in the PR description

Reviewer checklist:

• Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
• Check that tests prove the feature works and covers both happy and unhappy paths
• Check that there aren't other open Pull Requests for the same update/change

Screenshots:

Please try to provide before and after screenshots or videos

Before	After

[changeset-bot]

🦋 Changeset detected

Latest commit: 0b4584e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
@primer/react-brand	Minor
@primer/brand-primitives	Minor
@primer/brand-e2e	Minor
@primer/brand-fonts	Minor
@primer/brand-config	Minor
@primer/brand-storybook	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

🟢 No design token changes found

[github-actions]

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences