-
-
Notifications
You must be signed in to change notification settings - Fork 204
Expand file tree
/
Copy pathindex.html
More file actions
86 lines (86 loc) · 15.7 KB
/
Copy pathindex.html
File metadata and controls
86 lines (86 loc) · 15.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>universalviewer</title><meta name="description" content="Documentation for universalviewer"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">universalviewer</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>universalviewer</h1></div><div class="tsd-panel tsd-typography"><p align="center">
<img src="https://avatars0.githubusercontent.com/u/9430521" style="width: 150px;" />
<h1 align="center" style="width: 60%; margin-left: auto; margin-right: auto;">Universal Viewer</h1>
<p align="center">
A community-developed open source project on a mission<br/> to help you share your 📚📜📰📽️📻🗿 with the 🌎
</p>
</p>
<br/>
<p align="center">
<a href="#-sponsors"><a href="https://opencollective.com/universalviewer/sponsors">
<img src="https://opencollective.com/universalviewer/sponsors/badge.svg" alt="Sponsors on Open Collective" />
</a>
<a href="https://app.netlify.com/sites/uv/deploys">
<img src="https://api.netlify.com/api/v1/badges/91dc58e8-49dd-495f-98bb-84570a0edb7c/deploy-status" />
</a>
<a href="https://github.com/UniversalViewer/universalviewer/blob/main/LICENSE.txt">
<img src="https://img.shields.io/npm/l/universalviewer.svg" alt="License" />
</a>
</p>
<p align="center"><a href="https://docs.google.com/forms/d/e/1FAIpQLSeHLD0kng5aXvGFsNN_tJGsZMTnp08Hv2F6kdGsJRb6bT0NWw/viewform" rel="nofollow"><strong>#</strong> Slack
</a> <a href="https://bsky.app/profile/universalviewer.io"> <strong>@</strong> Bluesky</a> <a href="https://x.com/universalviewer"> <strong>@</strong> X</a> <a href="https://glammr.us/@universalviewer"> <strong>@</strong> Mastodon </a> <a href="https://github.com/UniversalViewer/universalviewer/wiki"> History of the UV </a> </p>
<h1 id="the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" class="tsd-anchor-link">The Universal Viewer (UV) is a community-developed open source project. Our mission is to help you share your content with the world<a href="#the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
<p>The UV software can display images, 3D files and PDFs, play audio and video files, and more.</p>
<br/>
<pre><code>npm install universalviewer --save
</code></pre>
<br/>
<blockquote>
<p>Please note that UV v4 is designed to work on <a href="https://www.w3.org/2001/tag/doc/evergreen-web/">evergreen browsers</a>. If you need IE11 support, please use <a href="https://github.com/UniversalViewer/universalviewer/tree/v3">UV v3</a>.
Microsoft no longer supports IE11, and it <a href="https://blogs.windows.com/windowsexperience/2021/05/19/the-future-of-internet-explorer-on-windows-10-is-in-microsoft-edge/">reached end-of-life on June 15 2022</a>.</p>
</blockquote>
<br/>
<ul>
<li><a href="#-website"><strong>Website</strong></a></li>
<li><a href="#-getting-started"><strong>Getting Started</strong></a></li>
<li><a href="#-contributing-and-giving-feedback"><strong>Contributing and Giving Feedback</strong></a></li>
<li><a href="#-contributors-and-sponsors"><strong>Contributors and Sponsors</strong></a></li>
<li><a href="#-accessibility-statement"><strong>Accessibility Statement</strong></a></li>
<li><a href="#-license"><strong>License</strong></a></li>
</ul>
<h2 id="🌐-website" class="tsd-anchor-link">🌐 Website<a href="#🌐-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<ul>
<li><a href="https://universalviewer.io/">Visit Universal Viewer website</a></li>
<li><a href="https://uv-v4.netlify.app">Visit the stable UV demo page</a> to try out the latest stable version of the Viewer (UV4) with sample items.</li>
<li><a href="https://universalviewer.dev">Visit the dev branch UV demo page</a> to try out the latest 'bleeding edge' dev branch code for UV4.</li>
<li><a href="https://uv-v3.netlify.app">View sample items in version 3 of the Universal Viewer</a></li>
</ul>
<h2 id="📖-getting-started" class="tsd-anchor-link">📖 Getting Started<a href="#📖-getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>See the <a href="https://github.com/UniversalViewer/universalviewer/wiki/UV-Examples">examples</a> for how to use the UV in various scenarios.</p>
<p>Read the technical <a href="https://docs.universalviewer.io/modules.html">docs</a> to learn more about the code and available configuration options.</p>
<p>Read the <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/manual/index.md">manual</a> for information on using, configuring, and developing for the UV.</p>
<p><a id="feedback"></a>
<a id="contributing"></a></p>
<h2 id="📣-contributing-and-giving-feedback" class="tsd-anchor-link">📣 Contributing and Giving Feedback<a href="#📣-contributing-and-giving-feedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>An active, collaborative community of testers, developers and institutional users has grown around the Universal Viewer. Read this <a href="https://blogs.bl.uk/digital-scholarship/2024/11/working-together-the-community-sprint-experience-.html">blog post about a recent 'community sprint'</a> to find out more about how we're working together.</p>
<p>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:</p>
<ul>
<li>Join the discussion on <a href="http://universalviewer.io/#contact">Slack</a></li>
<li>There is an <a href="https://docs.google.com/forms/d/e/1FAIpQLSeHLD0kng5aXvGFsNN_tJGsZMTnp08Hv2F6kdGsJRb6bT0NWw/viewform">active Slack channel</a> and regular community calls.</li>
<li>You can view discussions and post on our <a href="https://groups.google.com/forum/#!forum/universalviewer">Google Group</a></li>
<li>Ask a question, request a new feature and file a bug with <a href="https://github.com/universalviewer/universalviewer/issues/new">GitHub issues</a></li>
<li>Engage with the <a href="https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group">UV Steering Group</a> and <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/COMMUNITY_TEAM.md">community team</a></li>
<li>Get familiar with <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/CONTRIBUTING.md">guide to contributing</a></li>
<li>Read our <a href="https://github.com/UniversalViewer/universalviewer/blob/dev/GOVERNANCE.md">governance document</a> to learn more about roles and responsibilities, support, membership, and the decision making process.</li>
</ul>
<p>If you want to dive into code, you can learn how to take part in improving the UV:</p>
<ul>
<li>Fork the repository and <a href="#-getting-started">run the examples from source</a></li>
<li>Find an <a href="https://github.com/UniversalViewer/universalviewer/issues">issue</a> to work on and submit a pull request</li>
<li>Help update our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer">Accessibility Statement</a></li>
<li>Star the repository to show your support ⭐</li>
<li>Could not find an issue? Look for bugs, typos, and missing features.</li>
</ul>
<p><a id="sponsors"></a></p>
<h2 id="🏅-contributors-and-sponsors" class="tsd-anchor-link">🏅 Contributors and Sponsors<a href="#🏅-contributors-and-sponsors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<h3 id="individual-contributors" class="tsd-anchor-link">Individual contributors<a href="#individual-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<p><a href="https://github.com/UniversalViewer/universalviewer/graphs/contributors"><img src="https://opencollective.com/universalviewer/contributors.svg?width=890&button=false" alt="Individual contributors" title="Individual contributors"></a></p>
<h3 id="institutional-contributors" class="tsd-anchor-link">Institutional contributors<a href="#institutional-contributors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>
<p><a href="https://opencollective.com/universalviewer#sponsor">Become a sponsor</a> and join our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Steering-Group">Steering Group</a> to help guide how our sponsorship funds are allocated.</p>
<p><img src="https://github.com/UniversalViewer/assets/master/contributors.jpg" alt="Institutional contributors" title="Institutional contributors"></p>
<h2 id="📖-accessibility-statement" class="tsd-anchor-link">📖 Accessibility Statement<a href="#📖-accessibility-statement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>Read our <a href="https://github.com/UniversalViewer/universalviewer/wiki/Accessibility-Statement-for-the-Universal-Viewer">Accessibility Statement</a></p>
<h2 id="📖-license" class="tsd-anchor-link">📖 License<a href="#📖-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>The Universal Viewer is released under the <a href="https://github.com/UniversalViewer/universalviewer/blob/master/LICENSE.txt">MIT license</a>.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#the-universal-viewer-uv-is-a-community-developed-open-source-project-our-mission-is-to-help-you-share-your-content-with-the-world"><span>The <wbr/>Universal <wbr/>Viewer (<wbr/>UV) is a community-<wbr/>developed open source project. <wbr/>Our mission is to help you share your content with the world</span></a><ul><li><a href="#🌐-website"><span>🌐 <wbr/>Website</span></a></li><li><a href="#📖-getting-started"><span>📖 <wbr/>Getting <wbr/>Started</span></a></li><li><a href="#📣-contributing-and-giving-feedback"><span>📣 <wbr/>Contributing and <wbr/>Giving <wbr/>Feedback</span></a></li><li><a href="#🏅-contributors-and-sponsors"><span>🏅 <wbr/>Contributors and <wbr/>Sponsors</span></a></li><li><ul><li><a href="#individual-contributors"><span>Individual contributors</span></a></li><li><a href="#institutional-contributors"><span>Institutional contributors</span></a></li></ul></li><li><a href="#📖-accessibility-statement"><span>📖 <wbr/>Accessibility <wbr/>Statement</span></a></li><li><a href="#📖-license"><span>📖 <wbr/>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">universalviewer</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>