README.md

Introduction to plugins

Plugins are used to add new functionalities to Photo Sphere Viewer. They can access all internal APIs of the viewer as well as the THREE.js renderer to make the viewer even more awesome.

Import official plugins

Official plugins (listed on the left menu) are available in the the main photo-sphere-viewer package inside the dist/plugins directory. Some plugins also have an additional CSS file.

Example for the Markers plugins:

:::: tabs

::: tab Direct import

<!-- base imports of PSV and dependencies -->

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/markers.min.css"/>

<script src="https://cdn.jsdelivr.net/npm/photo-sphere-viewer@4/dist/plugins/markers.min.js"></script>

:::

::: tab ES import Import photo-sphere-viewer/dist/plugins/markers.css with the prefered way depending on your tooling.

import MarkersPlugins from 'photo-sphere-viewer/dist/plugins/markers';

:::

::::

Using a plugin

All plugins consists of a JavaScript class which must be provided to the plugins array. Some plugins will also take configuration object provided in a nested array.

const viewer = new PhotoSphereViewer.Viewer({
  plugins: [
    SimplePlugin,
    [PluginWithOptions, {
      option1: 'foo',
      option2: 'bar',
    }],
  ],
});

After initializayion the plugin instance can be obtained with the getPlugin method, allowing to call methods on the plugin and subscribe to events.

const plugin = new viewer.getPlugin(PluginWithOptions);

plugin.on('something', () => {
  /* ... */
});