Gallery

Usage

import { Gallery } from "@devvy-ui/react";

<Gallery label="Design studies" images={[{id:'orbit',src:'/examples/orbit.svg',alt:'Orbit study'}]} />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
images	GalleryImage[]	required	Stable ids, source URLs, alt text and optional captions.
label	string	required	Collection name.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add gallery

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

Gallery.tsxREACT / TSX

import { forwardRef, useRef, useState, type HTMLAttributes } from 'react';
import { Lightbox, type GalleryImage } from './Lightbox';
import { safeURL } from '../lib/widgets';
export interface GalleryProps extends HTMLAttributes<HTMLDivElement> {
  label: string;
  images: readonly GalleryImage[];
}
export const Gallery = forwardRef<HTMLDivElement, GalleryProps>(function Gallery(
  { label, images, className, ...props },
  ref,
) {
  const [open, setOpen] = useState(false),
    [index, setIndex] = useState(0),
    invoker = useRef<HTMLButtonElement>(null);
  return (
    <div {...props} ref={ref} className={['dvy-gallery', className].filter(Boolean).join(' ')}>
      <ul aria-label={label}>
        {images.map((image, i) => (
          <li key={image.id}>
            <button
              type="button"
              aria-label={'Open ' + image.alt + (image.caption ? ' ' + image.caption : '')}
              onClick={(event) => {
                invoker.current = event.currentTarget;
                setIndex(i);
                setOpen(true);
              }}
            >
              <img src={safeURL(image.src, true)} alt={image.alt} loading="lazy" />
              {image.caption && <span>{image.caption}</span>}
            </button>
          </li>
        ))}
      </ul>
      {!images.length && <p>No images available.</p>}
      <Lightbox
        open={open}
        onOpenChange={setOpen}
        images={images}
        index={index}
        onIndexChange={setIndex}
        returnFocusRef={invoker}
      />
    </div>
  );
});

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.