@nutrient-sdk/viewer 1.10.0-nightly.20251208 → 1.10.0-nightly.20251209
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +80 -127
- package/dist/nutrient-viewer-lib/{chunk-848-222372849fba8049.js → chunk-848-32d80807e32b7dec.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-core-worker-bdfb8ba2181626aa.js → chunk-core-worker-4b361fe6fff5e30f.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-gdpicture-d31f97f6a05c914d.js → chunk-gdpicture-5d9ec5b0c65c3636.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-gdpicture-worker-9273f19d4648b10f.js → chunk-gdpicture-worker-3f998822ebbd5b27.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-lazy-sha-0ac0b1dd4f236010.js → chunk-lazy-sha-bdac911416a70dee.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ar-6fbf27a28d70dd40.js → chunk-locale-ar-eae6caa8512bff51.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-cs-f3ad4939cebf2a85.js → chunk-locale-cs-7f97879d868550e2.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-cy-788457a2022526ab.js → chunk-locale-cy-9f29939cfc26815a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-da-546907c94a65e16b.js → chunk-locale-da-1e394c84905b5d45.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-de-807474a749f7dc28.js → chunk-locale-de-9a363d795e6dcf4b.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-el-c175498b00aa2234.js → chunk-locale-el-4180db14e29ae3f4.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-en-GB-7161c332f19be648.js → chunk-locale-en-GB-2b487c7605f1862c.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-es-42e0ad7feb4871f1.js → chunk-locale-es-d3dc99bc68e6e0db.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fi-3f4c9553fdd63cbf.js → chunk-locale-fi-dd05bd7d6f5eec86.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fr-CA-b5e538f2294d6d5c.js → chunk-locale-fr-CA-b66e220c331b9a2d.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-fr-4916a027ff9f9cca.js → chunk-locale-fr-aed17f4b11f65bc4.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-he-ad1a79553f4e878f.js → chunk-locale-he-b1131c7bd9013d2c.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-hr-6a5184b589356be3.js → chunk-locale-hr-c315e1fa88d726b8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-id-e735fbd586973315.js → chunk-locale-id-34ee05f21b166522.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-it-c2d18def1295d645.js → chunk-locale-it-dec117e5c6c38b01.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ja-247ee0992330d790.js → chunk-locale-ja-87a26c37d7581d11.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ko-29c7af7588765377.js → chunk-locale-ko-9fbba1e9b0d0a269.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ms-4fa09f793ebd5974.js → chunk-locale-ms-098cacd778c64f0b.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-nb-NO-73cadbf59f1a3ef1.js → chunk-locale-nb-NO-fca3ee1f054fa14a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-nl-3ac6c1efa006c402.js → chunk-locale-nl-fb294ef0d78ac812.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pl-3013905081db6221.js → chunk-locale-pl-1cd919727541c621.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pt-PT-3963d97db5811716.js → chunk-locale-pt-PT-0727331fe9e0addb.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-pt-5bff5e44a1470a39.js → chunk-locale-pt-cab2e06566abd87a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-ru-014ce36ee06d61f8.js → chunk-locale-ru-f29e3c85580bb3e8.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sk-cc47d81854992ece.js → chunk-locale-sk-2a9b5361d902799d.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sl-88db159544b860d9.js → chunk-locale-sl-71310cd2651f2099.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-sv-387f22618de1a536.js → chunk-locale-sv-9d4330dd3e77dde2.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-th-4881ce6f7b67c5d7.js → chunk-locale-th-f798174518311d16.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-tr-4277812ee283a87b.js → chunk-locale-tr-f6465aba6bec8834.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-uk-52c32526fa90373f.js → chunk-locale-uk-26f9909e463fd96e.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-zh-Hans-cac8284ef40555ea.js → chunk-locale-zh-Hans-3f84aedd48ae0961.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-locale-zh-Hant-e835cfaa8376abf1.js → chunk-locale-zh-Hant-e7ae497c65e53272.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-offscreen-renderer-worker-2c03be35d202c62c.js → chunk-offscreen-renderer-worker-afec28db18a4e9eb.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-server-5de75f24fb1aa562.js → chunk-server-1d65fb8e02ba41c6.js} +2 -2
- package/dist/nutrient-viewer-lib/{chunk-server-instant-ff8db3b1d5fe65b0.js → chunk-server-instant-19092caa2f5a45e3.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-server-rest-125149bd4c665151.js → chunk-server-rest-a7eae128a7a04f4a.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-standalone-737035ead3a2ec51.js → chunk-standalone-641dcc25e6cad2f6.js} +1 -1
- package/dist/nutrient-viewer-lib/{chunk-standalone-server-11a29d3a66367079.js → chunk-standalone-server-312a7bb00c73efd8.js} +1 -1
- package/dist/nutrient-viewer-lib/core-worker.js +2 -2
- package/dist/nutrient-viewer-lib/dark-402cc98d3d69bff8.css +1 -1
- package/dist/nutrient-viewer-lib/gdpicture-worker.js +1 -1
- package/dist/nutrient-viewer-lib/{nutrient-viewer-1.10.0-07d9c9c.css → nutrient-viewer-1.10.0-700beb6.css} +1 -1
- package/dist/nutrient-viewer-lib/{nutrient-viewer-e3d23a53e31c8937.wasm → nutrient-viewer-819fd207224ff359.wasm} +0 -0
- package/dist/nutrient-viewer-lib/nutrient-viewer-9303291e7f6b26aa.wasm.js +1 -1
- package/dist/nutrient-viewer-lib/offscreen-render-worker.js +1 -1
- package/dist/nutrient-viewer.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,163 +1,116 @@
|
|
|
1
|
-
|
|
1
|
+
# Nutrient Web SDK: Document viewing and editing in the browser
|
|
2
2
|
|
|
3
|
-
Nutrient Web SDK (
|
|
3
|
+
Nutrient Web SDK (formerly PSPDFKit for Web) is a secure, client-side JavaScript library engineered for robust document viewing, annotation, and editing directly within the browser. It empowers developers to seamlessly integrate advanced document and image manipulation capabilities into any web application.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Developers can explore many [examples][awesome examples] and resources in the ecosystem, and the SDK comes fully supported by the dedicated team at [Nutrient][].
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- **Client-side** — Workload is offloaded to client (no server needed)
|
|
9
|
-
- **Secure** — Battle-tested, reliable PDFium-based PDF rendering engine
|
|
10
|
-
- **Office document support** — View and convert Office documents without third-party dependencies
|
|
7
|
+
## Key capabilities
|
|
11
8
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
1. Go to your project's root folder and run the following command in the terminal. It installs the Nutrient npm package and adds it as a project dependency:
|
|
19
|
-
|
|
20
|
-
```npm
|
|
21
|
-
npm install --save @nutrient-sdk/viewer
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
2. Run the following command to copy the Nutrient Web SDK distribution to the `assets` directory in your project’s root folder:
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
cp -R ./node_modules/@nutrient-sdk/viewer/dist/ ./assets/
|
|
28
|
-
```
|
|
9
|
+
* **Client-side processing** — The primary workload is offloaded to the client, eliminating the need for complex, dedicated server infrastructure.
|
|
10
|
+
* **Enhanced security** — Built on a battle-tested, reliable PDFium-based rendering engine.
|
|
11
|
+
* **Highly customizable** — A powerful, robust API allows for precise configuration of both behavior and visual appearance.
|
|
12
|
+
* **Office document support** — View and convert Office documents without external dependencies.
|
|
13
|
+
* **Framework agnostic** — Fully compatible with all major JavaScript/TypeScript frameworks, including React, Angular, Vue, Svelte, Next.js, Nuxt, Vite, and Electron.
|
|
29
14
|
|
|
30
|
-
|
|
15
|
+
Nutrient Web SDK processes a comprehensive range of file types, enabling client-side viewing and conversion directly on any browser — no server dependencies or MS Office licenses are required.
|
|
31
16
|
|
|
32
|
-
|
|
17
|
+
| Category | Supported file types |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| **PDF** | PDF, PDF/A (1, 2, 3, 4) |
|
|
20
|
+
| **Office documents** | DOCX, DOC, DOTX, DOCM, XLSX, XLS, XLSM, PPTX, PPT, PPTM |
|
|
21
|
+
| **Images** | PNG, JPEG, JPG, TIFF, TIF |
|
|
22
|
+
| **Text/data** | TXT, XFDF, Instant JSON |
|
|
33
23
|
|
|
34
|
-
|
|
35
|
-
<div id="nutrient" style="width: 100%; height: 100vh;"></div>
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
5. Add the following code to the main JavaScript file of your application. This imports and instantiates Nutrient Web SDK:
|
|
39
|
-
|
|
40
|
-
```js
|
|
41
|
-
import "./assets/nutrient-viewer.js";
|
|
24
|
+
<img src="https://www.nutrient.io/images/intercom/pspdfkit-npm.png" alt="Image showcasing the popular features of Nutrient Web SDK" width="100%" />
|
|
42
25
|
|
|
43
|
-
|
|
26
|
+
## Getting started
|
|
44
27
|
|
|
45
|
-
|
|
46
|
-
baseUrl,
|
|
47
|
-
container: "#nutrient",
|
|
48
|
-
document: "document.pdf"
|
|
49
|
-
});
|
|
50
|
-
```
|
|
28
|
+
Refer to our [getting started][getting started guide] guide for comprehensive integration instructions.
|
|
51
29
|
|
|
52
30
|
## Web demos
|
|
53
31
|
|
|
54
|
-
|
|
55
|
-
- [Customizable UI][]
|
|
56
|
-
- [Adding annotations][]
|
|
57
|
-
- [Filling PDF forms][]
|
|
58
|
-
- [Creating PDF forms][]
|
|
59
|
-
- [Signatures][]
|
|
60
|
-
- [Document editing][]
|
|
61
|
-
- [Document generation][]
|
|
62
|
-
- [Generate PDFs from DOCX templates][]
|
|
63
|
-
- [Real-time collaboration][]
|
|
64
|
-
- And [more][]
|
|
32
|
+
Explore the full potential of the SDK with our live web demonstrations:
|
|
65
33
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
34
|
+
* [Document viewing][]
|
|
35
|
+
* [Customizable UI][]
|
|
36
|
+
* [Adding annotations][]
|
|
37
|
+
* [Filling PDF forms][]
|
|
38
|
+
* [Creating PDF forms][]
|
|
39
|
+
* [Signatures][signature demo]
|
|
40
|
+
* [Document editing][]
|
|
41
|
+
* [Document generation][]
|
|
42
|
+
* [Generate PDFs from DOCX templates][]
|
|
43
|
+
* [Real-time collaboration][]
|
|
44
|
+
* And [more][]
|
|
73
45
|
|
|
74
46
|
## Browser support
|
|
75
47
|
|
|
76
|
-
|
|
48
|
+
The SDK supports the latest stable versions of all major web browsers: Chrome, Mozilla Firefox, Safari, Edge, and Firefox ESR.
|
|
49
|
+
|
|
50
|
+
## Documentation and support
|
|
77
51
|
|
|
78
|
-
|
|
52
|
+
Nutrient offers comprehensive [guides][] and [code samples][] to facilitate your integration and customization efforts.
|
|
79
53
|
|
|
80
|
-
|
|
54
|
+
We offer full technical support, providing direct access to the engineers who built the product. We’re happy to assist with setup, integration questions, and feature implementation.
|
|
81
55
|
|
|
82
|
-
|
|
56
|
+
### Most popular guides
|
|
83
57
|
|
|
84
|
-
|
|
58
|
+
| Category | Topics |
|
|
59
|
+
| --- | --- |
|
|
60
|
+
| **Viewing** | [PDF viewer][], [Search][] |
|
|
61
|
+
| **Editing and markup** | [Annotation][], [Editor][], [Redaction][] |
|
|
62
|
+
| **Forms and signatures** | [Forms][], [Signatures][] |
|
|
63
|
+
| **Document processing** | [Conversion][], [Office conversion][], [Extraction][], [PDF generation][] |
|
|
64
|
+
| **Security** | [Document security][] |
|
|
85
65
|
|
|
86
|
-
|
|
66
|
+
### API reference
|
|
87
67
|
|
|
88
|
-
|
|
89
|
-
- [Office conversion][]
|
|
90
|
-
- [Annotation][]
|
|
91
|
-
- [Forms][]
|
|
92
|
-
- [Signatures][]
|
|
93
|
-
- [Editor][]
|
|
94
|
-
- [PDF generation][]
|
|
95
|
-
- [Conversion][]
|
|
96
|
-
- [Extraction][]
|
|
97
|
-
- [Redaction][]
|
|
98
|
-
- [Document security][]
|
|
99
|
-
- [Search][]
|
|
68
|
+
[Read the full API reference][] for detailed class, method, and property documentation.
|
|
100
69
|
|
|
101
|
-
##
|
|
70
|
+
## Version history
|
|
102
71
|
|
|
103
|
-
|
|
72
|
+
Refer to our [changelog][] for a detailed list of changes included in each release.
|
|
104
73
|
|
|
105
|
-
##
|
|
74
|
+
## AI coding assistant integration
|
|
106
75
|
|
|
107
|
-
For
|
|
76
|
+
For developers utilizing an AI coding assistant (LLM) within their IDE or MCP, Nutrient Web SDK provides the [`llms.txt`][] file. Leveraging this file enables you to feed SDK-specific documentation directly into the LLM’s context, significantly enhancing the accuracy and relevance of AI-generated code suggestions.
|
|
108
77
|
|
|
109
|
-
## License and
|
|
78
|
+
## License and commercial information
|
|
110
79
|
|
|
111
|
-
Nutrient is a commercial product
|
|
80
|
+
Nutrient Web SDK is a commercial product. A [free trial][] is available for evaluation and integration purposes. Please visit our [pricing page][] to learn more about our licensing options.
|
|
112
81
|
|
|
113
|
-
Copyright © 2010
|
|
82
|
+
Copyright © 2010–present PSPDFKit GmbH.
|
|
114
83
|
|
|
115
|
-
[
|
|
116
|
-
[
|
|
117
|
-
[
|
|
118
|
-
[
|
|
119
|
-
[react]: https://www.nutrient.io//getting-started/web/?frontend=react&project=new-project
|
|
120
|
-
[angular]: https://www.nutrient.io//getting-started/web/?frontend=angular&project=new-project
|
|
121
|
-
[vue]: https://www.nutrient.io//getting-started/web/?frontend=vuejs&project=new-project
|
|
122
|
-
[svelte]: https://www.nutrient.io//getting-started/web/?frontend=svelte&project=new-project
|
|
123
|
-
[next.js]: https://www.nutrient.io//getting-started/web/?frontend=nextjs&download=npm&integration=global-variable&project=new-project
|
|
124
|
-
[nuxt]: https://www.nutrient.io/getting-started/web/?frontend=nuxtjs&download=npm&integration=global-variable&project=new-project
|
|
125
|
-
[vite]: https://www.nutrient.io/getting-started/web/?frontend=vite&download=npm&integration=global-variable&project=new-project
|
|
126
|
-
[electron]: https://www.nutrient.io/getting-started/web/?frontend=electron&download=npm&integration=global-variable&project=new-project
|
|
127
|
-
[javascript]: https://www.nutrient.io/getting-started/web/?frontend=vanillajs&download=npm&integration=global-variable
|
|
128
|
-
[typescript]: https://www.nutrient.io/getting-started/web/?frontend=typescript&download=npm&integration=global-variable&project=new-project
|
|
129
|
-
[salesforce]: https://www.nutrient.io/getting-started/web-integrations/?product=salesforce&project=new-project
|
|
130
|
-
[sharepoint]: https://www.nutrient.io/getting-started/web-integrations/?product=sharepoint&deployment=on-premises&project=new-project
|
|
131
|
-
[teams]: https://www.nutrient.io/getting-started/web-integrations/?product=teams
|
|
132
|
-
[onedrive]: https://www.nutrient.io/getting-started/web-integrations/?product=onedrive
|
|
133
|
-
[guides gs]: https://www.nutrient.io/getting-started/web/?utm_source=npm&utm_medium=referral&utm_campaign=readme
|
|
134
|
-
[demo document]: https://www.nutrient.io/downloads/pspdfkit-web-demo.pdf
|
|
135
|
-
[document viewing]: https://www.nutrient.io/demo/viewer?utm_source=npm&utm_medium=referral&utm_campaign=readme
|
|
84
|
+
[awesome examples]: https://github.com/PSPDFKit/awesome-nutrient?tab=readme-ov-file#web
|
|
85
|
+
[nutrient]: https://www.nutrient.io//company/about/
|
|
86
|
+
[getting started guide]: https://www.nutrient.io/sdk/web/getting-started/
|
|
87
|
+
[document viewing]: https://www.nutrient.io/demo/viewer
|
|
136
88
|
[customizable ui]: https://www.nutrient.io/demo/ui
|
|
137
|
-
[adding annotations]: https://www.nutrient.io/demo/annotations
|
|
89
|
+
[adding annotations]: https://www.nutrient.io/demo/annotations
|
|
138
90
|
[filling pdf forms]: https://www.nutrient.io/demo/forms?utm_source=npm&utm_medium=referral&utm_campaign=readme
|
|
139
91
|
[creating pdf forms]: https://www.nutrient.io/demo/pdf-form-creator
|
|
140
|
-
[
|
|
92
|
+
[signature demo]: https://www.nutrient.io/demo/signatures?utm_source=npm&utm_medium=referral&utm_campaign=readme
|
|
141
93
|
[document editing]: https://www.nutrient.io/demo/editor?utm_source=npm&utm_medium=referral&utm_campaign=readme
|
|
142
94
|
[document generation]: https://www.nutrient.io/demo/document-generation
|
|
143
95
|
[generate pdfs from docx templates]: https://www.nutrient.io/demo/generation-from-office-template
|
|
144
|
-
[real-time collaboration]: https://www.nutrient.io/demo/instant-collaboration
|
|
145
|
-
[more]: https://www.nutrient.io/demo
|
|
146
|
-
[guides
|
|
147
|
-
[code samples]: https://www.nutrient.io/guides/web/samples
|
|
148
|
-
[
|
|
149
|
-
[
|
|
150
|
-
[
|
|
151
|
-
[
|
|
152
|
-
[
|
|
153
|
-
[
|
|
154
|
-
[
|
|
155
|
-
[conversion]: https://www.nutrient.io/guides/web/conversion
|
|
156
|
-
[
|
|
157
|
-
[
|
|
158
|
-
[
|
|
159
|
-
[
|
|
160
|
-
[api reference]: https://www.nutrient.io/api/web/NutrientViewer.html
|
|
161
|
-
[changelog]: https://www.nutrient.io/changelog/
|
|
162
|
-
[
|
|
163
|
-
[
|
|
96
|
+
[real-time collaboration]: https://www.nutrient.io/demo/instant-collaboration
|
|
97
|
+
[more]: https://www.nutrient.io/demo/hello
|
|
98
|
+
[guides]: https://www.nutrient.io/guides/web/
|
|
99
|
+
[code samples]: https://www.nutrient.io/guides/web/samples/
|
|
100
|
+
[pdf viewer]: https://www.nutrient.io/guides/web/viewer/
|
|
101
|
+
[search]: https://www.nutrient.io/guides/web/search/
|
|
102
|
+
[annotation]: https://www.nutrient.io/guides/web/annotations/
|
|
103
|
+
[editor]: https://www.nutrient.io/guides/web/editor/
|
|
104
|
+
[redaction]: https://www.nutrient.io/guides/web/redaction/
|
|
105
|
+
[forms]: https://www.nutrient.io/guides/web/forms/
|
|
106
|
+
[signatures]: https://www.nutrient.io/guides/web/signatures/
|
|
107
|
+
[conversion]: https://www.nutrient.io/guides/web/conversion/
|
|
108
|
+
[office conversion]: https://www.nutrient.io/guides/web/conversion/pdf-to-office/
|
|
109
|
+
[extraction]: https://www.nutrient.io/guides/web/extraction/
|
|
110
|
+
[pdf generation]: https://www.nutrient.io/guides/web/pdf-generation/
|
|
111
|
+
[document security]: https://www.nutrient.io/guides/web/document-security/
|
|
112
|
+
[read the full api reference]: https://www.nutrient.io/api/web/modules/NutrientViewer.html
|
|
113
|
+
[changelog]: https://www.nutrient.io/guides/web/release-notes/changelog/
|
|
114
|
+
[`llms.txt`]: https://www.nutrient.io/guides/web/llms.txt
|
|
115
|
+
[free trial]: https://www.nutrient.io/try/
|
|
116
|
+
[pricing page]: https://www.nutrient.io/sdk/pricing/
|