dolfindevelopers

Suppliers list page

PagePayablesSDK + UI

The suppliers list page: header with a New supplier action, name and email filters, the suppliers table, and the create and edit dialogs, taking your own header actions, the empty state 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

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/ap-suppliers-list-page

Also installs: button, base-theme, base-page, base-info-hint, ap-suppliers-table, ap-create-supplier-dialog, ap-edit-supplier-dialog, ui-ap-suppliers-list-page.

Usage

route.tsx
import { ApSuppliersListPage } from "@/components/dolfin/ap/suppliers-list-page";

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

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
filtersSupplierListFiltersInitial filters, e.g. read from the URL.
onFiltersChange(filters: SupplierListFilters) => voidCalled once a filter change applies (after the 400ms debounce), e.g. to write it to the URL.
onCreated(supplier: Supplier) => voidAfter a supplier was created from the page.
readOnlybooleanHide the New supplier button and the row Edit action.
onNavigate(route: DolfinRoute) => void
pageSizenumber
columnsSupplierColumn[] | ((defaults: SupplierColumn[]) => SupplierColumn[])
columnOrderreadonly string[]
columnVisibilityReadonly<Partial<Record<string, boolean>>>
rowActionsSupplierRowAction[] | ((defaults: SupplierRowAction[]) => SupplierRowAction[])
headerActionsstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Rendered before the New supplier button.
emptyStatestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Replaces the table's empty state.
asidestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Rendered beside the list on wide pages.
titlestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…
eyebrowstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…
descriptionstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…
classNamestring

Customisation

Without editing the source, you can change:

Class names
className
Messages
ap.suppliersbase.infoHint

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.

useCanManageSuppliersuseMessagesuseSuppliers

Files

Written to your app by the install command:

  • components/dolfin/ap/suppliers-list-page.tsx 158 lines