lightboxControls
Script layer for a Lightbox <dialog>.
import { lightboxControls } from "@sdxc/ui/mixins";View code
// Lightbox's dialog carries lightboxControls(): open a photo, then press ← and →.
<div>
{photos.map((photo, index) => (
<Lightbox.Trigger lightbox="fern-cabin" index={index} aria-label={`Open photo ${index + 1}`}>
<img src={photo.thumb} alt="" />
</Lightbox.Trigger>
))}
<Lightbox.Trigger lightbox="fern-cabin">Show all photos</Lightbox.Trigger>
</div>
<Lightbox
id="fern-cabin"
label="Photos of Fern Cabin"
photos={photos.map((photo) => ({ src: photo.src, alt: photo.alt, caption: photo.caption }))}
/>Usage
Attaches the viewer behavior to the <dialog> the host sits in, from insertion until
removal. A dialog the server rendered open at a photo is upgraded to a modal there.
Signature
lightboxControls(): MixinDescriptor<HTMLElement>Examples
<dialog id="photos">
<span hidden mix={[lightboxControls()]} />
<div data-lightbox-track>…</div>
</dialog>Used with it
The events, constants and types its module publishes, each imported from @sdxc/ui/mixins too.
LIGHTBOX_TRACK_ATTRIBUTE
Attribute on the scroll-snap track holding every slide.
const LIGHTBOX_TRACK_ATTRIBUTE = "data-lightbox-track"LIGHTBOX_SLIDE_ATTRIBUTE
Attribute on each slide, in photo order.
const LIGHTBOX_SLIDE_ATTRIBUTE = "data-lightbox-slide"LIGHTBOX_INDEX_ATTRIBUTE
Attribute a trigger carries naming the zero-based photo it opens at.
const LIGHTBOX_INDEX_ATTRIBUTE = "data-lightbox-index"LIGHTBOX_STEP_ATTRIBUTE
Attribute a step link carries naming the zero-based photo it scrolls to.
const LIGHTBOX_STEP_ATTRIBUTE = "data-lightbox-to"LIGHTBOX_INITIAL_ATTRIBUTE
Attribute on the dialog naming the photo a server-opened viewer starts on.
const LIGHTBOX_INITIAL_ATTRIBUTE = "data-lightbox-initial"LIGHTBOX_STATUS_ATTRIBUTE
Attribute on the polite live region that names the photo in view.
const LIGHTBOX_STATUS_ATTRIBUTE = "data-lightbox-status"LIGHTBOX_ANNOUNCE_ATTRIBUTE
Attribute on each slide's counter and caption, read into the announcement.
const LIGHTBOX_ANNOUNCE_ATTRIBUTE = "data-lightbox-announce"