SearchCtrlK

  • ↑↓navigate
  • ↵open
  • escclose

Can’t find it? Contact us

lightboxControls

Script layer for a Lightbox <dialog>.

tsx
import { lightboxControls } from "@sdxc/ui/mixins";

1 / 5Fern Cabin at dusk
2 / 5Living room
3 / 5Sleeping loft
4 / 5Private dock
5 / 5Trail to the falls
View code
tsx
// 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

typescript
lightboxControls(): MixinDescriptor<HTMLElement>

Examples

tsx
<dialog id="photos">
	<span hidden mix={[lightboxControls()]} />
	<div data-lightbox-track>…</div>
</dialog>

The events, constants and types its module publishes, each imported from @sdxc/ui/mixins too.

Constant

LIGHTBOX_TRACK_ATTRIBUTE

Attribute on the scroll-snap track holding every slide.

typescript
const LIGHTBOX_TRACK_ATTRIBUTE = "data-lightbox-track"
Constant

LIGHTBOX_SLIDE_ATTRIBUTE

Attribute on each slide, in photo order.

typescript
const LIGHTBOX_SLIDE_ATTRIBUTE = "data-lightbox-slide"
Constant

LIGHTBOX_INDEX_ATTRIBUTE

Attribute a trigger carries naming the zero-based photo it opens at.

typescript
const LIGHTBOX_INDEX_ATTRIBUTE = "data-lightbox-index"
Constant

LIGHTBOX_STEP_ATTRIBUTE

Attribute a step link carries naming the zero-based photo it scrolls to.

typescript
const LIGHTBOX_STEP_ATTRIBUTE = "data-lightbox-to"
Constant

LIGHTBOX_INITIAL_ATTRIBUTE

Attribute on the dialog naming the photo a server-opened viewer starts on.

typescript
const LIGHTBOX_INITIAL_ATTRIBUTE = "data-lightbox-initial"
Constant

LIGHTBOX_STATUS_ATTRIBUTE

Attribute on the polite live region that names the photo in view.

typescript
const LIGHTBOX_STATUS_ATTRIBUTE = "data-lightbox-status"
Constant

LIGHTBOX_ANNOUNCE_ATTRIBUTE

Attribute on each slide's counter and caption, read into the announcement.

typescript
const LIGHTBOX_ANNOUNCE_ATTRIBUTE = "data-lightbox-announce"
@sdxc/ui

Can’t find it? Contact us