https://github.com/aidear3/webviewer-ui
WebViewer UI built in React
https://github.com/aidear3/webviewer-ui
pdfviewer react react-pdf reactjs webviewer webviewer-ui
Last synced: about 2 months ago
JSON representation
WebViewer UI built in React
- Host: GitHub
- URL: https://github.com/aidear3/webviewer-ui
- Owner: aidear3
- License: other
- Created: 2023-04-17T09:18:44.000Z (about 2 years ago)
- Default Branch: 10.0
- Last Pushed: 2023-04-17T12:48:15.000Z (about 2 years ago)
- Last Synced: 2025-01-12T20:45:33.378Z (4 months ago)
- Topics: pdfviewer, react, react-pdf, reactjs, webviewer, webviewer-ui
- Language: JavaScript
- Homepage:
- Size: 66.8 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# WebViewer UI
WebViewer UI sits on top of [WebViewer](https://apryse.com/products/webviewer), a powerful JavaScript-based PDF Library that's part of the [Apryse PDF SDK](https://www.apryse.com). 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.
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.
Any approved pull requests made to this repository are merged into WebViewer's internal builds, and can be accessed through the nightly builds.
Any approved pull requests to the master branch will go to WebViewer's [nightly experimental builds](https://www.pdftron.com/nightly/#experimental/) and pull requests to version number branches will go to that version's [nightly stable](https://www.pdftron.com/nightly/#stable/).
Nightly stable and experimental builds can also be downloaded from [WebViewer's NPM package](https://docs.apryse.com/documentation/web/faq/webviewer-nightly-build/#npm).
## Install
```
npm install
```
### Install WebViewer Core Dependencies
The preferred method to install the Core dependencies is to use the [WebViewer NPM package](https://docs.apryse.com/documentation/web/get-started/npm/#1-install-via-npm).
Once installed, copy the Core folder into the path being used by the viewer for its dependencies (/lib by default).
## Run
```
npm start
```
## Build
```
npm run build
```
## Troubleshooting
If you are using NPM version 7 or higher, you may get an error indicating an issue with the dependency tree. There are two possible solutions for this:
- Downgrade your version of Node to v14, which uses NPM version 6.
- When running `npm install` add the flag `--legacy-peer-deps`. You can read more about this flag in this [Stack Overflow post](https://stackoverflow.com/questions/66239691/what-does-npm-install-legacy-peer-deps-do-exactly-when-is-it-recommended-wh).
## 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](https://docs.apryse.com/api/web/UI.html).
## Contributing
See [contributing](./CONTRIBUTING.md).
## License
See [license](./LICENSE).
