Skip to content

A Mirador 4 plugin that adds the ability to synchronize the windows of a Mirador instance.

License

Notifications You must be signed in to change notification settings

nakamura196/mirador-sync-windows

Repository files navigation

mirador-sync-windows

Node.js CI

mirador-sync-windows is a Mirador 4 plugin that adds the ability to synchronize the windows of a Mirador instance. This plugin is useful for comparing multiple images side by side.

This plugin is based on the mirador-sync-windows plugin by UCLA Library.

Mirador sync windows example

Mirador sync windows example

🌐 Website

Visit the demo page to try it out.

📖 Configuration

Several configuration options are available on windows that use mirador-sync-windows.

Configuration type default description
syncWindowsEnabled boolean false Enabled the image tools by default

Example configuration:

const config = {
  id: "demo",
  windows: [
    {
      syncWindowsEnabled: true,
      manifestId: "https://purl.stanford.edu/sn904cj3429/iiif/manifest",
    },
  ],
};

📖 Installing mirador-sync-windows

mirador-sync-windows requires an instance of Mirador 4. See the Mirador wiki for examples of embedding Mirador within an application. See the live demo's index.js for an example of importing the mirador-sync-windows plugin and configuring the adapter.

📣 Contribute

Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on IIIF slack #mirador, or the mirador-tech and iiif-discuss mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.