@manifest-editor/components 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 +45 -0
- package/dist/lib.css +0 -432
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
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/components"><img src="https://img.shields.io/npm/v/%40manifest-editor%2Fcomponents" 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/components
|
|
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
|
+
Shared React controls, icons, forms, media components, and layout primitives used throughout Manifest Editor.
|
|
19
|
+
|
|
20
|
+
## Quick start
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
npm install @manifest-editor/components
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
```tsx
|
|
27
|
+
import { ActionButton } from "@manifest-editor/components";
|
|
28
|
+
import "@manifest-editor/components/lib.css";
|
|
29
|
+
|
|
30
|
+
export function SaveButton() {
|
|
31
|
+
return <ActionButton primary onPress={() => console.log("Save requested")}>Save</ActionButton>;
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Use React 19. Components that read IIIF resources or editor state need the corresponding Vault or shell providers. The combined editor includes the shared styles.
|
|
36
|
+
|
|
37
|
+
## API overview
|
|
38
|
+
|
|
39
|
+
- Controls: `ActionButton`, `IconButton`, selection controls, tooltips, and menus.
|
|
40
|
+
- Layout: sidebars, tabs, modals, and thumbnail grids.
|
|
41
|
+
- IIIF UI: manifest and collection list items, media rendering, and thumbnails.
|
|
42
|
+
- Editing UI: HTML/MDX editing, form fields, notices, and progress feedback.
|
|
43
|
+
- Icons and hooks are exported from the package root.
|
|
44
|
+
|
|
45
|
+
See the [source exports](https://github.com/digirati-co-uk/iiif-manifest-editor/tree/main/packages/components/src) for the complete API and TypeScript definitions.
|