Some test text!
Welcome to PDFTron. This guide will help you integrate a free trial of WebViewer into VueJS applications on the browser. It will help you clone the Vue sample repository, walk through the project structure, and show you how to call other WebViewer API. Your free trial includes unlimited trial usage and support from solution engineers.
Clone the webviewer-vue-sample
repository:
git clone https://github.com/PDFTron/webviewer-vue-sample.git
Enter the directory and run npm install:
cd webviewer-vue-sample
npm install
This will automatically download and extract the PDFTron WebViewer Package.
You are now ready to run the sample or use more WebViewer APIs.
After initial setup, the webviewer-vue-sample
directory should be laid out like this:
webviewer-vue-sample
├── LICENSE
├── package.json
├── package-lock.json
├── README.md
├── CONTRIBUTING.md
├── babel.config.js
├── node_modules
│ ├── ...
├── public
│ ├── lib
│ │ ├── ...
│ ├── index.html
│ └── favicon.ico
└── src
├── assets
│ ├── ...
├── components
│ └── WebViewer.vue
├── App.vue
└── main.js
Notable files and directories include:
File/Folder | Description |
---|---|
LICENSE | Lists the copyright and license information. |
package.json | Lists the manifest of the project and contains the author/version metadata. |
public | Contains the static index.html page that is loaded onto the browser and all other resources for the VueJS project including the icon. This is also where the Webviewer lib is extracted to when you run npm install . |
src | Contains all the JavaScript files and assets for the VueJS project |
src/App.js | Contains the App component which imports the WebViewer.vue component, adds styling and places it on the HTML page using a <div> tag. |
src/components/WebViewer.vue | This is where the WebViewer API calls are placed once the component is mounted. |
Run the application by executing:
npm run serve
Then open a browser and go to localhost:8080
to see the application.
Your app should look like this:
Note: If your browser does not open automatically to open the WebViewer, navigate to localhost:8080
to see the project.
To call more WebViewer APIs, open /www/js/index.js
in your favorite text editor and add the API calls to the callback for the WebViewer instantiation:
export default {
name: 'WebViewer',
props: {
path: String,
url: String
},
mounted: function () {
WebViewer({
path: this.path,
initialDoc: this.url, // replace with your own PDF file
}, this.$refs.viewer).then((instance) => {
// at this point, the viewer is 'ready'
// call methods from instance, docViewer and annotManager as needed
this.docViewer = instance.docViewer;
this.annotManager = instance.annotManager;
// you can also access major namespaces from the instance as follows:
// const Tools = instance.Tools;
// const Annotations = instance.Annotations;
// now you can access APIs through `this.instance`
// or listen to events from the viewer element
this.docViewer.on('documentLoaded', () => {
// call methods relating to the loaded document
});
});
}
}
For example, if you want to change the theme of the WebViewer to dark mode, you would add the following:
instance.setTheme('dark');
Execute npm run serve
again and the theme of the viewer will change.
Get the answers you need: Support
Get unlimited trial usage of PDFTron SDK to bring accurate, reliable, and fast document processing capabilities to any application or workflow.
Select a platform to get started with your free trial.
Web
Android
iOS
Windows
Linux
Unlimited usage. No email address required.