/archival-IIIF-viewer

IIIF compatible viewer for digital born file storages

Primary LanguageTypeScriptMIT LicenseMIT

Archival IIIF viewer

Components

Download

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

Usage

<!DOCTYPE html>
<html>
    <head>
        <link rel="stylesheet" href="path-to-viewer/archival-IIIF-viewer-x.y.z.min.css">
    </head>
    <body>
    
        <div id="root"></div>
    
        <script type="text/javascript" src="path-to-viewer/archival-IIIF-viewer-x.y.z.min.js"></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 button 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

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

Supported Browsers

Edge Firefox Chrome Safari
≥ 14 ≥ 52 ≥ 49 ≥ 10

IIIF suport

Demo

https://iiif.sozialarchiv.ch

See also