Skip to main content

Interface: CartOverviewProps

Defined in: components/CartOverview.tsx:16

Properties​

cart​

cart: Cart

Defined in: components/CartOverview.tsx:21

Shopping cart object from which the cart overview will be displayed

companyId?​

optional companyId?: number

Defined in: components/CartOverview.tsx:64

Active company ID — used for the purchase-authorization check. Resolved from PropellerProvider when omitted.

countries?​

optional countries?: object[]

Defined in: components/CartOverview.tsx:55

Optional list of countries used to resolve ISO codes (e.g. 'NL') to display names (e.g. 'Netherlands') in the address blocks. When omitted, the shared built-in COUNTRIES list is used as a fallback.

code​

code: string

name​

name: string

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/CartOverview.tsx:18

GraphQL client for the Propeller SDK. Optional — currently unused internally; kept for API/Vue parity.

labels?​

optional labels?: Record<string, string>

Defined in: components/CartOverview.tsx:30

Labels for the cart overview form fields and buttons

onPurchaseButtonClick?​

optional onPurchaseButtonClick?: (cart, reference, notes) => void

Defined in: components/CartOverview.tsx:48

Action when the purchase button is clicked. Receives cart, reference, and notes

Parameters​

cart​

Cart

reference​

string

notes​

string

Returns​

void

onTermsAndConditionsClick?​

optional onTermsAndConditionsClick?: () => void

Defined in: components/CartOverview.tsx:42

Action when the "Terms and conditions" link is clicked

Returns​

void

overviewContainerClass?​

optional overviewContainerClass?: string

Defined in: components/CartOverview.tsx:24

The CSS class for the cart overview container

paymethodLabels?​

optional paymethodLabels?: Record<string, string>

Defined in: components/CartOverview.tsx:58

Maps a lowercased payment-method code to its display name. Falls back to the raw value.

showNotes?​

optional showNotes?: boolean

Defined in: components/CartOverview.tsx:33

Show the notes field for the cart

showPurchaseButton?​

optional showPurchaseButton?: boolean

Defined in: components/CartOverview.tsx:45

Show the "Purchase" button for placing an order

showReference?​

optional showReference?: boolean

Defined in: components/CartOverview.tsx:36

Show the reference field for the cart

showTermsAndConditions?​

optional showTermsAndConditions?: boolean

Defined in: components/CartOverview.tsx:39

Show the terms and conditions acceptance

title?​

optional title?: string

Defined in: components/CartOverview.tsx:27

Title of the cart overview

user?​

optional user?: Contact | Customer | null

Defined in: components/CartOverview.tsx:61

Logged-in user — used for the purchase-authorization check. Resolved from PropellerProvider when omitted.