Skip to main content

Interface: OrderListProps

Defined in: components/OrderList.tsx:18

Properties​

channelIds?​

optional channelIds?: number[]

Defined in: components/OrderList.tsx:93

Filter orders by channel IDs

className?​

optional className?: string

Defined in: components/OrderList.tsx:72

Override base styles

columnConfig?​

optional columnConfig?: Record<string, string>

Defined in: components/OrderList.tsx:39

Label mapping for columns

columns?​

optional columns?: string[]

Defined in: components/OrderList.tsx:36

Columns to display. Defaults to ['id', 'date', 'status', 'total', 'action']

companyId?​

optional companyId?: number

Defined in: components/OrderList.tsx:66

Override company ID for order filtering (respects company switcher)

enableSearch?​

optional enableSearch?: boolean

Defined in: components/OrderList.tsx:42

Enable searching

flat?​

optional flat?: boolean

Defined in: components/OrderList.tsx:90

Drop the results container's card chrome (background/border/shadow). Defaults to false.

formatDate?​

optional formatDate?: (dateString) => string

Defined in: components/OrderList.tsx:99

Format date

Parameters​

dateString​

string

Returns​

string

formatPrice?​

optional formatPrice?: (price) => string

Defined in: components/OrderList.tsx:96

Format price

Parameters​

price​

number

Returns​

string

getStatusColor?​

optional getStatusColor?: (status) => string

Defined in: components/OrderList.tsx:102

Get status color

Parameters​

status​

string

Returns​

string

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/OrderList.tsx:30

The initialized GraphQL Client instance. Resolved from PropellerProvider when omitted.

hideHeader?​

optional hideHeader?: boolean

Defined in: components/OrderList.tsx:87

Hide the column header row. Defaults to false.

hidePagination?​

optional hidePagination?: boolean

Defined in: components/OrderList.tsx:84

Hide pagination controls. Defaults to false.

initialItemsPerPage?​

optional initialItemsPerPage?: number

Defined in: components/OrderList.tsx:75

Items per page default

initialSearchForm?​

optional initialSearchForm?: OrderSearchForm

Defined in: components/OrderList.tsx:52

Seed the filter form on mount — typically rehydrated from the URL query so a bookmarked/shared filtered view restores on reload. Pair with onSearchApply so the page can keep the URL in sync when filters change.

labels?​

optional labels?: object

Defined in: components/OrderList.tsx:113

Localization label overrides for UI strings.

action?​

optional action?: string

Header label for the action column.

date?​

optional date?: string

Header label for the date column.

loading?​

optional loading?: string

Loading-state message.

next?​

optional next?: string

Text for the next-page pagination button.

noOrders?​

optional noOrders?: string

Message shown when no orders match.

of?​

optional of?: string

Connector word in the pagination summary ("of").

order?​

optional order?: string

Header label for the order ID column.

previous?​

optional previous?: string

Text for the previous-page pagination button.

showingPage?​

optional showingPage?: string

Prefix text in the pagination summary ("Showing page").

status?​

optional status?: string

Header label for the status column.

total?​

optional total?: string

Header label for the total column.

view?​

optional view?: string

Text for the per-row "View" action button.

language?​

optional language?: string

Defined in: components/OrderList.tsx:24

Storefront language ('EN', 'NL', …). Decides the number format prices are rendered in — without it they fall back to Dutch separators regardless of the language the shopper is reading. Resolved from <PropellerProvider> when omitted.

onOrderClick​

onOrderClick: (orderId) => void

Defined in: components/OrderList.tsx:33

Callback when an order is clicked

Parameters​

orderId​

number

Returns​

void

onSearchApply?​

optional onSearchApply?: (form) => void

Defined in: components/OrderList.tsx:60

Fires when the user applies or clears filters (the "Search"/"Clear" buttons). Receives the active filter form. Use it to persist the filters to the URL — the component owns no router, so the page decides how (and whether) to reflect them in location.

Parameters​

form​

OrderSearchForm

Returns​

void

orderStatus?​

optional orderStatus?: string[]

Defined in: components/OrderList.tsx:69

Filter orders by these statuses

rowsClickable?​

optional rowsClickable?: boolean

Defined in: components/OrderList.tsx:78

Rows are clickable

searchFields?​

optional searchFields?: string[]

Defined in: components/OrderList.tsx:45

Fields enabled for searching (UI inputs)

showCompanyOrders?​

optional showCompanyOrders?: boolean

Defined in: components/OrderList.tsx:81

Show company orders

statusLabels?​

optional statusLabels?: Record&lt;string, string>

Defined in: components/OrderList.tsx:110

Localized display labels for order/quote statuses, keyed by the raw backend status value (e.g. &#123; NEW: 'Nieuw', CONFIRMED: 'Bevestigd', REQUEST: 'Aangevraagd' &#125;). Unknown statuses fall back to the raw value. Without this the list printed the raw enum (NEW/CONFIRMED/REQUEST) to the customer.

termFields?​

optional termFields?: any[]

Defined in: components/OrderList.tsx:63

Term fields configuration (backend)

user?​

optional user?: Contact | Customer | null

Defined in: components/OrderList.tsx:27

The authenticated user (Contact or Customer). Resolved from PropellerProvider when omitted.