https://github.com/nakamura196/mirador-disable-zoom

A Mirador 4 plugin that allows users to disable (and re-enable) zoom controls per window.
https://github.com/nakamura196/mirador-disable-zoom

mirador mirador-3 mirador-4 mirador-plugins

Last synced: 15 days ago
JSON representation

A Mirador 4 plugin that allows users to disable (and re-enable) zoom controls per window.

• Host: GitHub
• URL: https://github.com/nakamura196/mirador-disable-zoom
• Owner: nakamura196
• License: other
• Created: 2024-06-22T10:13:28.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-22T11:35:28.000Z (7 months ago)
• Last Synced: 2024-11-05T16:38:14.526Z (2 months ago)
• Topics: mirador, mirador-3, mirador-4, mirador-plugins
• Language: JavaScript
• Homepage: https://nakamura196.github.io/mirador-disable-zoom/
• Size: 6.04 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# mirador-disable-zoom

![Node.js CI](https://github.com/nakamura196/mirador-disable-zoom/workflows/Node.js%20CI/badge.svg)

`mirador-disable-zoom` is a [Mirador 4](https://github.com/projectmirador/mirador) plugin that allows users to disable (and re-enable) zoom controls per window.

This plugin is based on the [mirador-disable-zoom](https://github.com/UCLALibrary/mirador-disable-zoom) plugin by UCLA Library.

![Mirador disable zoom example](./assets/example.png)

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:

```javascript

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](https://github.com/ProjectMirador/mirador/wiki) for examples of embedding Mirador within an application. See the [live demo's index.js](https://github.com/ProjectMirador/mirador-disable-zoom/blob/master/demo/src/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](http://bit.ly/iiif-slack), or the [mirador-tech](https://groups.google.com/forum/#!forum/mirador-tech) and [iiif-discuss](https://groups.google.com/forum/#!forum/iiif-discuss) mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.