Key features
- Equirectangular and cubemap support — load standard equirectangular JPEGs, cubemap faces, tiled formats, and video panoramas via adapter packages
- Plugin system — extend the viewer with official plugins for markers, virtual tours, galleries, maps, gyroscope, autorotation, and more
- TypeScript — fully typed API including events, adapter configs, and plugin configs
- Three.js powered — WebGL rendering with 60fps navigation and high-DPI support
- Modular packages — install only what you need; all packages are scoped under
@photo-sphere-viewer/* - MIT license — free to use in personal and commercial projects
Packages
The library is split into focused packages. Install the ones you need. Core| Package | Description |
|---|---|
@photo-sphere-viewer/core | The Viewer class, core rendering, and base plugin/adapter infrastructure |
| Package | Description |
|---|---|
@photo-sphere-viewer/cubemap-adapter | Load panoramas as cubemap faces |
@photo-sphere-viewer/cubemap-tiles-adapter | Tiled cubemap loading for large images |
@photo-sphere-viewer/cubemap-video-adapter | Cubemap video panoramas |
@photo-sphere-viewer/equirectangular-tiles-adapter | Tiled equirectangular loading |
@photo-sphere-viewer/equirectangular-video-adapter | Equirectangular video panoramas |
| Package | Description |
|---|---|
@photo-sphere-viewer/autorotate-plugin | Automatic rotation with optional keypoints |
@photo-sphere-viewer/compass-plugin | Compass overlay indicating viewing direction |
@photo-sphere-viewer/gallery-plugin | Thumbnail gallery for navigating multiple panoramas |
@photo-sphere-viewer/gyroscope-plugin | Device orientation / gyroscope control |
@photo-sphere-viewer/map-plugin | Custom image map overlay with hotspots |
@photo-sphere-viewer/markers-plugin | Annotate panoramas with HTML, SVG, or image markers |
@photo-sphere-viewer/overlays-plugin | Static or video image overlays on the panorama |
@photo-sphere-viewer/plan-plugin | Geographic map (OpenStreetMap) with GPS position |
@photo-sphere-viewer/resolution-plugin | Switch between panorama resolutions |
@photo-sphere-viewer/settings-plugin | Settings panel for other plugins |
@photo-sphere-viewer/stereo-plugin | VR/stereoscopic rendering |
@photo-sphere-viewer/video-plugin | Controls for video panoramas |
@photo-sphere-viewer/virtual-tour-plugin | Connect panoramas into a navigable tour |
@photo-sphere-viewer/visible-range-plugin | Restrict the visible yaw/pitch range |
Next steps
Getting started
Install the library and create your first panorama viewer.
Plugins overview
Browse the full list of official plugins and how to use them.
Adapters overview
Learn how to load cubemaps, tiled images, and video panoramas.
Configuration
Explore all viewer options and how to configure them.