Recurring invoices table
Recurring invoices with their customer (memo or line count beneath), cadence and start, the next invoice and whether it is sent or left as a draft, progress through the run and status, plus an optional per-invoice amount column (hidden by default). Rows open the schedule; the row menu opens the customer, edits, pauses, resumes and cancels. Configurable columns and row actions, a status filter, cursor pagination and 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/ar-schedules-tableAlso installs: button, base-theme, base-data-table, base-entity-cell, base-money, base-states, ar-invoices-filters, ar-schedule-parts, ui-ar-schedules-table.
Usage
import { ArSchedulesTable } from "@/components/dolfin/ar/schedules-table";
// Place it anywhere inside your <DolfinProvider>.
<ArSchedulesTable />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 | Filters for the list the table loads. With your own `schedules`, they only pick the "no matches" empty state. |
schedules | readonly ScheduleTableRow[] | Your own rows: the table then shows them and makes no request. Its row menu then offers Edit, Pause and Resume only for the callbacks you pass. |
loading | boolean | |
error | Error | |
onRetry | () => void | |
page | number | 1-based page number, for your own rows. |
hasNextPage | boolean | |
onPageChange | (page: number) => void | Shows the pager for your own rows. |
onEdit | (schedule: Schedule) => void | Adds Edit to editable schedules' menus (with your own rows). |
onPause | (schedule: Schedule) => void | Adds Pause to active schedules' menus (with your own rows). |
onResume | (schedule: Schedule) => void | Adds Resume to paused schedules' menus (with your own rows). |
pageSize | number | |
columns | ScheduleColumn[] | ((defaults: ScheduleColumn[]) => ScheduleColumn[]) | Replace or extend the default columns. |
columnOrder | readonly string[] | |
columnVisibility | Readonly<Partial<Record<string, boolean>>> | |
rowActions | ScheduleRowAction[] | ((defaults: ScheduleRowAction[]) => ScheduleRowAction[]) | Replace or extend the row menu (defaults: Open customer, Edit, Pause or Resume, Cancel). |
onCancel | (schedule: Schedule) => void | Adds the Cancel action; the caller confirms (e.g. with `ScheduleCancelDialog`). |
readOnly | boolean | Hides Edit, Pause, Resume and Cancel. |
onNavigate | (route: DolfinRoute) => void | |
onRowClick | (schedule: ScheduleTableRow) => void | Called when a row is clicked; given, it replaces the row's link. |
getRowRoute | (schedule: ScheduleTableRow) => DolfinRoute | null | Where a row links to when there is no `onRowClick`; the schedule by default (`null` for a plain row). |
emptyState | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | Replaces the default empty state. |
emptyAction | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | An action inside the default empty state (e.g. a New recurring invoice button). |
onClearFilters | () => void | Shown in the default "no matches" state, to clear the filters. |
isRowBusy | (schedule: ScheduleTableRow) => boolean | Shows a spinner on a row's menu (e.g. while it pauses). |
actionsHeader | string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re… | The row menu column's header. Defaults to "Actions" for screen readers only; pass text to show one. |
className | string | |
variant | DataTableVariant | |
classNames | DataTableClassNames | |
pager | boolean | Show the built-in previous / next pager when there is more than one page. Default true; pass false when you draw your own pager from the list's pagination (the table still dims while a page loads). |
onRowHover | (row: ScheduleTableRow | null) => void | Called with the row the pointer moves onto, and with `null` when the pointer leaves the rows (e.g. to highlight the row's point in a chart next to the table). Moving between rows reports the new row without a `null` first. |
Customisation
Without editing the source, you can change:
- Class names
classNameclassNames.frameclassNames.headerclassNames.headerCellclassNames.rowclassNames.cellclassNames.pager- Messages
ar.schedules
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.
useCanManageSchedulesuseDolfinLocaleuseDolfinNavigateuseMessagesuseScheduleActionsuseSchedulesFiles
Written to your app by the install command:
components/dolfin/ar/schedules-table.tsx401 linescomponents/dolfin/ar/schedule-columns.tsx102 lines