Skip to main content

Interface: OrderListProps

Defined in: components/OrderList.tsx:17

Properties​

channelIds?​

optional channelIds?: number[]

Defined in: components/OrderList.tsx:64

Filter orders by channel IDs

className?​

optional className?: string

Defined in: components/OrderList.tsx:49

Override base styles

columnConfig?​

optional columnConfig?: Record<string, string>

Defined in: components/OrderList.tsx:31

Label mapping for columns

columns?​

optional columns?: string[]

Defined in: components/OrderList.tsx:28

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

companyId?​

optional companyId?: number

Defined in: components/OrderList.tsx:43

Override company ID for order filtering (respects company switcher)

enableSearch?​

optional enableSearch?: boolean

Defined in: components/OrderList.tsx:34

Enable searching

formatDate?​

optional formatDate?: (dateString) => string

Defined in: components/OrderList.tsx:70

Format date

Parameters​

dateString​

string

Returns​

string

formatPrice?​

optional formatPrice?: (price) => string

Defined in: components/OrderList.tsx:67

Format price

Parameters​

price​

number

Returns​

string

getStatusColor?​

optional getStatusColor?: (status) => string

Defined in: components/OrderList.tsx:73

Get status color

Parameters​

status​

string

Returns​

string

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/OrderList.tsx:22

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

hidePagination?​

optional hidePagination?: boolean

Defined in: components/OrderList.tsx:61

Hide pagination controls. Defaults to false.

initialItemsPerPage?​

optional initialItemsPerPage?: number

Defined in: components/OrderList.tsx:52

Items per page default

labels?​

optional labels?: object

Defined in: components/OrderList.tsx:76

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.

onOrderClick​

onOrderClick: (orderId) => void

Defined in: components/OrderList.tsx:25

Callback when an order is clicked

Parameters​

orderId​

number

Returns​

void

orderStatus?​

optional orderStatus?: string[]

Defined in: components/OrderList.tsx:46

Filter orders by these statuses

rowsClickable?​

optional rowsClickable?: boolean

Defined in: components/OrderList.tsx:55

Rows are clickable

searchFields?​

optional searchFields?: string[]

Defined in: components/OrderList.tsx:37

Fields enabled for searching (UI inputs)

showCompanyOrders?​

optional showCompanyOrders?: boolean

Defined in: components/OrderList.tsx:58

Show company orders

termFields?​

optional termFields?: any[]

Defined in: components/OrderList.tsx:40

Term fields configuration (backend)

user?​

optional user?: Contact | Customer | null

Defined in: components/OrderList.tsx:19

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