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>

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
  • 🏅 Sponsors
  • 📖 License
  • 📖 Accessibility Statement
  • 📣 Feedback

🌐 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.

💻 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
• Could not find an issue? Look for bugs, typos, and missing features.

🏅 Sponsors

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

Read our Accessibility Statement

📣 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 ⭐