@manifest-editor/exhibition-preset 2.2.1-next.0.eefc2e3 → 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 +40 -0
- package/package.json +10 -10
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
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/exhibition-preset"><img src="https://img.shields.io/npm/v/%40manifest-editor%2Fexhibition-preset" 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/exhibition-preset
|
|
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
|
+
Exhibition authoring: themed slides, guided tours, text/media blocks, and exhibition previews.
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
npm install @manifest-editor/exhibition-preset
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import { exhibitionEditorPreset } from "@manifest-editor/exhibition-preset";
|
|
28
|
+
|
|
29
|
+
export const app = exhibitionEditorPreset;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Use `app` as the `definition` of `AppProvider`, with `appId={app.metadata.id}`. See the [shell quick start](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/packages/shell#quick-start) for provider nesting, Vault loading, and styles. The combined component does not have a `preset` prop: use the shell composition API to mount this exhibition preset.
|
|
33
|
+
|
|
34
|
+
## API overview
|
|
35
|
+
|
|
36
|
+
- `exhibitionEditorScrollingPreset` and `exhibitionEditorSlideshowPreset`: alternative mapped layouts.
|
|
37
|
+
- `PresetIcon`, `imageServiceSlideCreator`, its payload type, and `useExhibitionPreviewWindow`: exhibition integration helpers.
|
|
38
|
+
- `exhibitionEditorPreset`: a mapped app definition containing metadata, layout, and configuration. Pass it directly to `AppProvider`; do not call `mapApp` again.
|
|
39
|
+
|
|
40
|
+
See the [source exports](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/presets/exhibition-preset/src) for the complete API and TypeScript definitions.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@manifest-editor/exhibition-preset",
|
|
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": {
|
|
@@ -48,13 +48,13 @@
|
|
|
48
48
|
"@iiif/parser": "4.0.1",
|
|
49
49
|
"@iiif/presentation-3": "^2.2.3",
|
|
50
50
|
"@iiif/presentation-3-normalized": "^0.9.7",
|
|
51
|
-
"@manifest-editor/components": "2.2.1
|
|
52
|
-
"@manifest-editor/creator-api": "2.2.1
|
|
53
|
-
"@manifest-editor/creators": "2.2.1
|
|
54
|
-
"@manifest-editor/editor-api": "2.2.1
|
|
55
|
-
"@manifest-editor/editors": "2.2.1
|
|
56
|
-
"@manifest-editor/manifest-preset": "2.2.1
|
|
57
|
-
"@manifest-editor/shell": "2.2.1
|
|
51
|
+
"@manifest-editor/components": "2.2.1",
|
|
52
|
+
"@manifest-editor/creator-api": "2.2.1",
|
|
53
|
+
"@manifest-editor/creators": "2.2.1",
|
|
54
|
+
"@manifest-editor/editor-api": "2.2.1",
|
|
55
|
+
"@manifest-editor/editors": "2.2.1",
|
|
56
|
+
"@manifest-editor/manifest-preset": "2.2.1",
|
|
57
|
+
"@manifest-editor/shell": "2.2.1",
|
|
58
58
|
"exhibition-viewer": "^1.0.14",
|
|
59
59
|
"react": "19.2.8",
|
|
60
60
|
"react-aria-components": "^1.12",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"zustand": "4.5.2"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
|
-
"@manifest-editor/ui": "2.2.
|
|
68
|
+
"@manifest-editor/ui": "2.2.1",
|
|
69
69
|
"@tsdown/css": "0.22.14",
|
|
70
70
|
"@types/react": "19.2.18",
|
|
71
71
|
"@types/react-dom": "19.2.4",
|
|
@@ -76,5 +76,5 @@
|
|
|
76
76
|
"publishConfig": {
|
|
77
77
|
"access": "public"
|
|
78
78
|
},
|
|
79
|
-
"gitHead": "
|
|
79
|
+
"gitHead": "903673e7c35feed673fc100cb0efe34733057c91"
|
|
80
80
|
}
|