@vertexvis/doc-viewer-vue 0.24.4-canary.16

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,92 @@
+# Vue Bindings for Vertex Document Viewer SDK
+
+![npm](https://img.shields.io/npm/v/@vertexvis/doc-viewer-vue)
+![npm (scoped with tag)](https://img.shields.io/npm/v/@vertexvis/doc-viewer-vue/canary)
+
+This project contains Vue bindings for Vertex's Document Viewer SDK. These bindings are
+auto-generated from `@vertexvis/doc-viewer`.
+
+## Installation
+
+Run `yarn add @vertexvis/doc-viewer-vue` or `npm install @vertexvis/doc-viewer-vue`
+to add the project as an NPM dependency.
+
+## Usage
+
+Prior to to use the component wrappers, we'll need to update the
+`vite.config.ts` for the project to indicate that these wrappers are custom
+elements. This will prevent warnings from Vue failing to resolve the custom
+elements.
+
+```typescript
+// vite.config.ts
+
+export default defineConfig({
+  plugins: [
+    vue({
+      template: {
+        compilerOptions: {
+          isCustomElement: (tag) => tag.includes('vertex-')
+        }
+      }
+    }),
+    vueJsx()
+  ]
+});
+```
+
+Next, `@vertexvis/doc-viewer-vue` includes a Vue [Plugin][vue plugins], 
+`VertexDocumentViewerPlugin`, that needs to be added to the Vue App. It also
+includes a global stylesheet with default styling. Consult your bundler's
+documentation on how to bundle CSS with your project's bundler.
+
+```jsx
+import '@vertexvis/doc-viewer/dist/doc-viewer/doc-viewer.css';
+
+import { createApp } from 'vue';
+import { VertexDocumentViewerPlugin } from '@vertexvis/doc-viewer-vue';
+import App from './App.vue';
+
+createApp(App).use(VertexDocumentViewerPlugin).mount('#app');
+```
+
+Lastly, use the component wrappers in one of your Vue components.
+
+```tsx
+<script setup lang="ts">
+  import { onMounted, ref } from 'vue';
+  import workerSrc from '@vertexvis/doc-viewer/assets/pdf.worker.min.mjs?url';
+  
+  const viewer = ref<HTMLVertexDocumentViewerElement | null>(null);
+
+  onMounted(async () => {
+    if (viewer.value != null) {
+      // Configure the PDF.js worker source relative to your application's build
+      viewer.value.config = {
+        pdfJs: {
+          workerSrc
+        }
+      }
+    }
+  });
+</script>
+
+<template>
+  <vertex-document-viewer
+    id="document-viewer"
+    ref="viewer"
+    src="https://{{ DOCUMENT_URL }}"
+  >
+  </vertex-document-viewer>
+</template>
+```
+
+## Documentation
+
+See [@vertexvis/doc-viewer][component docs] for a full list of components and their
+documentation.
+
+[vue plugins]: https://vuejs.org/guide/reusability/plugins.html
+[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