@harvard-lts/mirador-analytics-plugin v0.3.0
mirador-analytics-plugin
Mirador plugin for analytics. Currently formatted for use with Google Tag Manager.
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-analytics-plugin requires an instance of Mirador 3. Visit the Mirador wiki to learn how to install an existing plugin and for additional information about plugins.
Package you will need to install:
npm i @harvard-lts/mirador-analytics-pluginConfiguration
Configurations for this plugin are injected when Mirador is initialized under the miradorAnalyticsPlugin key. See the demo entry for an example of importing and configuring mirador-analytics-plugin.
...
id: 'mirador',
miradorAnalyticsPlugin: {
...
}
...| Config Key | Type | Description |
|---|---|---|
containerId | string | ID assigned in Google Tag Manager, formatted as GTM-XXXXXXX (this can be found in the top right corner of the Workspace page) |
Contribute
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.