# digirati-annotation-plugin-core

> Annotation studio core plugin

Latest version **1.0.0-rc.11** (published 2018-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install digirati-annotation-plugin-core
pnpm add digirati-annotation-plugin-core
yarn add digirati-annotation-plugin-core
bun add digirati-annotation-plugin-core
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-rc.11 |
| Published | 2018-02-12 |
| First published | 2017-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 28.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | stephenwf |

## Links

- npm: https://www.npmjs.com/package/digirati-annotation-plugin-core
- npm.io page: https://npm.io/package/digirati-annotation-plugin-core

## Dependencies (2)

- [digirati-annotation-redux](https://npm.io/package/digirati-annotation-redux.md) ^1.0.0-rc.11
- [digirati-annotation-bridge](https://npm.io/package/digirati-annotation-bridge.md) ^1.0.0-rc.11

## Recent versions

- 1.0.0-rc.11 (latest) — 2018-02-12
- 1.0.0-rc.3dc3dfc1 (canary) — 2018-02-12
- 1.0.0-rc.1c33a17c — 2018-02-12
- 1.0.0-rc.255d8738 — 2018-02-09
- 1.0.0-rc.10 — 2018-02-09
- 1.0.0-rc.9 — 2018-02-09
- 1.0.0-rc.f3739a39 — 2018-01-31
- 1.0.0-rc.b54ce50e — 2018-01-31
- 1.0.0-rc.8 — 2018-01-30
- 1.0.0-rc.4 — 2017-12-11
- 1.0.0-rc.942bcb80 — 2017-12-05
- 1.0.0-rc.fcbdc014 — 2017-12-05
- 1.0.0-rc.14b41279 — 2017-12-05
- 1.0.0-rc.f58b0cdf — 2017-12-05
- 1.0.0-rc.62855fd6 — 2017-12-05
- … 33 more at https://npm.io/package/digirati-annotation-plugin-core/versions

## README

# Annotation Studio - Core plugin
This is the state behind the other components.

### Usage
To use the plugin you need to add it as a dependency:
```
$ npm i digirati-annotation-plugin-core --save-dev
```

Then in your code (ES6 in this example)

```jsx harmony
import CorePlugin from 'digirati-annotation-plugin-core';

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

core.then(store => {
  // this is called whenever the store changes
  store.subscribe(() => {
    // This is how to get the state
    const state = store.getState();
    // You can now render things, dispatch actions etc.
  })
})
```

### Resource templates:
[todo add link to resource template model]

---
_Source: https://npm.io/package/digirati-annotation-plugin-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
