Frameworks
Integrations
Mendix
SharePoint
Default UI
Modular UI
AnnotationManager
Annotation Types
Customize
Version 11
v11.0
Version 10
v10.12
v10.11
v10.10
v10.9
v10.8
v10.7
v10.6
v10.5
v10.4
v10.3
v10.2
v10.1
v10.0
Version 8
v8.12
v8.11
v8.10
v8.9
v8.8
v8.7
v8.6
v8.5
v8.4
v8.3
v8.2
v8.1
v8.0
Version 7
Version 6
v6.3
v6.2
v6.1
v6.0
Version 5
Version 4
Version 3
Version 2
WebViewer Server
WebViewer BIM
Built in React, the WebViewer UI provides a great developer experience for anyone interested in the source code. You can make adjustments of your own, run it to test, and build it to deploy.
For a better developer experience, we have open sourced the project in Github. It allows you to keep track of your changes better or sync with future versions easier.
A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. To fork and sync with Apryse's webviewer-ui repo, follow these steps:
See Forking a repo for more information.
The default branch of the repo is the latest stable WebViewer version. For example, if the default branch is 7.1
, then it means the latest official WebViewer version is 7.1
.
You should switch the branch to be the WebViewer version you are currently using for your application. For example, if you are using WebViewer 7.0
then you should switch to the 7.0
branch and modify the code there. If you are using the legacy UI, then you need to switch to legacy/7.0
instead.
Code in the master
branch is considered to be experimental and is not safe to be used in production. Generally we don't recommend that you modify the code in the master
branch.
To run the project,
webviewer-ui
reponpm install
npm run download-webviewer
npm start
To build the source files into webviewer-ui.min.js
,
npm run build
When you want to merge any changes from the original Apryse's webviewer-ui repo, follow these steps:
webviewer-ui
See Syncing a fork for more information.
If you want your changes to be implemented into Apryse's webviewer-ui so that they are available in future releases, see Creating a pull request.
After npm run build
, copy all the files in the webviewer-ui/build
folder to the lib/ui
folder in your app. Restart your app and you should see the new changes. You can write a script to automate this process.
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales