The Universal Viewer is a community-developed open source project on a mission to help you share your content with the world
Clone or download
Latest commit 79afab1 Oct 12, 2018
Permalink
Failed to load latest commit information.
.github updates Sep 15, 2018
.vscode completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018
__tests__ comment test - cannot set data.config directly. use data.configUri May 1, 2018
examples @ 782964e updated examples Oct 12, 2018
src Merge branch 'master' of https://github.com/UniversalViewer/universal… Oct 12, 2018
tasks completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018
.bowerrc simplified extensions Jun 16, 2015
.gitattributes added linguist-vendored attribute Aug 15, 2015
.gitignore Adds unit + integration testing to UV (#582) Mar 26, 2018
.gitmodules removed submodule tests Jun 22, 2017
.npmignore updated npmignore Dec 17, 2015
.travis.yml Adds unit + integration testing to UV (#582) Mar 26, 2018
CODE_OF_CONDUCT.md added code of conduct Sep 15, 2018
Gruntfile.js completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018
LICENSE.txt added NLW to license Feb 21, 2015
README.md added contributors Sep 17, 2018
bower.json css scoped to .uv Mar 13, 2017
config.js completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018
dev.build.js include dev and dist.build.js Mar 27, 2017
dist.build.js include dev and dist.build.js Mar 27, 2017
favicon.ico added favicon Apr 20, 2015
jest-puppeteer.config.js Adds unit + integration testing to UV (#582) Mar 26, 2018
package-lock.json completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018
package.json fixed tests Oct 12, 2018
tsconfig.json completed npm audit, updated components to npm, removed gulp from eve… Oct 12, 2018

README.md

Universal Viewer

Backers on Open Collective Sponsors on Open Collective Build Status FOSSA Status License

examples     google group     twitter     #slack


npm install universalviewer@beta --save

Contributors

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 IIIF Presentation API v3 (in development), allowing 3D, audio, video, and pdf viewing experiences.

More about the Universal Viewer

Stable Builds

See the GitHub releases page.

Getting Started

For a "hello world" getting started example see uv-hello-world.

For an example of how to use the Universal Viewer in a website starter project that uses biiif to generate your IIIF data, see uv-app-starter.

Building the Universal Viewer

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:

    npm install -g grunt-cli

  1. Clone the universalviewer repository and examples sub module:

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

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

  3. Run

    npm install

If switching between branches, ensure that you check out the correct branch in the examples sub-repository too. By default this should be gh-pages.

Debug Builds

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

grunt build

This will compile the .less files into .css and .ts files into .js.

Distribution Builds

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

grunt build --dist

Examples

To view the examples run:

grunt examples

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

License

The Universal Viewer is released under the MIT license.