Recurring invoices list page
The recurring invoices list page: header with a status filter and a New recurring invoice action, an optional Start from a contract drop zone, the schedules table and the cancel confirmation, with header actions, the empty state and an aside as props.
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-recurring-invoices-list-pageAlso installs: button, base-theme, base-page, base-info-hint, ar-schedules-table, ar-schedule-parts, ar-schedule-contract, ui-ar-recurring-invoices-list-page.
Usage
import { ArRecurringInvoicesListPage } from "@/components/dolfin/ar/recurring-invoices-list-page";
// A whole screen: mount it on a route, inside your <DolfinProvider>.
export default function Route() {
return <ArRecurringInvoicesListPage />;
}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 | ScheduleListFilters | Initial filters, e.g. read from the URL. |
onFiltersChange | (filters: ScheduleListFilters) => void | Called when the filters change, e.g. to write them to the URL. |
onContractRead | (terms: ScheduleContractTerms) => void | Shows "Start from a contract": called with the terms read off an uploaded contract, so the host can open `ArCreateRecurringInvoicePage` with `contractTerms`. Without it the drop zone is hidden. |
onCancelled | (schedule: Schedule) => void | After a schedule was cancelled from its row. |
readOnly | boolean | Hide the New button and the row's edit, pause, resume and cancel actions. |
onNavigate | (route: DolfinRoute) => void | |
pageSize | number | |
columns | ScheduleColumn[] | ((defaults: ScheduleColumn[]) => ScheduleColumn[]) | |
columnOrder | readonly string[] | |
columnVisibility | Readonly<Partial<Record<string, boolean>>> | |
rowActions | ScheduleRowAction[] | ((defaults: ScheduleRowAction[]) => ScheduleRowAction[]) | |
headerActions | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Rendered before the status filter and the New 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. |
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.schedules
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.
useCanManageSchedulesuseDolfinHasRouteuseDolfinNavigateuseMessagesFiles
Written to your app by the install command:
components/dolfin/ar/recurring-invoices-list-page.tsx185 lines