Image source, relative to public/ or an absolute URL.
Image Zoom
1 min readStableBeginner
The ImageZoom component adds a click-to-zoom lightbox to any image. Clicking
opens a fullscreen overlay so readers can examine screenshots and diagrams
without leaving the page.
Quick Start
Wrap an image with the component.
MDX
MDX
<ImageZoom src="/img/screenshot.png" alt="Application screenshot" />Adding Options
Constrain the thumbnail with explicit dimensions; the lightbox still scales to fit the viewport.
MDX
MDX
<ImageZoom
src="/img/architecture-diagram.png"
alt="System architecture diagram"
width={800}
height={600}
/>Advanced
The lightbox is an accessible dialog: role="dialog", aria-modal="true",
focus moves to the close button, focus is trapped, and Escape or clicking the
backdrop closes it. Body scroll locks while open.
Options
srcstringrequiredaltstringAccessible alt text.
widthnumberThumbnail width in pixels.
heightnumberThumbnail height in pixels.
Related pages
Was this page helpful?