Skip to content
costacloud edited this page Sep 27, 2026 · 4 revisions

Welcome to TeamSync PDF Viewer SDK Wiki

TeamSync PDF Viewer UI

TeamSync PDF Viewer is an enterprise-grade, 100% client-side WebAssembly PDF engine built for React & TypeScript applications.


πŸ“š Quick Navigation

Guide Description
πŸš€ Getting Started Installation via NPM, Yarn, pnpm, and initial setup guide
βš™οΈ API Reference & Options Complete options & parameter reference for WebViewer & <DocumentViewer />
⚑ Performance & Massive Document Scaling Continuous scroll canvas virtualization, memory lifecycle, and 1,000+ page scaling
πŸ“ Interactive Forms & Multi-Role Signatures PDF form designer, multi-role template assignment, signature sticky index flags & SDK
🎨 Annotations & Markup Guide Freehand drawing, highlighters, geometric vector shapes, notes & hyperlinks
πŸ›‘οΈ Redactions & PII Sanitization Binary vector redactions, text layer sanitization, regex PII scanning & discard options
πŸ’§ Forensic Watermarking Single centered or full-page tiled dynamic watermarking
πŸ”Œ Plugin Architecture Creating custom extension modules with ViewerPlugin & PluginContext

🌟 Core Highlights (v2.1.0)

  • Zero Vendor Lock-In: 100% free and open-source under CPAL 1.0. No per-server fees or paywalls.
  • Viewport Canvas Virtualization: Off-screen pages unmount high-DPI canvases via IntersectionObserver with an 800px lookahead buffer, seamlessly supporting 1,000+ page documents without mobile Safari memory exhaustion.
  • Enterprise Security Hardening: Sanitized SVG entity escaping, strict signature upload MIME validation (image/png, image/jpeg, image/webp), and pure in-memory Base64 Data URL decoding without external network fetch.
  • Multi-Role Forms & Sticky Index Flags: Decoupled template roles with visual sticky index flags docked along the viewport edge, supporting 1-click cross-page smooth scroll and focus pulsing.
  • High-DPI Retina Rendering: Crisp 60 FPS pinch-zoom and 360Β° mouse drag panning.

Clone this wiki locally