@vertexvis/doc-viewer-react 0.24.5-canary.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - Present Vertex Software, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# React Bindings for Vertex Document Viewer SDK
+
+![npm](https://img.shields.io/npm/v/@vertexvis/doc-viewer-react)
+![npm (scoped with tag)](https://img.shields.io/npm/v/@vertexvis/doc-viewer-react/canary)
+
+This project contains React bindings for Vertex's Document Viewer SDK. These bindings are
+auto-generated from `@vertexvis/doc-viewer`.
+
+## Installation
+
+Run `yarn add @vertexvis/doc-viewer-react` or `npm install @vertexvis/doc-viewer-react`
+to add the project as an NPM dependency.
+
+## Usage
+
+`@vertexvis/doc-viewer` includes a component loader, `defineCustomElements`, that
+needs to be invoked to register the components with the browser. It also
+includes a global stylesheet with default styling. Consult your bundlers
+documentation on how to bundle CSS with your project's bundler.
+
+```jsx
+import React from 'react';
+import ReactDom from 'react-dom';
+
+import { defineCustomElements } from '@vertexvis/doc-viewer/loader';
+import '@vertexvis/doc-viewer/dist/doc-viewer/doc-viewer.css';
+
+async function main() {
+  await defineCustomElement(window);
+  ReactDom.render(<App />, document.querySelector('#app'));
+}
+
+main();
+```
+
+Next, add one of the components to your React component.
+
+```jsx
+import React from 'react';
+import { VertexDocumentViewer } from '@vertexvis/doc-viewer-react';
+import workerSrc from '@vertexvis/doc-viewer/assets/pdf.worker.min.mjs';
+
+export function App() {
+  return (
+    <div>
+      <VertexDocumentViewer config={{ pdfJs: { workerSrc } }} src="https://{{ DOCUMENT_URL }}" />
+    </div>
+  );
+}
+```
+
+### Note with Webpack builds
+
+Webpack will not recognize the `import workerSrc from '@vertexvis/doc-viewer/assets/pdf.worker.min.mjs';` import as
+an asset URL by default. This can cause Webpack to attempt to treat this file as a module and display warnings. To
+resolve this, the following can be added to your webpack config to indicate this file is an asset:
+
+```
+{
+  test: /pdf\.worker\.min\.mjs$/,
+  type: 'asset/resource',
+},
+```
+
+## Documentation
+
+See [@vertexvis/doc-viewer][component docs] for a full list of components and their
+documentation.
+
+[component docs]: https://github.com/Vertexvis/vertex-web-sdk/tree/master/packages/doc-viewer/src/components
+[css variables]: https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties
+[global styles]: https://github.com/Vertexvis/vertex-web-sdk/blob/master/packages/doc-viewer/src/css/global.css