Skip to content

Documentation

react-pic-gallery is a small React image gallery and lightbox with an accessible default experience and composable controls.

Start with Quick start to install the package, import the styles, and render PicGallery with your images.

Want to try it first? The interactive playground pairs working galleries with short, copyable examples.

Guide What you’ll learn
Customization Add actions, captions, and custom controls, or compose the standalone components.
Styling Adjust spacing, colors, and layout using CSS variables and classes.
Accessibility Understand keyboard navigation, focus management, and your responsibilities when adding custom UI.
  • API reference — component props, image types, render callbacks, and controlled lightbox state.
  • Migrating from v1 — update an existing integration to the v2 API.
  • The default integration is one component: PicGallery.
  • Gallery and Lightbox can be composed independently.
  • Custom UI is added through typed render callbacks instead of copied internals.
  • The package has no runtime dependency beyond React and React DOM.