{"id":20049384,"url":"https://github.com/aidear3/webviewer-ui","last_synced_at":"2025-11-28T07:06:56.703Z","repository":{"id":153905102,"uuid":"628929879","full_name":"aidear3/webviewer-ui","owner":"aidear3","description":"WebViewer UI built in React","archived":false,"fork":false,"pushed_at":"2023-04-17T12:48:15.000Z","size":70015,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"10.0","last_synced_at":"2025-01-12T20:45:33.378Z","etag":null,"topics":["pdfviewer","react","react-pdf","reactjs","webviewer","webviewer-ui"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aidear3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-04-17T09:18:44.000Z","updated_at":"2023-10-08T07:51:49.000Z","dependencies_parsed_at":"2023-05-06T16:48:07.765Z","dependency_job_id":null,"html_url":"https://github.com/aidear3/webviewer-ui","commit_stats":null,"previous_names":["aidear323/webviewer-ui","aidear3/webviewer-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidear3%2Fwebviewer-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidear3%2Fwebviewer-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidear3%2Fwebviewer-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidear3%2Fwebviewer-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aidear3","download_url":"https://codeload.github.com/aidear3/webviewer-ui/tar.gz/refs/heads/10.0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241479539,"owners_count":19969468,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pdfviewer","react","react-pdf","reactjs","webviewer","webviewer-ui"],"created_at":"2024-11-13T11:49:45.326Z","updated_at":"2025-11-28T07:06:56.672Z","avatar_url":"https://github.com/aidear3.png","language":"JavaScript","readme":"# WebViewer UI \n\nWebViewer 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.\n\n![WebViewer UI](https://www.pdftron.com/downloads/pl/webviewer-ui.png)\n\nThis repo is specifically designed for any users interested in advanced customizations. With the source code access, it gives developers full control to customize \u0026 style the UI, build custom controls \u0026 logic, integrate into workflows, or build a UI from scratch.\n\nAny approved pull requests made to this repository are merged into WebViewer's internal builds, and can be accessed through the nightly builds. \nAny 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/).\n\nNightly stable and experimental builds can also be downloaded from [WebViewer's NPM package](https://docs.apryse.com/documentation/web/faq/webviewer-nightly-build/#npm).\n\n## Install\n\n```\nnpm install\n```\n\n### Install WebViewer Core Dependencies\n\nThe 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).\n\nOnce installed, copy the Core folder into the path being used by the viewer for its dependencies (/lib by default).\n\n## Run\n\n```\nnpm start\n```\n\n## Build\n\n```\nnpm run build\n```\n\n## Troubleshooting\n\nIf 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:\n- Downgrade your version of Node to v14, which uses NPM version 6. \n- 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).\n\n## Project structure\n\n```\nsrc/\n  apis/            - APIs exposed in myWebViewer.getInstance()\n  components/      - React components\n  constants/       - JavaScript or CSS constants\n  core/            - APIs from the Core\n  event-listeners/ - Listeners for the Core events\n  helpers/         - Reused functions\n  redux/           - Redux files for state managing\n  lib/             - Lib folder created upon npm install, used for dev testing only\n```\n\n## API documentation\n\nSee [API documentation](https://docs.apryse.com/api/web/UI.html).\n\n## Contributing\n\nSee [contributing](./CONTRIBUTING.md).\n\n## License\n\nSee [license](./LICENSE).\n![](https://onepixel.pdftron.com/webviewer-ui)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidear3%2Fwebviewer-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faidear3%2Fwebviewer-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidear3%2Fwebviewer-ui/lists"}