Add alt text support to card covers #3715

Site	`2v`	`2c`
GitBook	https://gitbook-v2-2galfpcng-gitbook.vercel.app/url/gitbook.com/docs	https://ced30468-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs
E2E	https://gitbook-v2-2galfpcng-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open	https://ced30468-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.gitbook.io/test-gitbook-open

@nolannbiron nolannbiron had a problem deploying to 2v-preview

October 11, 2025 10:10

— with GitHub Actions Failure

@nolannbiron nolannbiron had a problem deploying to 2c-preview

October 11, 2025 10:10

— with GitHub Actions Failure

@nolannbiron nolannbiron force-pushed the nolann/add-alt-support-for-cards branch from 4ab0458 to 3d16de8 Compare

October 23, 2025 15:18

@nolannbiron nolannbiron had a problem deploying to 2c-preview

October 23, 2025 15:18

— with GitHub Actions Failure

@nolannbiron nolannbiron had a problem deploying to 2v-preview

October 23, 2025 15:18

— with GitHub Actions Failure

@nolannbiron nolannbiron force-pushed the nolann/add-alt-support-for-cards branch from 3d16de8 to fea7388 Compare

October 23, 2025 15:19

@nolannbiron nolannbiron had a problem deploying to 2c-preview

October 23, 2025 15:19

— with GitHub Actions Failure

@nolannbiron nolannbiron had a problem deploying to 2v-preview

October 23, 2025 15:19

— with GitHub Actions Failure

@nolannbiron nolannbiron deployed to 2v-preview

October 23, 2025 15:22

— with GitHub Actions View deployment

@nolannbiron nolannbiron deployed to 2c-preview

October 23, 2025 15:22

— with GitHub Actions View deployment

@argos-ci

Copy link

argos-ci bot commented Oct 23, 2025 •

edited

Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
customers-v2 (Inspect)	👍 Changes approved	1 changed	Oct 24, 2025, 1:18 PM
v2-cloudflare (Inspect)	👍 Changes approved	3 changed	Oct 24, 2025, 1:21 PM
v2-vercel (Inspect)	👍 Changes approved	2 changed	Oct 24, 2025, 1:20 PM

@nolannbiron nolannbiron requested review from Copilot and gregberge

October 23, 2025 15:29

Copilot AI reviewed

Oct 23, 2025

View reviewed changes

Copy link

Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for alternative text (alt attributes) to card cover images, improving accessibility for users relying on screen readers. The changes update the image type definitions to include an optional alt property and propagate this property through the component hierarchy.

Key Changes:

Extended image source type definitions to include an optional alt property
Updated the Image component to accept and apply alt text from multiple sources with fallback logic
Enhanced table record card cover processing to extract and pass through alt text values

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/gitbook/src/components/utils/Image.tsx	Added `alt` property to image source types and implemented fallback logic for rendering alt text
packages/gitbook/src/components/DocumentView/Table/utils.ts	Updated cover processing to extract and include alt text from image records
packages/gitbook/src/components/DocumentView/Table/RecordCard.tsx	Passed alt text values to image sources for record card covers
packages/gitbook/src/components/DocumentView/InlineIcon.tsx	Removed obsolete TypeScript error suppression comments
package.json	Upgraded @gitbook/api dependency to version 0.146.0
.changeset/proud-kings-know.md	Added changeset documentation for the feature