Customers list page
The customers list page: header with a New customer action, name and email filters, the customers table, and the create, edit and delete dialogs, with props for header actions, the empty state, 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
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/ar-customers-list-pageAlso installs: button, base-theme, base-page, base-info-hint, ar-customers-table, ar-create-customer-dialog, ar-edit-customer-dialog, ar-customer-delete-dialog, ui-ar-customers-list-page.
Usage
import { ArCustomersListPage } from "@/components/dolfin/ar/customers-list-page";
// A whole screen: mount it on a route, inside your <DolfinProvider>.
export default function Route() {
return <ArCustomersListPage />;
}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 |
|---|---|---|
filters | CustomerListFilters | Initial filters, e.g. read from the URL. |
onFiltersChange | (filters: CustomerListFilters) => void | Called once a filter change applies (after the 400ms debounce), e.g. to write it to the URL. |
onCreated | (customer: Customer) => void | After a customer was created from the page. |
readOnly | boolean | Hide the New customer button and the row Edit and Delete actions. |
onNavigate | (route: DolfinRoute) => void | |
pageSize | number | |
columns | CustomerColumn[] | ((defaults: CustomerColumn[]) => CustomerColumn[]) | |
columnOrder | readonly string[] | |
columnVisibility | Readonly<Partial<Record<string, boolean>>> | |
rowActions | CustomerRowAction[] | ((defaults: CustomerRowAction[]) => CustomerRowAction[]) | |
headerActions | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Rendered before the New customer button. |
emptyState | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Replaces the table's empty state. |
aside | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Rendered beside the list on wide pages. |
formFields | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Extra fields in the create and edit dialogs (e.g. e-invoicing or WhatsApp settings). |
title | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | |
eyebrow | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | |
description | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | |
className | string |
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.
useCanManageCustomersuseCustomersuseMessagesFiles
Written to your app by the install command:
components/dolfin/ar/customers-list-page.tsx199 lines