mirador-disable-zoom
v1.0.0-alpha.1
Published
mirador-disable-zoom React component
Downloads
3
Readme
mirador-disable-zoom
mirador-disable-zoom
is a Mirador 4 plugin that allows users to disable (and re-enable) zoom controls per window.
This plugin is based on the mirador-disable-zoom plugin by UCLA Library.
When interacting with Mirador on touch devices, users report that they sometimes unintentionally change the zoom level. This plugin adds a button to each window in Mirador that a user can click/touch to disable zooming on that window, until the user does one of the following:
- replaces the current window object with a new object (via the list of loaded manifests)
- moves to a different canvas in the same object
- changes the view type (BookView -> ImageView, and vice versa)
Configuration
Several configuration options are available on windows that use mirador-disable-zoom.
| Configuration | type | default | description |
| -------------------- | ------- | ------- | --------------------- |
| disableZoomEnabled
| boolean | false | Disable zoom controls |
Example configuration:
const config = {
id: "demo",
windows: [
{
disableZoomEnabled: true,
manifestId: "https://purl.stanford.edu/sn904cj3429/iiif/manifest",
},
],
};
Installing mirador-disable-zoom
mirador-disable-zoom
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-disable-zoom
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.