https://github.com/pspdfkit/pspdfkit-electron-example
PSPDFKit for Electron Example Application
https://github.com/pspdfkit/pspdfkit-electron-example
electron pdf pspdfkit sdk
Last synced: about 1 month ago
JSON representation
PSPDFKit for Electron Example Application
- Host: GitHub
- URL: https://github.com/pspdfkit/pspdfkit-electron-example
- Owner: PSPDFKit
- Created: 2018-03-28T09:40:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T10:34:13.000Z (2 months ago)
- Last Synced: 2025-03-25T22:51:30.630Z (about 2 months ago)
- Topics: electron, pdf, pspdfkit, sdk
- Language: JavaScript
- Homepage: https://pspdfkit.com/pdf-sdk/electron/
- Size: 546 KB
- Stars: 15
- Watchers: 13
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> ⚠️ **Repository Moved**
> This repository has been moved to https://github.com/PSPDFKit/nutrient-web-examples/tree/main/examples/electron.
> Please update your bookmarks and issues accordingly.
>
> This repo is now archived and will no longer receive updates.
# Nutrient Electron Example App
This example shows how to build a [Nutrient Electron](https://www.nutrient.io/electron/) application with
[Electron](https://electronjs.org/).
This example uses context isolation, with node integration disabled. If you're looking for an example with node integration enabled, you can switch to the [`nodeintegration` branch](https://github.com/PSPDFKit/pspdfkit-electron-example/tree/nodeintegration).
## Prerequisites
- [Node.js](http://nodejs.org/)
## Usage with a license key
The example will work out of the box in demo mode, when no license key is passed. However, if used with a license key, we need to make sure that the corresponding bundle ID is passed in the `electronAppName` property of the configuration object passed to `PSPDFKit.load()` in `src/index.html`:
```js
PSPDFKit.load({
// other options
licenseKey: "LICENSE KEY GOES HERE",
electronAppName: "BUNDLE ID GOES HERE",
});
```
## Support and Issues
Are you [evaluating our SDK](https://www.nutrient.io/try/)? That's great, we're happy to help out! To make sure this is fast, please use a work email and have someone from your company fill out our sales form: https://www.nutrient.io/sales/
## Getting Started
Clone the repo:
```bash
git clone https://github.com/PSPDFKit/pspdfkit-electron-example.git
cd pspdfkit-electron-example
```
Install the project dependencies with `npm`:
```bash
npm install
```
**Important:** If you are using Windows, do not use PowerShell. Instead, use Microsoft’s [Developer Command Prompt for Visual Studio](https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs).
## Running the Example
We are ready to launch the app! 🎉
```bash
npm run start
```
The Electron application will automatically start.
To open the developer tools inside Electron, uncomment the following line in `index.js`:
```js
// Open the DevTools.
mainWindow.webContents.openDevTools();
```
## What's in This Repository
This repository contains an example integration of [Nutrient Electron](https://www.nutrient.io/electron). The project structure is influenced by the default Electron example app and comes with the following files, among other:
| Filename | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `src/index.js` | The main entry point used to create the Electron windows. This file does not contain major changes, with the exception of a validation to make sure that PSPDFKit is properly installed. It is responsible for loading `src/index.html`. |
| `src/index.html` | The main HTML entry point. It will set up a simple HTML structure and load the PSPDFKit library and provided example document. |
| `src/preload.js` | This file is where the Node API helpers are imported and exposed to the browser window. |
## Build Production Packages
We recommend using [`electron-packager`](https://github.com/electron-userland/electron-packager) or a similar solution to build the production bundles.
### Install `electron-packager`
```bash
npm install -g electron-packager
```
### Build Individual Packages
The following code will only work on macOS. For other platforms, please consult the [documentation](https://github.com/electron-userland/electron-packager#electron-packager) of `electron-packager`:
```bash
npm run package-mac-intel
npm run package-mac-apple (Apple Silicon)
npm run package-win (requires Wine: `brew cask install xquartz`, `brew install wine`)
npm run package-linux (requires `apt-get install libgconf-2-4` on target Linux)
```
## License
This software is licensed under a [modified BSD license](LICENSE).
## Contributing
Please ensure
[you have signed our CLA](https://www.nutrient.io/guides/web/current/miscellaneous/contributing/) so that we can
accept your contributions.