TIND Universal Viewer

TIND Universal Viewer is a fork of Universal Viewer. It contains the following changes:

• Removes bundled jQuery by changing all occurrences of require("jquery") with window.$.
• Removes GitHub Workflows.

Publishing

Publishing is done manually. Here is how.

1. Make sure you are on the latest develop branch

   git checkout develop
   git fetch
   git reset --hard origin/develop

2. Bump the version. Note: this creates and tags a commit which should be pushed.

   npm version prerelease --preid=alpha
   git push origin develop

3. Install NPM dependencies

   npm ci

4. Build the assets

   npm run build && npm run build-tsc && npm run build-es

5. Publish

   export NPM_TOKEN=<your token here>
   npm publish --access public --otp <2fa one time code here>

The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world

The UV software can display images, 3D files and PDFs, play audio and video files, and more.

npm install universalviewer --save

Please note that UV v4 is designed to work on evergreen browsers. If you need IE11 support, please use UV v3. Microsoft no longer supports IE11, and it reached end-of-life on June 15 2022.

• TIND Universal Viewer
  • Publishing
  • 🌐 Website
  • 📖 Getting Started
  • 💻 Contributing and Giving Feedback
  • 🏅 Contributors and Sponsors
  • 📖 Accessibility Statement
  • 📖 License

🌐 Website

• Visit Universal Viewer website
• Visit the stable UV demo page to try out the latest stable version of the Viewer (UV4) with sample items.
• Visit the dev branch UV demo page to try out the latest 'bleeding edge' dev branch code for UV4.
• View sample items in version 3 of the Universal Viewer

📖 Getting Started

See the examples for how to use the UV in various scenarios.

Read the technical docs to learn more about the code and available configuration options.

Read the manual for information on using, configuring, and developing for the UV.

📣 Contributing and Giving Feedback

An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this blog post about a recent 'community sprint' to find out more about how we're working together.

Talking to active contributors and sponsors is a great way to find out what the community is currently focusing on, and where help is needed:

• Join the discussion on Slack
• There is an active Slack channel and regular community calls.
• You can view discussions and post on our Google Group
• Ask a question, request a new feature and file a bug with GitHub issues
• Engage with the UV Steering Group and community team
• Get familiar with Code of Conduct
• Read our guide to contributing
• Read our governance document to learn more about roles and responsibilities, support, membership, and the decision making process.

If you want to dive into code, you can learn how to take part in improving the UV:

• Fork the repository and run the examples from source
• Find an issue to work on and submit a pull request
• Help update our Accessibility Statement
• Star the repository to show your support ⭐
• Could not find an issue? Look for bugs, typos, and missing features.

🏅 Contributors and Sponsors

Individual contributors

Institutional contributors

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

📖 Accessibility Statement

Read our Accessibility Statement

📖 License

The Universal Viewer is released under the MIT license.