Skip to content

DiligentCorp/webviewer-ui

 
 

Repository files navigation

WebViewer UI - v5.1

=======

Diligent Install Notes

After making any changes to the viewer code run

npm run build

Then copy the files from the /build folder to Client/libs/assets/WebViewer.5.1.10-1/lib/ui/build in the Boards Web Repo Increment the '-1' each time new changes are made, and change any references to the web viewer location to point to the new version and delete the old version.

Note: when merging in changes from the official PDFTron webviewer-ui repo you should also update the core version by copying the files from the official version avaliable here: https://www.pdftron.com/documentation/web/get-started/manually into the boards web repo.

Note: Be careful to ensure that the core version matches the UI version and also that any changes made in the Client\libs\assets\WebViewer.version directory are redone after replacing the code

WebViewer UI

WebViewer UI sits on top of WebViewer, a powerful JavaScript-based PDF Library that's part of the PDFTron PDF SDK. Built in React, WebViewer UI provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.

WebViewer UI

This repo is specifically designed for any users interested in advanced customizations. With the source code access, it gives developers full control to customize & style the UI, build custom controls & logic, integrate into workflows, or build a UI from scratch.

Install

npm install
npm run download-webviewer

Run

npm start

Build

npm run build

Project structure

src/
  apis/            - APIs exposed in myWebViewer.getInstance()
  components/      - React components
  constants/       - JavaScript or CSS constants
  core/            - APIs from the Core
  event-listeners/ - Listeners for the Core events
  helpers/         - Reused functions
  redux/           - Redux files for state managing
  lib/             - Lib folder created upon npm install, used for dev testing only

API documentation

See API documentation.

Contributing

See contributing.

License

See license.

Packages

No packages published

Languages

  • JavaScript 92.2%
  • CSS 7.5%
  • HTML 0.3%