Skip to content

archival-IIIF/viewer

Repository files navigation

Material-UI logo

Archival IIIF viewer

This software is an open-source and web-based viewer for IIIF. It is focused on tree views but also works with single manifests.

The viewer was developed for the Archival IIIF Server, but also works with any other IIIF server.

Demo

https://iiif.sozialarchiv.ch

Features

Download

https://github.com/archival-IIIF/viewer/releases

The viewer is also available as an npm package:

// with npm
npm -i @archival-iiif/viewer

// with yarn
yarn add @archival-iiif/viewer

Usage

<!DOCTYPE html>
<html>
    <body class="aiiif-body">
        <div id="root"></div>
    
        <script type="text/javascript" src="path-to-viewer/archival-IIIF-viewer.min.js?v=x.y.z"></script>
        <script type="text/javascript">
            new ArchivalIIIFViewer({id: 'root'});
        </script>
    </body>
</html>

Options

key Description Example Mandatory Default
id Id of the element to append the viewer's container element to. 'root' Yes
language Default interface language 'en' No
manifest Initial manifest url 'https://iiif.sozialarchiv.ch/iiif/collection/demo' No
disableSharing Disable share tab true No false
disableDownload Disable download tab true No false
lazyTree Make tree view lazy true No false
allowedOrigins Indicates whether a manifest can be shown from the given origin. 'https://iiif.sozialarchiv.ch/' or ['https://iiif.sozialarchiv.ch', 'https://example.com'] No *
externalSearchUrl External search URL https://iiif-search.sozialarchiv.ch No
hideUnbranchedTrees Hide tree view if tree is unbranched true No false
htmlViewer Activate inline viewer for html documents true No false

Development

Installation

  1. Install Node.js
  2. Install yarn or npm
  3. yarn install or npm install
  4. yarn run start or npm run start

Building

  1. yarn run build or npm run build

See also