@manifest-editor/annotations 2.2.1-cdn.1.2412bf12 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/digirati-co-uk/iiif-manifest-editor"><img src="https://raw.githubusercontent.com/digirati-co-uk/iiif-manifest-editor/main/apps/docs/content/img/logo.svg" width="360" alt="Manifest Editor"></a>
|
|
3
|
+
</p>
|
|
4
|
+
<p align="center">
|
|
5
|
+
<a href="https://www.npmjs.com/package/@manifest-editor/annotations"><img src="https://img.shields.io/npm/v/%40manifest-editor%2Fannotations" alt="npm version"></a>
|
|
6
|
+
<a href="https://github.com/digirati-co-uk/iiif-manifest-editor/actions/workflows/build-test.yml"><img src="https://img.shields.io/github/actions/workflow/status/digirati-co-uk/iiif-manifest-editor/build-test.yml?branch=main&label=build" alt="Build status"></a>
|
|
7
|
+
<a href="https://manifest-editor-docs.netlify.app/"><img src="https://img.shields.io/badge/docs-Manifest_Editor-blue" alt="Documentation"></a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
# @manifest-editor/annotations
|
|
11
|
+
|
|
12
|
+
## Getting started with Manifest Editor
|
|
13
|
+
|
|
14
|
+
For the complete editor, start with [`manifest-editor`](https://www.npmjs.com/package/manifest-editor) and its [installation and integration guide](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/packages/manifest-editor#readme). It combines the editor UI, presets, creators, and editing APIs. This package is one part of that workspace.
|
|
15
|
+
|
|
16
|
+
## About
|
|
17
|
+
|
|
18
|
+
Create and inspect canvas annotations, inline external annotation pages, and run bulk annotation imports.
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
npm install manifest-editor @manifest-editor/annotations react@19 react-dom@19
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
```tsx
|
|
27
|
+
import { ManifestEditor } from "manifest-editor";
|
|
28
|
+
import "manifest-editor/index.css";
|
|
29
|
+
|
|
30
|
+
export function Editor() {
|
|
31
|
+
return (
|
|
32
|
+
<ManifestEditor
|
|
33
|
+
resource="https://wellcomelibrary.org/iiif/b18035723/manifest"
|
|
34
|
+
enabledPlugins={["@manifest-editor/annotations"]}
|
|
35
|
+
/>
|
|
36
|
+
);
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The standard manifest preset already includes this plugin, enabled by default. Do not register it twice. Import the module namespace (`import * as plugin`) when registering it: the default export alone contains only metadata.
|
|
41
|
+
|
|
42
|
+
## API overview
|
|
43
|
+
|
|
44
|
+
- Default export: plugin metadata (ID, label, supported apps/resources, and default enabled state).
|
|
45
|
+
- `leftPanels`, `annotations`, `background`, `backgroundActions`, annotation constants, and importer helpers.
|
|
46
|
+
|
|
47
|
+
See the [source exports](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/plugins/annotations/src) for the complete API and TypeScript definitions.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@manifest-editor/annotations",
|
|
3
|
-
"version": "2.2.1
|
|
3
|
+
"version": "2.2.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bugs": "https://github.com/digirati-co-uk/iiif-manifest-editor/issues",
|
|
6
6
|
"repository": {
|
|
@@ -40,9 +40,9 @@
|
|
|
40
40
|
"@atlas-viewer/atlas": "3.3.0",
|
|
41
41
|
"@iiif/helpers": "4.0.0",
|
|
42
42
|
"@iiif/parser": "4.0.1",
|
|
43
|
-
"@manifest-editor/components": "2.2.1
|
|
44
|
-
"@manifest-editor/editors": "2.2.1
|
|
45
|
-
"@manifest-editor/shell": "2.2.1
|
|
43
|
+
"@manifest-editor/components": "2.2.1",
|
|
44
|
+
"@manifest-editor/editors": "2.2.1",
|
|
45
|
+
"@manifest-editor/shell": "2.2.1",
|
|
46
46
|
"react": "19.2.8",
|
|
47
47
|
"react-iiif-vault": "4.0.0",
|
|
48
48
|
"zustand": "4.5.2"
|
|
@@ -55,5 +55,5 @@
|
|
|
55
55
|
"publishConfig": {
|
|
56
56
|
"access": "public"
|
|
57
57
|
},
|
|
58
|
-
"gitHead": "
|
|
58
|
+
"gitHead": "903673e7c35feed673fc100cb0efe34733057c91"
|
|
59
59
|
}
|