TruPDF documentation

TruPDF is a standalone, embeddable document viewer for the web. PDF render + 35+ annotation types + AcroForm/XFA forms + Office/HTML/image conversion + structural redaction + digital signatures + document compare + OCR + real-time collaboration + AI features + 3D PDF poster rendering, shipped as a typed TypeScript SDK with React, Vue, Angular, and Svelte wrappers.

The rendering, annotation, and document-writing engines are built and maintained by TruenoTech — nothing in the runtime carries copyleft obligations into your product. Pixel-accurate render. Acrobat-compatible XFDF.

Start here

• Quick setup — get the SDK installed and rendering a PDF in five minutes.
• Advanced setup — env vars, package registry, self-hosted conversion + redaction services, secure mode, AI provider config.
• Architecture — three-layer rendering, coordinate systems, secure mode.
• Licensing — tiers, trial behaviour, feature gates, renewals.

Features

• Viewer & navigation — zoom, rotate, search, thumbnails, outline, page operations, print, export, attachments.
• Annotations — 35+ types, XFDF round- trip, undo/redo, replies, presets, stylus input.
• Forms — AcroForm, static XFA, FDF / XFDF data, sandboxed calculation engine.
• Conversion — Office, HTML, images, text, markdown, email, XPS, legacy WebViewer XOD, and 2D CAD → PDF via the TruPDF conversion engine.
• Security & redaction — DRM, watermark, audit log, structural redaction via the TruPDF document service.
• Digital signatures — PKCS#7 sign, cert-chain verify, OCSP/CRL, LTV check.
• Document compare — text diff, visual diff, side-by-side, overlay.
• OCR — the TruPDF OCR engine (WASM, runs fully in-browser), ~100 languages, lazy loaded.
• Collaboration — real-time annotation sync over WebSocket.
• Content editing — insert paragraph, insert image, replace text via content-stream rewrite.
• AI features — summarize, explain, extract, parse, with provider abstraction (Anthropic, Gemini, OpenAI- compatible, on-prem MCP).
• Accessibility — WCAG 2.2 AA, keyboard navigation, screen-reader live regions, RTL.
• Mobile & touch — pinch zoom, two-finger rotate, stylus input, responsive toolbar.

Customization

• Theming — CSS custom properties, light / dark / system, brand colors.
• UI presets — 5 built-in layouts + custom modular JSON config.
• Toolbar & ribbons — registering actions, hiding built-ins, custom icons.
• Plugin API — sidebar panels, menu items, custom tools.
• Event bus — every event the SDK emits, with payload shapes.
• Internationalization — 31 locales, RTL, custom translations.
• Keyboard shortcuts — default hotkeys and how to override.

API reference

• @trupdf/sdk — framework-agnostic entry point.
• @trupdf/core — viewer engine + UI components.
• @trupdf/annotations — annotation engine.
• @trupdf/forms — AcroForm / XFA.
• @trupdf/converter — conversion service.
• @trupdf/security — DRM, redaction, watermark.
• @trupdf/signature — sign + verify.
• @trupdf/compare — text + visual diff.
• @trupdf/ocr — in-browser OCR engine.
• @trupdf/collaboration — WebSocket sync.
• @trupdf/content-edit — content-stream edits.
• @trupdf/ai — AI engine + providers.
• @trupdf/licensing — license lifecycle.
• @trupdf/i18n — locale runtime.
• @trupdf/a11y — accessibility helpers.
• @trupdf/threed — 3D annotation detection (U3D / PRC) + poster rendering.
• Framework wrappers — @trupdf/react, @trupdf/vue, @trupdf/angular, @trupdf/svelte.

Roadmap

Build phases — what's shipped, test counts, what's next.