Intégration de plugin à Mirador

Contexte

Ici nous allons chercher à intégrer un plugin à Mirador et la méthode va changer selon si le plugin à a été crée par nous ou non.

Intégration d'un plugin

Plugin créé

Pour intégrer le plugin à notre configuration de mirador, il faut dans un premier temps l'ajouter dans les exports :

import plugin from "./demo-plugin";

Et ensuite on l’intègre à notre configuration de cette manière :

const config = {
  // Ici on place notre config
};

var miradorInstance = mirador.viewer(config, [plugin]);

A savoir qu'il est évidemment possible d'intégrer plusieurs plugins en même temps, en les séparant par une virgule entre les crochets.

Plugin déjà existant

On prends bien en compte ici le faite que l'installation a été faite en suivant la doc et on va prendre l'exemple du plugin "mirador-image-tools".

• Installation de la dépendance

npm install mirador-image-tools

• Vérification

Après avoir installé la dépendance, elle est censée apparaître dans le fichier "package.json" qui regroupe les différentes dépendances de node utilisées :

"dependencies": {
    "css-loader": "^3.6.0",
    "mirador": "^3.3.0",
    "mirador-image-tools": "^0.11.0",
    "parcel-bundler": "^1.12.4",
    "react": "^16.13.1",
    "react-dom": "^16.13.1",
    "style-loader": "^1.2.1",
    "webpack": "^4.43.0",
    "webpack-cli": "^3.3.12"
  }

• Intégration

Après avoir vérifié que la dépendance est bien présente, on peut donc l'utiliser en l'intégrant au mirador via le fichier "index.js". Donc dans un premier temps, on import le plugin :

import { miradorImageToolsPlugin } from 'mirador-image-tools';

On peut ensuite l'intégrer à la config :

Mirador.viewer(config, [
  ...miradorImageToolsPlugin,
]);