@harvard-lts/mirador-help-plugin
v2.0.0
Published
mirador-help-plugin React component
Keywords
Readme
mirador-help-plugin
Mirador plugin that adds a help modal window with a list of links. Links are currently Harvard-specific.
Compatibility
This plugin is Mirador 4-compatible (React 18/19, MUI 7). It is not
backwards compatible with Mirador 3 — upgrading from a Mirador 3 release
contains breaking changes (top-level mirador imports, function/hook
components, MUI 7 + Emotion styling).
Versioning convention: Mirador 4 releases are tagged 2.x; Mirador 3 releases
are tagged 0.x or 1.x. Pin a 0.x/1.x release if you still need Mirador 3.
Requirements
Setup
- 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.
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 | 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 |
Installing in Mirador
The mirador-help-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-help-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.
