@harvard-lts/mirador-template-plugin
v2.0.0
Published
Template for Harvard mps-viewer Mirador plugins
Keywords
Readme
mirador-template-plugin
Template for Harvard mps-viewer Mirador plugins.
Compatibility
This plugin is compatible with Mirador 4 (React 18/19, MUI 7). It is not
backwards compatible with Mirador 3, and upgrading from an older version
contains breaking changes — internal mirador/dist/... imports now resolve from
the top-level mirador package, components use React function/hook patterns, and
the build/styling stack moved to MUI 7 + Emotion. Mirador 4 versions are tagged
2.x; if you still need Mirador 3 support, pin a 0.x or 1.x release.
Requirements
Setup
- Run
npm ito install dependencies - Use one of the NPM scripts to perform the actions described below.
NPM scripts
The following are some useful scripts can be ran using npm run <script>. A full list can be seen in package.json
| Script | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------- |
| clean | Removes the dist directories |
| build | Builds the source files into the ./dist directory |
| serve | Spins up the local development server at http://localhost:9000 |
| test | Runs the test suite |
Installing in Mirador
The mirador-template-plugin requires an instance of Mirador 4. Visit the Mirador wiki to learn how to create a Mirador 4 plugin and for additional information about plugins.
Package you will need to install:
npm i @harvard-lts/mirador-template-pluginContribute
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.
