dolfindevelopers

Customer detail page

PageReceivablesSDK + UI

One customer: back link, header with contact line, Edit and Delete, what they owe and how much is overdue, contact, address and record cards, then tabs for the customer's invoices and credit notes. Plain node props for header actions, extra detail cards (e-invoicing, WhatsApp), the invoices and credit notes tabs, more tabs, an aside and extra form fields.

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

Choose your integration

Ready to connect to Dolfin. Loads data through SDK hooks, with appearance and behaviour you can customise. Requires DolfinProvider.

Loading preview…

Installation

Needs the Dolfin registry token. The CLI copies the source into your app.

Terminal
bunx --bun shadcn@4.23.0 add @dolfin/ar-customer-detail-page

Also installs: button, tabs, base-theme, base-page, base-states, base-info-hint, ar-customer-details, ar-edit-customer-dialog, ar-customer-delete-dialog, ui-ar-customer-detail-page.

Usage

route.tsx
import { ArCustomerDetailPage } from "@/components/dolfin/ar/customer-detail-page";

// A whole screen: mount it on a route, inside your <DolfinProvider>.
export default function Route({ params }: { params: { customerId: string } }) {
  return <ArCustomerDetailPage customerId={params.customerId} />;
}

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

PropTypeDescription
customerId requiredstring
headerActionsstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Beside the Edit and Delete buttons.
detailsstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Extra cards in the details grid (e.g. e-invoicing address, WhatsApp settings).
invoicesstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…The Invoices tab's content (e.g. an invoices table filtered to this customer). No tab without it.
creditNotesstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…The Credit notes tab's content. No tab without it.
tabsArCustomerDetailPageTabSlot[]More tabs after the built-in ones.
asidestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…A column beside the customer on wide pages.
emptyStatestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Replaces the not-found state.
formFieldsstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Extra fields in the edit dialog.
hideBalancebooleanLeave out the owed and overdue strip.
readOnlybooleanHide Edit and Delete.
defaultTabstring
hideBackLinkboolean
onNavigate(route: DolfinRoute) => voidOverrides the provider's navigation (after a delete, back to the customers list).
onDeleted(customerId: string) => voidAfter the customer was deleted. Defaults to opening the customers list.
classNamestring

Customisation

Without editing the source, you can change:

Class names
className
Messages
ar.customers

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.

useCanManageCustomersuseCustomeruseDolfinNavigateuseMessages

Files

Written to your app by the install command:

  • components/dolfin/ar/customer-detail-page.tsx 247 lines