Papers (Document Portal) Components User Guide
Category: Client Document Portal
Surface: Papers (papers)
Registered Admin Route: /admin/page-components
This guide covers all registered document lists, document detail views, embedded document viewers, client obligation trackers, portal stats, and quick action components for Orbit Papers.
Every row in the palette carries a ? button that opens that component's own help: overview, mental model, when to use it versus the alternatives, a complete property reference, worked recipes, accessibility and translation notes, gotchas, troubleshooting and an FAQ. It ships with the build, so it can never drift from the component you are configuring.
This guide is the map — which block to reach for and how they combine. The ? is the manual for each one.
A page's page type decides which blocks it is offered. If a component named here is missing from your palette, the page type is why — not a missing permission. See Visual Builder mode.
1. Document Management Components
UI Controls & Options
| Component Type | Description | Key Configurable Dropdowns & Inputs | Data Source Origin |
|---|---|---|---|
papers_portal_home | Document portal dashboard home | • Hero Title: e.g. Client Document Portal• Show Overview Stats: Toggle summary cards | Populates from Papers ➔ Documents. |
papers_document_list | Filterable document table | • Document Type Filter: e.g. Contracts, Invoices, Manuals• Items Per Page: 10, 25, 50 rows | Populates from Papers ➔ Document Library. |
papers_document_viewer | Embedded document viewer | • Viewer Mode: PDF Reader, Image Preview, Rich Text• Allow Download: Toggle download PDF button | Selected document file. |
papers_obligations | Signature & task tracker | • Status Filter: Pending Signature, Completed, Overdue• Show Due Date: Display expiration date badge | Populates from Papers ➔ Obligations. |
A. Document Viewer (papr_doc_viewer)
B. Document Navigation Tree (papr_doc_tree)
C. Document Search Bar (papr_doc_search)
D. Download Hub (papr_download_hub)
2. Papers Portal Summary & Quick Actions
- Papers Portal Overview Stats (
papers_portal_stats): Renders summary cards for total documents, documents pending signature, and unread client documents. - Papers Portal Quick Actions (
papers_quick_actions): Renders action shortcut cards for uploading documents, requesting signatures, and searching contract archives.