Bill document viewer
The bill's original PDF or image beside its details, from a fresh signed link, with loading, empty and error states.
Component: A piece you place inside your own screens: a table, a form, a card or a dialog. You decide the layout around it. Pages vs components
Ready to connect to Dolfin. Loads data through SDK hooks, with appearance and behaviour you can customise. Requires DolfinProvider.
Installation
Needs the Dolfin registry token. The CLI copies the source into your app.
bunx --bun shadcn@4.23.0 add @dolfin/ap-bill-document-viewerAlso installs: base-document-viewer, ui-ap-bill-document-viewer.
Usage
import { BillDocumentViewer } from "@/components/dolfin/ap/bill-document-viewer";
// Place it anywhere inside your <DolfinProvider>.
<BillDocumentViewer />Renders inside DolfinProvider (set it up once). By default it loads its own data through the SDK. Supplied-data examples show how to override that behavior.
API reference
| Prop | Type | Description |
|---|---|---|
billId | string | Fetches a fresh signed link to the bill's document. Leave it out and pass `url` to show your own. |
bill | Pick<{ id?: string; organisationId?: string; state?: components["schemas"]["BillState"]; source?: components["schemas"]["BillSource"]; eInvo… | The bill, when you already have it; otherwise the viewer reads it (shared with the bill page's cache). |
url | string | The document to show; null for none. Passing it (or `loading` / `error`) fetches nothing. |
fileType | string | "pdf" or an image type; guessed from the URL when left out. |
loading | boolean | |
error | Error | |
onRetry | () => void | |
showOpenLink | boolean | Shows an "Open in new tab" link above the document. |
className | string |
Customisation
Without editing the source, you can change:
- Class names
className- Messages
ap.bill.documentbase.documentViewerbase.statescore.errors
Or edit the installed file directly: it is your code. See theming for colours and fonts.
Hooks
The SDK hooks this component uses. Use them directly from @dolfinai/react to build your own version.
useBillDocumentuseMessagesFiles
Written to your app by the install command:
components/dolfin/ap/bill-document-viewer.tsx75 lines