Skip to content
This repository has been archived by the owner on Jun 25, 2021. It is now read-only.

Latest commit

 

History

History
167 lines (135 loc) · 17.1 KB

README.md

File metadata and controls

167 lines (135 loc) · 17.1 KB
Raw

Universal Viewer

Backers on Open Collective Sponsors on Open Collective Build Status License

examples     google group     twitter     #slack 


npm install universalviewer --save

Website

Visit the UV demo page to try it out.

Scope:

  • 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

Getting Started

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

Contributing

Read below to learn how to take part in improving the UV:

  • Fork the repository and run the examples from source
  • Get familiar with Code of Conduct
  • Read our guide to contributing
  • Find an issue to work on and submit a pull request
    • First time contributing to open source? Pick a good first issue to get you familiar with GitHub contributing process.
    • First time contributing to the UV? Pick a beginner friendly issue to get you familiar with codebase and our contributing process.
    • Want to become a Committer? Solve an issue showing that you understand UV objectives and architecture. Here is a good list to start.
  • Could not find an issue? Look for bugs, typos, and missing features.

Contributors

Contributors

Feedback

Read below how to engage with the UV community:

  • Join the discussion on Slack.
  • Ask a question, request a new feature and file a bug with GitHub issues.
  • Star the repository to show your support ⭐

Sponsors

Become a backer and support us with a monthly donation and help us continue our activities.

Become a sponsor and join our Steering Group to help guide how our sponsorship funds are allocated.

License

The Universal Viewer is released under the MIT license.

Accessibility Statement

https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement