universalviewer

Universal Viewer

  

npm install universalviewer --save

Examples

Google group

Twitter

Contributors

Features:

• Zoomable

  OpenSeadragon image zooming using the IIIF image API

• Embeddable

  YouTube-style embedding with deep links to specific pages/zoom regions.

• Themable

  Fork the UV theme on github to create your own.

• Configurable

  The UV has its own visual configuration editor allowing all settings to be customised.

• Extensible

  Supports "IxIF" out of the box, allowing 3D, audio, video, and pdf viewing experiences.

More about the Universal Viewer

Stable Builds

See the GitHub releases page.

Development

The most up-to-date code can usually be found on the dev branch. Please see the wiki for instructions on how to customise the viewer for your own projects.

First Time Setup

All command-line operations for building the UV are scripted using Grunt which is based on Node.js. To get set up:

1. Install Node.js, if you haven't already

2. Install the grunt command line interface (if you haven't already); on the command line, run:

    npm install -g grunt-cli
   

3. Install bower (if you haven't already)

    npm install -g bower
   

4. Clone the universalviewer repository and sub modules:

    git clone https://github.com/UniversalViewer/universalviewer.git --recursive
   

5. On the command line, go in to the universalviewer folder

6. Run

    npm install
    bower install
    grunt sync
   

Debug Builds

To build the debug version of the viewer, just run (on the command line, in the universalviewer folder):

grunt

This will compile the .less files into .css and .ts files into .js with source maps to aid in debugging.

Distribution Builds

To build the distribution version of the UV, just run (on the command line, in the universalviewer folder):

grunt build

A versioned uv-major.minor.patch folder along with compressed .zip and .tar files will appear in the /dist folder. Use these in your website, or alternatively use:

npm install universalviewer --save

which will download the distribution folder to node_modules.

Examples

To view the examples run:

grunt
grunt examples

License

The Universal Viewer is released under the MIT license.