A Mirador 4 plugin for including authentication cookies for annotations.
This plugin is Mirador 4-compatible (React 18/19, MUI 7). It is not
backwards compatible with Mirador 3 — the upgrade contains breaking changes
(top-level mirador imports, function/hook components, MUI 7 + Emotion styling).
Pin precisely by version convention:
- Mirador 4 releases are tagged
2.x. - Mirador 3 releases are tagged
0.xor1.x— pin one of these if you still need Mirador 3.
- Run
nvm useto ensure your version of matches that in the.nvmrcfile - Run
npm ito install dependencies - Use one of the NPM scripts to perform the actions described below.
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 |
Runs a local web server where the plugin can be viewed in a vanilla Mirador instance (helpful for testing and development) |
test |
Runs the automated test suites |
The mirador-annotations-auth-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-annotations-auth-pluginMirador'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.