Skip to content

Add image props documentation for Card component #1425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 24, 2025
Merged

Add image props documentation for Card component #1425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c6a00c
docs: add image props documentation for Card component
devin-ai-integration[bot] Oct 24, 2025
f73117d
Update 2025-10-23.mdx
chdeskur Oct 24, 2025
ae225ea
Update cards.mdx
chdeskur Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions fern/products/docs/pages/component-library/default-components/cards.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,56 @@
</Tab>
</Tabs>

## Adding images to cards

Cards support displaying images alongside content. The image automatically resizes to fit the card dimensions, so you typically don't need to specify `imageWidth` or `imageHeight` unless you want to override the default behavior.

<Tabs>
<Tab title="Card with image">
<Card
title="Product Overview"
src="https://images.unsplash.com/photo-1517694712202-14dd9538aa97"
imagePosition="left"
>
Display an image alongside your card content. The image automatically scales to fit the card.
</Card>
</Tab>
<Tab title="Markdown">
```jsx
<Card
title="Product Overview"
src="https://images.unsplash.com/photo-1517694712202-14dd9538aa97"
imagePosition="left"
>
Display an image alongside your card content. The image automatically scales to fit the card.
</Card>
```
</Tab>
</Tabs>

<Tabs>
<Tab title="Card with image on top">
<Card
title="Getting Started"
src="https://images.unsplash.com/photo-1498050108023-c5249f4df085"
imagePosition="top"
>
Position the image at the top of the card for a banner-style layout.
</Card>
</Tab>
<Tab title="Markdown">
```jsx
<Card
title="Getting Started"
src="https://images.unsplash.com/photo-1498050108023-c5249f4df085"
imagePosition="top"
>
Position the image at the top of the card for a banner-style layout.
</Card>
```
</Tab>
</Tabs>

## Properties

<ParamField path="title" type="string">
Expand All @@ -100,3 +150,15 @@
<ParamField path="lightModeColor" type="string">
Hex color value for the icon in light mode (e.g. `#FF0F00`)
</ParamField>
<ParamField path="src" type="string">
URL of the image to display in the card. When set, the card displays the image alongside the content.
</ParamField>
<ParamField path="imagePosition" type="'top' | 'left' | 'right' | 'bottom'" default="top">
Position of the image relative to the card content. Use `imagePosition` to control the layout.
</ParamField>
<ParamField path="imageWidth" type="string">
Width of the image (e.g. `200px`, `50%`). Only use if you need to override the default sizing. The image automatically resizes to fit the card by default.

Check failure on line 160 in fern/products/docs/pages/component-library/default-components/cards.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.", "location": {"path": "fern/products/docs/pages/component-library/default-components/cards.mdx", "range": {"start": {"line": 160, "column": 23}}}, "severity": "ERROR"}
</ParamField>
<ParamField path="imageHeight" type="string">
Height of the image (e.g. `150px`, `100%`). Only use if you need to override the default sizing. The image automatically resizes to fit the card by default.

Check failure on line 163 in fern/products/docs/pages/component-library/default-components/cards.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.", "location": {"path": "fern/products/docs/pages/component-library/default-components/cards.mdx", "range": {"start": {"line": 163, "column": 24}}}, "severity": "ERROR"}
</ParamField>
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/java/changelog/2025-10-23.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 3.9.2
**`(fix):`** Fix nullable field serialization in PATCH requests with wrapped request bodies. Explicit null values
(Nullable.ofNull()) are now correctly serialized as {"field": null} instead of being omitted like
(Nullable.ofNull()) are now correctly serialized as `{"field": null}` instead of being omitted like
Nullable.empty().


Expand Down