Skip to content

Gallery

Responsive image/video gallery with optional lightbox mode.

Import from hedron import Gallery
Distribution hedron
Backend activity No
Normal render mode RenderMode.FRAGMENT

Live demo

GalleryResponsive image/video gallery with optional lightbox mode.

The preview is a local docs simulation (not a running Hedron server). Interactive demos show a “Simulated HTMX” trace when applicable.

Basic use

from hedron import Gallery

component = Gallery([])

Compose under Page for full documents, or return from a fragment route for HTMX swaps.

How it works

Phase 0.15 surface. Prefer native HTML semantics and ordinary HTTP actions.

This component's core behavior is server-rendered HTML and does not require a browser runtime. The preview is ordinary semantic HTML, so keyboard, form, link, and disclosure behavior comes from the platform.

Constructor and parameters

Gallery(items: 'Sequence[GalleryItem | Mapping[str, Any]]', *, lightbox: 'bool' = False, mark: 'str | None' = None, class_: 'str | None' = None, **kwargs: 'object') -> 'None'
Parameter Type Meaning
items Sequence[GalleryItem | Mapping[str, Any]] Gallery items (GalleryItem or mapping records).
lightbox bool Whether clicking an item opens a lightbox details UI. Default: False.
mark str | None Optional stable test mark (data-hedron-mark). Default: None.
class_ str | None Optional CSS class string (class in HTML). Default: None.

Composition and backend behavior

Keep Gallery at the smallest semantic boundary. Fragment routes should return only the replaced region and preserve stable target IDs across success, validation, empty, loading, and error responses.

This component is primarily presentational; keep any mutation on an explicit action or component route.

Accessibility

Keyboard and screen-reader operable; no-JS fallback required where interactive.

Security

Escaping and SafeUrl / TrustedHtml are framework concerns; authorization and data exposure remain application code. Redact secrets before rendering.

Common mistakes

  • Do not treat client-only hints (geolocation, browser storage) as authorization.
  • Do not copy docs-preview JavaScript into an application server.

Testing

from hedron import RenderMode, render

result = render(component, mode=RenderMode.FRAGMENT)
assert result.html
assert not result.diagnostics

All component demos · Built-in API · Testing