Purchase order detail page
One purchase order: back link, header with Edit, Close and Cancel, details, supplier, lines with match progress, matched bills and linked delivery notes. Accepts your own header actions (replacing Edit) and an aside.
Page: A complete screen for one route, such as a bill or the invoices list. Mount it on a route in your app; connected SDK pages provide data and actions; standalone UI pages receive them as props. Pages vs components
Works with Dolfin’s SDK context, 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-purchase-order-detail-pageAlso installs: ap-purchase-order-detail, ap-purchase-order-form-dialog, base-page, ui-ap-purchase-order-detail-page.
Usage
import { PurchaseOrderDetailPage } from "@/components/dolfin/ap/purchase-order-detail-page";
// A whole screen: mount it on a route, inside your <DolfinProvider>.
export default function Route({ params }: { params: { purchaseOrderId: string } }) {
return <PurchaseOrderDetailPage purchaseOrderId={params.purchaseOrderId} />;
}Renders inside DolfinProvider (set it up once). It renders the data you pass as props.
API reference
| Prop | Type | Description |
|---|---|---|
purchaseOrderId required | string | |
headerActions | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Beside Close and Cancel. Defaults to Edit while the order is open; pass `null` for none. |
aside | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | A column beside the order. |
hideBackLink | boolean | Hide the "Back to purchase orders" link. |
hideDeliveryNotes | boolean | Hide the linked delivery notes card. |
onSaved | (purchaseOrder: PurchaseOrder) => void | After the order is edited from this page. |
className | string |
Customisation
Without editing the source, you can change:
- Class names
className- Messages
ap.orders.purchaseOrder
Or edit the installed file directly: it is your code. See theming for colours and fonts.
Hooks
The SDK hooks this page uses. Use them directly from @dolfinai/react to build your own version.
useMessagesFiles
Written to your app by the install command:
components/dolfin/ap/purchase-order-detail-page.tsx74 lines