@manifest-editor/ocr-classification 2.2.1-next.0.eefc2e3 → 2.2.2-next.0.4041094

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.
Files changed (2) hide show
  1. package/README.md +49 -0
  2. package/package.json +4 -4
package/README.md ADDED
@@ -0,0 +1,49 @@
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/ocr-classification"><img src="https://img.shields.io/npm/v/%40manifest-editor%2Focr-classification" 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&amp;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/ocr-classification
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
+ Classify canvas images for OCR difficulty using the plugin’s background action.
19
+
20
+ ## Quick start
21
+
22
+ ```sh
23
+ npm install manifest-editor @manifest-editor/ocr-classification react@19 react-dom@19
24
+ ```
25
+
26
+ ```tsx
27
+ import { ManifestEditor } from "manifest-editor";
28
+ import * as plugin from "@manifest-editor/ocr-classification";
29
+ import "manifest-editor/index.css";
30
+
31
+ export function Editor() {
32
+ return (
33
+ <ManifestEditor
34
+ resource="https://wellcomelibrary.org/iiif/b18035723/manifest"
35
+ plugins={[plugin]}
36
+ enabledPlugins={["@manifest-editor/ocr-classification"]}
37
+ />
38
+ );
39
+ }
40
+ ```
41
+
42
+ The lazy entry point defers loading the action implementation until needed. Import the module namespace (`import * as plugin`) when registering it: the default export alone contains only metadata.
43
+
44
+ ## API overview
45
+
46
+ - Default export: plugin metadata (ID, label, supported apps/resources, and default enabled state).
47
+ - `backgroundActions`, action factory, OCR difficulty helpers, and the `/lazy` entry point.
48
+
49
+ See the [source exports](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/plugins/ocr-classification/src) for the complete API and TypeScript definitions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@manifest-editor/ocr-classification",
3
- "version": "2.2.1-next.0.eefc2e3",
3
+ "version": "2.2.2-next.0.4041094",
4
4
  "type": "module",
5
5
  "bugs": "https://github.com/digirati-co-uk/iiif-manifest-editor/issues",
6
6
  "repository": {
@@ -43,8 +43,8 @@
43
43
  },
44
44
  "dependencies": {
45
45
  "@iiif/helpers": "4.0.0",
46
- "@manifest-editor/components": "2.2.1-next.0.eefc2e3",
47
- "@manifest-editor/shell": "2.2.1-next.0.eefc2e3",
46
+ "@manifest-editor/components": "2.2.2-next.0.4041094",
47
+ "@manifest-editor/shell": "2.2.2-next.0.4041094",
48
48
  "onnxruntime-web": "^1.24.3",
49
49
  "react": "19.2.8"
50
50
  },
@@ -56,5 +56,5 @@
56
56
  "publishConfig": {
57
57
  "access": "public"
58
58
  },
59
- "gitHead": "eefc2e321c6da5d194285621f4d26376088f2bb2"
59
+ "gitHead": "4041094cce4447f3aeb01fc7803322641b46c379"
60
60
  }