@annotation-studio/plugin-resource-editor

Resource template exporting UI for annotation images.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@annotation-studio/plugin-resource-editor
Minified + gzip package size for @annotation-studio/plugin-resource-editor in KB

Readme

Annotation Studio - Resource editor plugin

This is the Open Seadragon or static image viewer component.

Usage

To use the plugin you need to add it as a dependency along with the core plugin:

$ npm i @annotation-studio/plugin-resource-editor @annotation-studio/plugin-core --save-dev

Note: you will probably want a viewer plugin too

Then in your code (ES6 in this example)

import CorePlugin from '@annotation-studio/plugin-core';
import ResourceEditor from '@annotation-studio/plugin-resource-editor';

// We need the core plugin.
const core = CorePlugin(
  document.getElementById('myContainer'),
  {
    resourceTemplates: '...',
    manifest: '...',
    canvas: '...',
    elucidateServer: '...',
  }
);

// We need to wait for the store to be available.
core.then(store => {
  ResourceEditor(
    document.getElementById('editor'),
    {
      canvas: {/* ... */}, // IIIF Canvas as JS object
    },
    store
  );
});

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.