@dbmdz/mirador-manifestbutton

Manifest button

Adds an extra button to every window that links to the loaded manifest.

Installation

You can find production-ready build artifacts in the releases section.

Alternatively, you can use npm to install the artifacts:

$ npm install @dbmdz/mirador-manifestbutton

If you have a Java Web-Application managed with mvn, there is also a WebJar, which can be included as follows:

<dependency>
  <groupId>org.webjars.npm</groupId>
  <artifactId>dbmdz__mirador-manifestbutton</artifactId>
  <version>{set to current version}</version>
</dependency>

Usage

• enable the plugin by including the CSS and the JavaScript (after loading Mirador):

<link rel="stylesheet" type="text/css" href="<url to the plugin>/manifestButton.min.css" />
...
<script src="<url to the plugin>/manifestButton.min.js"></script>

• configure the icon class of the button with the manifestButton configuration attribute in your Mirador configuration:

var mirador = Mirador({
  ...
  manifestButton: {
    iconClass: 'fa-file' // Define the icon class of the button
  }
  ...
});

NOTE: The value has to be one of the Font Awesome Icon classes, the default is fa-file-text-o.