Image

Use Image when you need more control than basic Markdown image syntax.

Overhead shot of moody plants
Moody plants
<Image  src="/images/plants.jpg"  alt="Overhead shot of moody plants"  title="Moody plants"/>

Basic usage

Provide src and alt

src is required. Always include meaningful alt text for accessibility.

Overhead shot of moody plants
<Image  src="/images/plants.jpg"  alt="Overhead shot of moody plants"/>

Add a caption

Use title to show a caption below the image.

Overhead shot of moody plants
Photo by Nico Knaack
<Image  src="/images/plants.jpg"  alt="Overhead shot of moody plants"  title="Photo by [Nico Knaack](https://unsplash.com/@xoxnk)"/>

Control size and behavior

Constrain width

Pass width (in pixels) to keep large images from taking too much space.

Surreal architecture framed through a circular opening
<Image  src="/images/surreal_architecture.jpg"  alt="Surreal architecture framed through a circular opening"  width={350}/>

Disable click-to-zoom

Set zoom={false} when you want the image to remain static.

Overhead shot of moody plants
Zoom disabled
<Image  src="/images/plants.jpg"  alt="Overhead shot of moody plants"  title="Zoom disabled"  zoom={false}/>

Props

PropDescriptionTypeDefault
srcImage source path or URL.string
altAlternative text for accessibility.string
titleCaption text shown below the image. Supports inline Markdown.string
widthMax rendered width in pixels.number | string
zoomEnables click-to-zoom overlay behavior.booleantrue

Supported Props Only

Image only supports src, alt, title, width, and zoom. Unsupported props will throw a user-facing validation error.