npm.io
4.1.0 • Published 3 months ago

@vaadin-component-factory/vcf-pdf-viewer

Licence
Apache-2.0
Version
4.1.0
Deps
0
Vulns
0
Weekly
0
Stars
3

npm version Published on Vaadin Directory Stars on vaadin.com/directory

<vcf-pdf-viewer>

<vcf-pdf-viewer> is a Web Component that provides a PDF viewer functionality. The component is developed in Lit and uses Mozilla's PDF.js

This component is part of Vaadin Component Factory.

Running demo

  1. Fork the vcf-pdf-viewer repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-pdf-viewer directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Development & publishing

DO NOT run npm run build before publishing a new release.

The pdfjs/dist files committed in this repository are manually edited to ensure correct module resolution. Running the build script will overwrite these files, generating incompatible file paths that will cause the component to fail when trying to resolve dependencies.

Only run npm run build if you are intentionally modifying the pdfjs dependency and are prepared to manually fix the resulting path references.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0.

Keywords