Documentation
Papyrium docs
Implementation-backed API reference and practical integration recipes.
Essentials
- Getting Started
Load a PDF, mount the viewer, and safely unload it.
- Overview
Scope and structure of the Papyrium documentation.
- Document Sources
Supported input types for PDF loading and thumbnail rendering.
Modules
- PapyriumViewer
Core module entry points for loading and unloading viewer instances.
- Public Exports
Complete list of runtime values and type exports from the public API entrypoint.
- Viewer Namespace
The default `Viewer` export and its static helpers.
Configuration
- Viewer Configuration
Configuration and option-focused type exports.
- Viewer Configuration Reference
Property-level reference for ViewerConfiguration.
- Chrome Options
Use full or minimal chrome, theme overrides, locale-aware text, and locale-inferred direction.
- Chrome CSS Tokens
CSS variable contract for chrome backgrounds, controls, and surfaces.
Instance API
- Core Instance Methods
Navigation, zoom, state updates, and lifecycle methods on ViewerInstance.
- Viewer Instance Reference
Method-level reference for ViewerInstance, grouped by workflow.
- Annotations and Selection
Create, update, delete, and select annotations with ViewerInstance APIs.
- Search and Text
Search term APIs, text extraction, and page text lines.
- Export and Document APIs
Save, export, print, and document-level operations.
Annotations
- Annotation API
Annotation-related public type exports.
- Annotation Types
Annotation-focused types exported by the public API.
Events
- Events
Event map and event name public type exports.
- Viewer Event Reference
Full list of strongly-typed ViewerEventName values.
- Viewer Events
Subscribe to viewer and compatibility events.
- Compatibility Events
Payload contracts for Papyrium compatibility event APIs.
Recipes
- Recipe: Load and Navigate
A production-ready pattern for loading, paging, and zooming.
- Recipe: Annotation Workflow
End-to-end annotation flow with selection helpers and CRUD APIs.
- Recipe: Export Workflow
Save, export PDF, and export Instant JSON safely.
Meta
- Known Limitations
Current gaps and constraints users should account for.
- Release Notes Policy
How docs and API changes are tracked.
- Migration and Compatibility
Guidance for teams migrating from older integration styles.