Skip to content
Documentation
Packages
nextra-theme-docs
Writing Content
Image Frame

Image Frame

Use the Frame component to wrap images or other components in a container

A couple of people walking down a street at night

<ImageFrame
src="https://images.unsplash.com/photo-1687186735445-df877226fae9?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D&auto=format&fit=crop&w=1470&q=80"
alt="A couple of people walking down a street at night"
width={1470}
height={980}
/>

Captions
Permalink for this section

You can add additional context to an image using the optional caption prop.

A couple of people walking down a street at night

A couple of people walking down a street at night


<ImageFrame
src="https://images.unsplash.com/photo-1687186735445-df877226fae9?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D&auto=format&fit=crop&w=1470&q=80"
alt="A couple of people walking down a street at night"
caption="A couple of people walking down a street at night"
width={1470}
height={980}
/>

API
Permalink for this section

The ImageFrame component takes the following props:

src (required)
Permalink for this section

The source of the image to display.

alt (optional)
Permalink for this section

The alt text for the image.

width (required only if the image is external link)
Permalink for this section

The width of the image.

height (required only if the image is external link)
Permalink for this section

The height of the image.

caption (optional)
Permalink for this section

An optional caption to display below the image.

zoomable (optional) (default: true)
Permalink for this section

An optional boolean to disable/enable zooming on the image.