Image
Use Image when you need more control than basic Markdown image syntax.
Basic usage
Provide src and alt
src is required. Always include meaningful alt text for accessibility.
Add a caption
Use title to show a caption below the image.
Control size and behavior
Constrain width
Pass width (in pixels) to keep large images from taking too much space.
Disable click-to-zoom
Set zoom={false} when you want the image to remain static.
Props
| Prop | Description | Type | Default |
|---|---|---|---|
src | Image source path or URL. | string | — |
alt | Alternative text for accessibility. | string | — |
title | Caption text shown below the image. Supports inline Markdown. | string | — |
width | Max rendered width in pixels. | number | string | — |
zoom | Enables click-to-zoom overlay behavior. | boolean | true |
Supported Props Only
Image only supports src, alt, title, width, and zoom.
Unsupported props will throw a user-facing validation error.