+ {manifests.map((manifest, idx) => {
+ return (
+ {
+ vault.loadManifest(manifest.url).then(() => {
+ setManifestIndex(idx);
+ });
+ }}
+ >
+ {manifest.label}
+
+ );
+ })}
+
+ {availablePages.length ? (
+
+ );
+}
diff --git a/examples/vault-viewer/src/components/PanelsLayout/PanelsLayout.icons.tsx b/examples/vault-viewer/src/components/PanelsLayout/PanelsLayout.icons.tsx
new file mode 100644
index 00000000..45f5f025
--- /dev/null
+++ b/examples/vault-viewer/src/components/PanelsLayout/PanelsLayout.icons.tsx
@@ -0,0 +1,21 @@
+import * as React from 'react';
+
+export function LeftArrowIcon(props: React.SVGProps
+ {
+ if (enabled) {
+ setPageDisabled(page.id);
+ } else {
+ if (!vault.requestStatus(page.id)) {
+ vault.load(page.id);
+ }
+ setPageEnabled(page.id);
+ }
+ }}
+ >
+ {enabled ? 'Hide' : 'Show'} {getLabel(page.label, `list ${n + 1}`)}
+
+ );
+ })}
+
+ ) : null}
+ Annotations
+ {availablePages.map((page, n) => { + const enabled = enabledPageIds.indexOf(page.id) !== -1; + return ( +
+ {manifest?.items.map(item => {
+ return (
+
+ setCurrentCanvasId(item.id)} />
+
+ );
+ })}
+
+ );
+};
diff --git a/examples/vault-viewer/src/index.tsx b/examples/vault-viewer/src/index.tsx
new file mode 100644
index 00000000..c9d0788c
--- /dev/null
+++ b/examples/vault-viewer/src/index.tsx
@@ -0,0 +1,61 @@
+import React, { useState } from 'react';
+import { render } from 'react-dom';
+import { VaultProvider, SimpleViewerProvider } from '@hyperion-framework/react-vault';
+import styled from 'styled-components';
+import { HeaderPanel } from './components/HeaderPanel/HeaderPanel';
+import { PanelsLayout } from './components/PanelsLayout/PanelsLayout';
+import { ThumbnailList } from './components/ThumbnailList/ThumbnailList';
+import { ImageViewer } from './components/ImageViewer/ImageViewer';
+import { CanvasViewer } from './components/CanvasViewer/CanvasViewer';
+import { manifests } from './manifests';
+import { GlobalStyle } from './components/GlobalStyle/GlobalStyle';
+import { ManifestList } from './components/ManifestList/ManifestList';
+
+export const Container = styled.div`
+ background: #000;
+ height: 100vh;
+ display: flex;
+ flex-direction: column;
+`;
+
+function App() {
+ const [manifestIndex, setManifestIndex] = useState(0);
+
+ return (
+ First-class restaurant
![](\"https://media.vam.ac.uk/feature/annotatedzoom/O1023003/2017KE6204-Aquitania-restaurant-cropped.jpg\")
Dining on ocean liners was a radically different experience depending on the class of travel. In first class, the Aquitania's Louis XVI-style dining room offered seating in small isolated groups, echoing elegant restaurants on land. The ship's architect, Arthur Davis, explained that a “cheerful room with comfortable surroundings” was a necessary distraction from “the often very unpleasant conditions” at sea.
Photograph from The New Art of Going Abroad, 1929, US. National Art Library: 38041986015030. © Victoria and Albert Museum, London
...
+}
+```
+
+So long as this is inside the provider, it will have the correct context.
diff --git a/packages/documentation/docs/api/vault-hooks/use-dispatch.mdx b/packages/documentation/docs/api/vault-hooks/use-dispatch.mdx
new file mode 100644
index 00000000..1427f8b3
--- /dev/null
+++ b/packages/documentation/docs/api/vault-hooks/use-dispatch.mdx
@@ -0,0 +1 @@
+# useDispatch
diff --git a/packages/documentation/docs/api/vault-hooks/use-vault-effect.mdx b/packages/documentation/docs/api/vault-hooks/use-vault-effect.mdx
new file mode 100644
index 00000000..38a4a5e9
--- /dev/null
+++ b/packages/documentation/docs/api/vault-hooks/use-vault-effect.mdx
@@ -0,0 +1 @@
+# useVaultEffect
diff --git a/packages/documentation/docs/api/vault-hooks/use-vault-selector.mdx b/packages/documentation/docs/api/vault-hooks/use-vault-selector.mdx
new file mode 100644
index 00000000..98ca4a29
--- /dev/null
+++ b/packages/documentation/docs/api/vault-hooks/use-vault-selector.mdx
@@ -0,0 +1 @@
+# useVaultSelector
diff --git a/packages/documentation/docs/api/vault-hooks/use-vault.mdx b/packages/documentation/docs/api/vault-hooks/use-vault.mdx
new file mode 100644
index 00000000..35dec44d
--- /dev/null
+++ b/packages/documentation/docs/api/vault-hooks/use-vault.mdx
@@ -0,0 +1 @@
+# useVault
diff --git a/packages/documentation/docs/tutorial/00-installation.mdx b/packages/documentation/docs/tutorial/00-installation.mdx
new file mode 100644
index 00000000..e6989ee2
--- /dev/null
+++ b/packages/documentation/docs/tutorial/00-installation.mdx
@@ -0,0 +1,10 @@
+# Getting started
+
+## Background
+
+### IIIF Specification
+### Acclaimed viewers
+
+## What are we creating?
+
+## What problems are we solving?
diff --git a/packages/documentation/docs/tutorial/01-setting-up-context.mdx b/packages/documentation/docs/tutorial/01-setting-up-context.mdx
new file mode 100644
index 00000000..4e78e00a
--- /dev/null
+++ b/packages/documentation/docs/tutorial/01-setting-up-context.mdx
@@ -0,0 +1,11 @@
+# Setting up context
+
+In order to use the features provided by the framework, we need to wrap our application in a component called a **provider**.
+This provider will allow any components we write further down in our application can access the same IIIF resources and share some state.
+
+To add the provider we simple wrap our application in `docs directory.
+ //
+ // ),
+ // },
+ // {
+ // title: 'Powered by React',
+ // image: '/img/undraw_docusaurus_react.svg',
+ // description: (
+ // <>
+ // Extend or customize your website layout by reusing React. Docusaurus can
+ // be extended while reusing the same header and footer.
+ //
+ // ),
+ // },
+];
+
+function Feature({ title, image, description }: FeatureItem) {
+ return (
+
+
+ );
+}
+
+export default function HomepageFeatures(): JSX.Element {
+ return (
+
+ 
+
+
+
+ {title}
+{description}
+
+
+
+ {FeatureList.map((props, idx) => (
+
+
+
+ {siteConfig.tagline}
+
+
+ Get started
+
+
+ Hello World testing
; +} diff --git a/packages/documentation/src/sandboxes/setting-up-context.csb/App.js b/packages/documentation/src/sandboxes/setting-up-context.csb/App.js new file mode 100644 index 00000000..2ad3398d --- /dev/null +++ b/packages/documentation/src/sandboxes/setting-up-context.csb/App.js @@ -0,0 +1,17 @@ +import React from 'react'; +import { VaultProvider } from '@hyperion-framework/react-vault'; +import { LoadManifest } from './Manifest'; + +// Try switching this for your own manifest. +const url = 'https://wellcomelibrary.org/iiif/b18035723/manifest'; + +export default function App() { + return ( +This is inside the vault.
+
+ {/* We can create components that use the vault inside */}
+ Loading...
;
+ }
+
+ return {manifest.label.none[0]}
; +} diff --git a/packages/documentation/src/sandboxes/setting-up-context.csb/index.tsx b/packages/documentation/src/sandboxes/setting-up-context.csb/index.tsx new file mode 100644 index 00000000..50c08c10 --- /dev/null +++ b/packages/documentation/src/sandboxes/setting-up-context.csb/index.tsx @@ -0,0 +1,33 @@ +import React from 'react'; +import { Sandbox } from '@site/src/components/Sandbox/Sandbox'; +import { parseFiles } from '@site/src/utils/parse-files'; + +// @ts-ignore +const files = parseFiles(require.context('!!raw-loader!./', true, /\.js$/)); + +export const SettingUpContext = () => { + return ( + <> +
+ This is inside the vault.
+
+
+ );
+}`,
+ },
+ }}
+ />
+ );
+};
diff --git a/packages/documentation/src/utils/parse-files.ts b/packages/documentation/src/utils/parse-files.ts
new file mode 100644
index 00000000..79a379d8
--- /dev/null
+++ b/packages/documentation/src/utils/parse-files.ts
@@ -0,0 +1,10 @@
+import { SandpackFiles } from '@codesandbox/sandpack-react/dist/types/types';
+
+export function parseFiles(req: any): SandpackFiles {
+ return req.keys().reduce((state, key) => {
+ return {
+ ...state,
+ [key.slice(1)]: req(key).default,
+ };
+ }, {});
+}
diff --git a/packages/documentation/static/.nojekyll b/packages/documentation/static/.nojekyll
new file mode 100644
index 00000000..e69de29b
diff --git a/packages/documentation/static/img/docusaurus.png b/packages/documentation/static/img/docusaurus.png
new file mode 100644
index 00000000..f458149e
Binary files /dev/null and b/packages/documentation/static/img/docusaurus.png differ
diff --git a/packages/documentation/static/img/favicon.ico b/packages/documentation/static/img/favicon.ico
new file mode 100644
index 00000000..c01d54bc
Binary files /dev/null and b/packages/documentation/static/img/favicon.ico differ
diff --git a/packages/documentation/static/img/logo.svg b/packages/documentation/static/img/logo.svg
new file mode 100644
index 00000000..9db6d0d0
--- /dev/null
+++ b/packages/documentation/static/img/logo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/packages/documentation/static/img/tutorial/docsVersionDropdown.png b/packages/documentation/static/img/tutorial/docsVersionDropdown.png
new file mode 100644
index 00000000..ff1cbe68
Binary files /dev/null and b/packages/documentation/static/img/tutorial/docsVersionDropdown.png differ
diff --git a/packages/documentation/static/img/tutorial/localeDropdown.png b/packages/documentation/static/img/tutorial/localeDropdown.png
new file mode 100644
index 00000000..d7163f96
Binary files /dev/null and b/packages/documentation/static/img/tutorial/localeDropdown.png differ
diff --git a/packages/documentation/static/img/undraw_docusaurus_mountain.svg b/packages/documentation/static/img/undraw_docusaurus_mountain.svg
new file mode 100644
index 00000000..431cef2f
--- /dev/null
+++ b/packages/documentation/static/img/undraw_docusaurus_mountain.svg
@@ -0,0 +1,170 @@
+
diff --git a/packages/documentation/static/img/undraw_docusaurus_react.svg b/packages/documentation/static/img/undraw_docusaurus_react.svg
new file mode 100644
index 00000000..e4170504
--- /dev/null
+++ b/packages/documentation/static/img/undraw_docusaurus_react.svg
@@ -0,0 +1,169 @@
+
diff --git a/packages/documentation/static/img/undraw_docusaurus_tree.svg b/packages/documentation/static/img/undraw_docusaurus_tree.svg
new file mode 100644
index 00000000..a05cc03d
--- /dev/null
+++ b/packages/documentation/static/img/undraw_docusaurus_tree.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/packages/documentation/tsconfig.json b/packages/documentation/tsconfig.json
new file mode 100644
index 00000000..b1496897
--- /dev/null
+++ b/packages/documentation/tsconfig.json
@@ -0,0 +1,17 @@
+{
+ // This file is not used in compilation. It is here just for a nice editor experience.
+ "compilerOptions": {
+ "allowJs": true,
+ "esModuleInterop": true,
+ "jsx": "react",
+ "lib": ["DOM"],
+ "noEmit": true,
+ "noImplicitAny": false,
+ "types": ["node", "@docusaurus/module-type-aliases", "@docusaurus/theme-classic"],
+ "baseUrl": ".",
+ "paths": {
+ "@site/*": ["./*"],
+ "@csb/*": ["./src/sandboxes"]
+ }
+ }
+}
diff --git a/packages/editor/package.json b/packages/editor/package.json
index 96bed1a4..ee2ddb80 100644
--- a/packages/editor/package.json
+++ b/packages/editor/package.json
@@ -1,6 +1,6 @@
{
"name": "@hyperion-framework/editor",
- "version": "1.1.0",
+ "version": "2.0.0-alpha.0",
"main": "dist/index.js",
"module": "dist/index.es.js",
"web": "dist/index.umd.js",
@@ -18,10 +18,10 @@
"prepare": "NODE_ENV=production rollup -c && tsc -p ./tsconfig.types.json"
},
"dependencies": {
- "@hyperion-framework/parser": "^1.1.0",
- "@hyperion-framework/store": "^1.1.0",
- "@hyperion-framework/types": "^1.1.0",
- "@hyperion-framework/vault": "^1.1.0",
+ "@hyperion-framework/parser": "^2.0.0-alpha.0",
+ "@hyperion-framework/store": "^2.0.0-alpha.0",
+ "@hyperion-framework/types": "^2.0.0-alpha.0",
+ "@hyperion-framework/vault": "^2.0.0-alpha.0",
"rollup": "^2.36.1"
},
"publishConfig": {
diff --git a/packages/parser/package.json b/packages/parser/package.json
index 30b64bfe..11323c5f 100644
--- a/packages/parser/package.json
+++ b/packages/parser/package.json
@@ -1,6 +1,6 @@
{
"name": "@hyperion-framework/parser",
- "version": "1.1.0",
+ "version": "2.0.0-alpha.0",
"main": "dist/index.js",
"module": "dist/index.es.js",
"web": "dist/index.umd.js",
@@ -18,9 +18,9 @@
"prepare": "NODE_ENV=production rollup -c && tsc -p ./tsconfig.types.json"
},
"dependencies": {
- "@hyperion-framework/presentation-2": "^1.1.0",
- "@hyperion-framework/presentation-2-parser": "^1.1.0",
- "@hyperion-framework/types": "^1.1.0",
+ "@hyperion-framework/presentation-2": "^2.0.0-alpha.0",
+ "@hyperion-framework/presentation-2-parser": "^2.0.0-alpha.0",
+ "@hyperion-framework/types": "^2.0.0-alpha.0",
"rollup": "^2.36.1"
},
"publishConfig": {
diff --git a/packages/parser/src/traverse.ts b/packages/parser/src/traverse.ts
index fc594de6..f6445a8b 100644
--- a/packages/parser/src/traverse.ts
+++ b/packages/parser/src/traverse.ts
@@ -210,9 +210,23 @@ export class Traverse {
return canvas;
}
+ traverseInlineAnnotationPages