JavaScript PDF library
Nutrient Web SDK is an enterprise-grade JavaScript library designed for viewing, annotating, and editing PDFs directly in web browsers. It offers a comprehensive set of features for working with PDF documents in web applications.
Key capabilities
AI-powered document understanding
Instantly complete tasks, analyze text, and redact key information across your documents
Document editing and generation
Modify content, merge/split PDFs, and generate PDFs from templates
Conversion and extraction
Convert images to PDFs, render PDFs as images, and extract text or pages
OCR and barcode support (coming soon)
Make scans searchable, extract text from images, and read barcodes
Customizable user interface (UI)
Configure behavior, appearance, and tooltips, and hide specific annotation types
Client-side processing
Offloads workload to the browser with no server dependency
High-fidelity rendering
Uses a reliable PDFium-based engine for accurate document display
Comprehensive PDF tools
Annotate, edit, sign, fill forms, redact, and manipulate PDFs
Advanced form handling
Create, fill, and customize interactive forms programmatically or via the UI
Seamless integration
Works with SharePoint, Microsoft Teams, Salesforce, and more
Text search and redaction
Search text in documents, or remove sensitive information securely
Measurement tools
Measure area, distance, and perimeter in PDFs
Bookmark and outline management
Create, edit, and remove bookmarks and structured outlines
Document and text comparison
Compare text across PDFs, analyze content changes, and detect version differences
Build PDF solutions
Explore allPDF viewer
Configure a high-performance, customizable PDF document viewer for seamless document rendering
Annotations
Import, export, create, edit, sync, and flatten 17+ annotation types for collaboration
Interactive forms
Build interactive PDF forms, fill form fields, extract data, and customize form elements
Instant synchronization
Sync annotations instantly across multiple users, devices, or sessions
eSignatures and digital signatures
Add secure electronic and digital signatures to PDF documents
PDF editor
Modify document content, rearrange pages, merge or split PDFs, and more
File conversion
Convert Office documents, images, and PDFs to PDF/A and other formats
Content redaction
Securely redact sensitive information programmatically or via UI tools
Browser support
Nutrient Web SDK is compatible with the latest versions of popular browsers, including Google Chrome, Mozilla Firefox, Safari, Microsoft Edge, and Firefox ESR. For a complete browser compatibility list, visit our browser support page.
Framework support
Nutrient Web SDK is compatible with all JavaScript frameworks, including React, Angular, Vue, Svelte, Electron, Ruby on Rails, and TypeScript. It just needs a DOM container to append the viewer, which is possible with any framework.
Integration
Nutrient Web SDK is compatible with SharePoint, Microsoft Teams, Microsoft OneDrive, and Salesforce.
Operational modes
Nutrient Web SDK can run locally in the browser or work together with Document Engine — either self-hosted or managed — to offload document storing, rendering, and editing. See the full comparison between the two operational modes here.
Open and view PDFs
To load PDFs, use the load method, which takes a Configuration object as its parameter. This object specifies where the document is loaded on the page, the path to the source document, the license key, and more. For more information, see the guides on loading a document.
Integrate AI Assistant with Nutrient Web SDK
To integrate AI Assistant with Nutrient Web SDK, pass the AI Assistant configuration and a generated JSON Web Token (JWT) to PSPDFKit.load(). For more information, refer to our guide on AI Assistant integration with Nutrient Web SDK.
Create PDF annotations
Annotations can be created using annotation constructors and the Instance#create endpoint. This will return a promise that will resolve to created annotations with generated IDs set. Once annotations have been edited, they’ll need to be persisted. This is done by saving them. Save them to external storage or embed them into the document. They can also be exported to Instant JSON. For more information, see our guide on creating PDF annotations using JavaScript.
Add a text form field
To create a form field, first create the form element — also known as a widget annotation. Since the form field requires a widget annotation ID when it’s created, you’ll need to generate a unique ID for your widget annotation via PSPDFKit#generateInstantId(). For more information, see our guide on how to create fillable PDF forms.
Perform OCR on a document
Note: OCR is available when using Nutrient Web SDK with Document Engine. To perform optical character recognition (OCR) on a document, open the document from Document Engine and apply the performOcr document operation with Instance.applyOperations. For more information, see our guide on how to perform OCR.
Search and redact PDFs
To create redaction annotations based on specific search criteria, use PSPDFKit.Instance#createRedactionsBySearch(), which allows you to specify the search criteria, along with specifying a custom redaction annotation preset to be used when creating redactions based on search results. For more information, see our guide on searching and redacting PDFs.
FAQ