Skip to main content

Interface: FavoriteListItemProps

Defined in: components/FavoriteListItem.tsx:27

Properties​

addToCartLabels?​

optional addToCartLabels?: Record<string, string>

Defined in: components/FavoriteListItem.tsx:123

Label overrides for AddToCart UI strings

afterAddToCart?​

optional afterAddToCart?: (cart, item?) => void

Defined in: components/FavoriteListItem.tsx:102

Called after every successful add-to-cart

Parameters​

cart​

Cart

item?​

CartMainItem

Returns​

void

allowAddToCart?​

optional allowAddToCart?: boolean

Defined in: components/FavoriteListItem.tsx:47

Enables the add to cart functionality for products. Clusters show a "View cluster" button instead (default: true)

allowIncrDecr?​

optional allowIncrDecr?: boolean

Defined in: components/FavoriteListItem.tsx:108

Renders increment/decrement buttons beside quantity input (default: true)

cartId?​

optional cartId?: string

Defined in: components/FavoriteListItem.tsx:82

ID of an existing cart to add items to

children?​

optional children?: ReactNode

Defined in: components/FavoriteListItem.tsx:129

Compound mode opt-in.

className?​

optional className?: string

Defined in: components/FavoriteListItem.tsx:59

Extra CSS class applied to the root element

configuration?​

optional configuration?: any

Defined in: components/FavoriteListItem.tsx:62

Configuration object for URL generation

createCart?​

optional createCart?: boolean

Defined in: components/FavoriteListItem.tsx:85

When true and no cartId is available, AddToCart automatically creates a cart

currency?​

optional currency?: string

Defined in: components/FavoriteListItem.tsx:71

Currency symbol for prices. Resolved from PropellerProvider when omitted; defaults to '€'.

enableStockValidation?​

optional enableStockValidation?: boolean

Defined in: components/FavoriteListItem.tsx:111

Validate stock before adding to cart (default: false)

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/FavoriteListItem.tsx:76

Initialised Propeller SDK GraphQL client (required by embedded AddToCart)

includeTax?​

optional includeTax?: boolean

Defined in: components/FavoriteListItem.tsx:68

Include tax in the price display. When provided, overrides the internal PriceToggle state

item​

item: Product | Cluster

Defined in: components/FavoriteListItem.tsx:29

Product or Cluster to be listed as a favorite list item

labels?​

optional labels?: Record<string, string>

Defined in: components/FavoriteListItem.tsx:65

UI string overrides

language?​

optional language?: string

Defined in: components/FavoriteListItem.tsx:114

Language code forwarded to CartService (default: 'NL')

onAddToCart?​

optional onAddToCart?: (product, clusterId?, quantity?, childItems?, notes?, price?, showModal?) => Cart

Defined in: components/FavoriteListItem.tsx:91

Fully replaces the internal CartService.addItemToCart call

Parameters​

product​

Product

clusterId?​

number

quantity?​

number

childItems?​

CartChildItemInput[]

notes?​

string

price?​

number

showModal?​

boolean

Returns​

Cart

onCartCreated?​

optional onCartCreated?: (cart) => void

Defined in: components/FavoriteListItem.tsx:88

Called after a new cart is created internally by AddToCart

Parameters​

cart​

Cart

Returns​

void

onDelete?​

optional onDelete?: (itemId) => void

Defined in: components/FavoriteListItem.tsx:53

Action callback fired when a favorite list item is deleted from the list

Parameters​

itemId​

string

Returns​

void

onItemClick?​

optional onItemClick?: (item) => void

Defined in: components/FavoriteListItem.tsx:56

Callback when the item title or image is clicked. Prevents default <a> navigation when provided

Parameters​

item​

Product | Cluster

Returns​

void

onProceedToCheckout?​

optional onProceedToCheckout?: () => void

Defined in: components/FavoriteListItem.tsx:117

Called when "Proceed to checkout" is clicked in AddToCart modal

Returns​

void

onRequestQuoteClick?​

optional onRequestQuoteClick?: (cart) => void

Defined in: components/FavoriteListItem.tsx:120

Called when "Request a Quote" is clicked in AddToCart modal

Parameters​

cart​

Cart

Returns​

void

showAvailability?​

optional showAvailability?: boolean

Defined in: components/FavoriteListItem.tsx:38

Show availability status (e.g. "In stock") inside ItemStock (default: true)

showDelete?​

optional showDelete?: boolean

Defined in: components/FavoriteListItem.tsx:50

Display a delete button that removes the favorite list item from the list (default: true)

showModal?​

optional showModal?: boolean

Defined in: components/FavoriteListItem.tsx:105

Show modal after successful add (default: false)

showSku?​

optional showSku?: boolean

Defined in: components/FavoriteListItem.tsx:44

Display the SKU of the item beneath the item name (default: true)

showStock?​

optional showStock?: boolean

Defined in: components/FavoriteListItem.tsx:41

Show numeric stock quantity inside ItemStock (default: true)

showStockComponent?​

optional showStockComponent?: boolean

Defined in: components/FavoriteListItem.tsx:35

Should the stock be displayed in the favorite list item (default: false)

stockLabels?​

optional stockLabels?: Record<string, string>

Defined in: components/FavoriteListItem.tsx:126

Label overrides for ItemStock UI strings

titleLinkable?​

optional titleLinkable?: boolean

Defined in: components/FavoriteListItem.tsx:32

Should the item title be a link to the PDP (default: true)

user?​

optional user?: Contact | Customer | null

Defined in: components/FavoriteListItem.tsx:79

Authenticated user — used for cart creation / lookup