Awesome
mirador-imagecropper
A Mirador 3 plugin to retrieve the image url for the selected area.
Installation
Currently the plugin can only be used if you build your own Mirador JavaScript bundle.
To include the plugin in your Mirador installation, you need to install it
from npm with npm install mirador-imagecropper
, import it into your project
and pass it to Mirador when you instantiate the viewer:
import Mirador from 'mirador/dist/es/src/index';
import imageCropperPlugin from 'mirador-imagecropper/es';
const miradorConfig = {
// Your Mirador configuration
}
Mirador.viewer(config, [...imageCropperPlugin]);
Configuration
You can configure the plugin globally for all windows and/or individually for every window.
For global configuration add the imageCropper
entry to the top-level
window
configuration (globally for all windows) or to the individual window
object:
const miradorConfig = {
window: {
// ....
imageCropper: {
// Global config for all windows, see available settings below
},
},
windows: [{
// ....
imageCropper: {
// config for an individual window, see available settings below
},
}, // ...
}
You can view an example configuration in demo/src/index.js.
The available settings are:
active
: If the cropping overlay is active. Boolean, defaults tofalse
.dialogOpen
: If the settings dialog is open. Boolean, defaults tofalse
.enabled
: If the plugin is enabled. Boolean, defaults totrue
.roundingPrecision
: Set the number of decimal places. Number, defaults to5
.showRightsInformation
: If rights information defined in the manifest should be shown. Boolean, defaults totrue
.
Contributing
Found a bug? The plugin is not working with your manifest? Want a new feature? Create an issue, or if you want to take a shot at fixing it yourself, make a fork, create a pull request, we're always open to contributions :-)
For larger changes/features, it's usually wise to open an issue before starting the work, so we can discuss if it's a fit.
Note: The package requires Node.js 16
and npm in major version 8
.