Skip to content

IIIF Component - Adds IIIF manifest viewer support via Clover integration #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ewlarson wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

IIIF Component - Adds IIIF manifest viewer support via Clover integration #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2457890
IIIF Component
ewlarson Nov 11, 2025
7b73250
Resolve IIIF viewer rendering errors
ewlarson Nov 11, 2025
640b939
Prettier
ewlarson Nov 11, 2025
0449076
Fix Jest ES module error and suppress console output
ewlarson Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EaseToOptions } from "maplibre-gl";
export { OgmRecord } from "./utils/record";
export { EaseToOptions } from "maplibre-gl";
export namespace Components {
interface OgmIiif {
"manifestUrl": string;
"theme": 'light' | 'dark';
}
interface OgmMap {
"easeMapTo": (options: EaseToOptions) => Promise<maplibregl.Map>;
"previewOpacity": number;
Expand Down Expand Up @@ -52,6 +56,12 @@ export interface OgmSettingsCustomEvent<T> extends CustomEvent<T> {
target: HTMLOgmSettingsElement;
}
declare global {
interface HTMLOgmIiifElement extends Components.OgmIiif, HTMLStencilElement {
}
var HTMLOgmIiifElement: {
prototype: HTMLOgmIiifElement;
new (): HTMLOgmIiifElement;
};
interface HTMLOgmMapElementEventMap {
"mapIdle": void;
"mapLoading": void;
Expand Down Expand Up @@ -123,6 +133,7 @@ declare global {
new (): HTMLOgmViewerElement;
};
interface HTMLElementTagNameMap {
"ogm-iiif": HTMLOgmIiifElement;
"ogm-map": HTMLOgmMapElement;
"ogm-menubar": HTMLOgmMenubarElement;
"ogm-metadata": HTMLOgmMetadataElement;
Expand All @@ -132,6 +143,10 @@ declare global {
}
}
declare namespace LocalJSX {
interface OgmIiif {
"manifestUrl"?: string;
"theme"?: 'light' | 'dark';
}
interface OgmMap {
"onMapIdle"?: (event: OgmMapCustomEvent<void>) => void;
"onMapLoading"?: (event: OgmMapCustomEvent<void>) => void;
Expand Down Expand Up @@ -164,6 +179,7 @@ declare namespace LocalJSX {
"theme"?: 'light' | 'dark';
}
interface IntrinsicElements {
"ogm-iiif": OgmIiif;
"ogm-map": OgmMap;
"ogm-menubar": OgmMenubar;
"ogm-metadata": OgmMetadata;
Expand All @@ -176,6 +192,7 @@ export { LocalJSX as JSX };
declare module "@stencil/core" {
export namespace JSX {
interface IntrinsicElements {
"ogm-iiif": LocalJSX.OgmIiif & JSXBase.HTMLAttributes<HTMLOgmIiifElement>;
"ogm-map": LocalJSX.OgmMap & JSXBase.HTMLAttributes<HTMLOgmMapElement>;
"ogm-menubar": LocalJSX.OgmMenubar & JSXBase.HTMLAttributes<HTMLOgmMenubarElement>;
"ogm-metadata": LocalJSX.OgmMetadata & JSXBase.HTMLAttributes<HTMLOgmMetadataElement>;
Expand Down
33 changes: 33 additions & 0 deletions src/components/ogm-iiif/ogm-iiif.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
:host {
display: block;
height: 100%;
width: 100%;
}

.wrapper {
position: relative;
height: 100%;
width: 100%;
}

clover-viewer {
display: block;
height: 100%;
width: 100%;
}

.clover-frame {
display: block;
border: 0;
width: 100%;
height: 100%;
}

.loading {
position: absolute;
inset: 0;
display: flex;
align-items: center;
justify-content: center;
pointer-events: none;
}
142 changes: 142 additions & 0 deletions src/components/ogm-iiif/ogm-iiif.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
import { Component, Element, Prop, State, Watch, h, Host } from '@stencil/core';

// Import Shoelace spinner component
import '@shoelace-style/shoelace/dist/components/spinner/spinner.js';

@Component({
tag: 'ogm-iiif',
styleUrl: 'ogm-iiif.css',
shadow: false,
})
export class OgmIiif {
@Element() el: HTMLElement;
@Prop() manifestUrl: string;
@Prop() theme: 'light' | 'dark';

@State() cloverReady: boolean = false;
@State() loadError: boolean = false;
@State() frameLoaded: boolean = false;
private frameEl?: HTMLIFrameElement;

async componentWillLoad() {
// When rendering via iframe, no external script load is needed here.
this.cloverReady = true;
}

// Minimal HTML document to sandbox Clover IIIF inside an iframe.
private buildIframeSrcdoc(url: string): string {
const escapedUrl = url.replace(/&/g, '&amp;').replace(/"/g, '&quot;').replace(/</g, '&lt;');
return `
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<script src="https://www.unpkg.com/@samvera/clover-iiif@latest/dist/web-components/index.umd.js"></script>
<style>
html, body { height: 100%; margin: 0; }
clover-viewer { display: block; height: 100%; width: 100%; }
/* Hide Clover header entirely */
.clover-viewer-header { display: none !important; }
</style>
</head>
<body class="${this.theme ? `sl-theme-${this.theme}` : ''}">
<clover-viewer iiif-content="${escapedUrl}"></clover-viewer>
<script>
// Turn off information panel as soon as toggle is available
(function() {
function tryCloseInfo() {
var t = document.getElementById('information-toggle');
if (!t) return false;
var state = t.getAttribute('aria-checked') || t.getAttribute('data-state');
if (state === 'true' || state === 'checked') {
t.click();
}
return true;
}
if (!tryCloseInfo()) {
var mo = new MutationObserver(function() {
if (tryCloseInfo()) mo.disconnect();
});
mo.observe(document.body, { childList: true, subtree: true });
setTimeout(function(){ mo.disconnect(); }, 5000);
}
})();
</script>
</body>
</html>
`.trim();
}

private updateIframeThemeClass() {
if (!this.frameEl?.contentWindow?.document?.body) return;
const body = this.frameEl.contentWindow.document.body;
body.classList.remove('sl-theme-light', 'sl-theme-dark');
if (this.theme) body.classList.add(`sl-theme-${this.theme}`);
}

private setupIframeReference() {
const iframe = this.el.querySelector('iframe') as HTMLIFrameElement;
if (iframe && iframe !== this.frameEl) {
// Remove old listener if exists
if (this.frameEl) {
this.frameEl.removeEventListener('load', this.handleIframeLoad);
}
this.frameEl = iframe;
this.frameEl.addEventListener('load', this.handleIframeLoad);
// Check if iframe is already loaded (for srcdoc, contentDocument is available when loaded)
try {
if (this.frameEl.contentDocument && this.frameEl.contentDocument.readyState === 'complete') {
this.handleIframeLoad();
}
} catch (e) {
// Cross-origin or not yet loaded - will be handled by load event
}
}
}

private handleIframeLoad = () => {
// Defer state update to avoid mutating during render cycle
requestAnimationFrame(() => {
this.frameLoaded = true;
this.updateIframeThemeClass();
});
};

componentDidLoad() {
this.setupIframeReference();
}

componentDidUpdate() {
this.setupIframeReference();
}

// Reset loading state when manifestUrl changes
@Watch('manifestUrl')
onManifestUrlChanged() {
this.frameLoaded = false;
}

// React to external theme prop changes
@Watch('theme')
onThemeChanged() {
this.updateIframeThemeClass();
}

render() {
if (this.loadError || !this.manifestUrl) return;
const srcdoc = this.buildIframeSrcdoc(this.manifestUrl);
return (
<Host class={this.theme && `sl-theme-${this.theme}`}>
<div class="wrapper">
{!this.frameLoaded && (
<div class="loading">
<sl-spinner></sl-spinner>
</div>
)}
{this.cloverReady && <iframe class="clover-frame" part="clover-frame" srcdoc={srcdoc} loading="lazy" title="Clover IIIF Viewer"></iframe>}
</div>
</Host>
);
}
}
Loading