Overlays

Lightbox

Full-screen image gallery with thumbnails and keyboard navigation.

Import

tsx

import { Lightbox } from "@cooud-ui/ui";

bash

npx cooud-ui add lightbox

Examples

Gallery

A controlled full-screen gallery: clicking a thumbnail opens the lightbox at that image. Arrow keys (or the on-image controls and thumbnail strip) move between images, and the counter tracks position.

tsx

function LightboxDemo() {
  const [open, setOpen] = useState(false);
  const [index, setIndex] = useState(0);
  const images = [
    { src: "/photos/1.jpg", alt: "Mountain ridge at dawn" },
    { src: "/photos/2.jpg", alt: "Coastline from above" },
    // …
  ];

  return (
    <>
      <div className="grid grid-cols-3 gap-2">
        {images.map((image, i) => (
          <button
            key={image.src}
            type="button"
            onClick={() => {
              setIndex(i);
              setOpen(true);
            }}
          >
            <img src={image.src} alt={image.alt} />
          </button>
        ))}
      </div>
      <Lightbox
        images={images}
        open={open}
        onOpenChange={setOpen}
        index={index}
        onIndexChange={setIndex}
      />
    </>
  );
}

API Reference

Generated from the component's exported types.

LightboxProps

Extends HTMLAttributes<HTMLDivElement>

Prop	Type	Default	Description
`images`*	`LightboxImage[]`	—	The images to display in the gallery.
`open`	`boolean`	—	Controlled open state.
`onOpenChange`	`(open: boolean) => void`	—	Called when the open state should change.
`defaultOpen`	`boolean`	`false`	Uncontrolled initial open state.
`index`	`number`	—	Controlled active image index.
`onIndexChange`	`(index: number) => void`	—	Called when the active index should change.
`defaultIndex`	`number`	`0`	Uncontrolled initial index.