Skip to main content

Interface: FavoriteListDetailsProps

Defined in: components/FavoriteListDetails.tsx:36

Properties​

addToCartLabels?​

optional addToCartLabels?: Record<string, string>

Defined in: components/FavoriteListDetails.tsx:154

Label overrides for AddToCart UI strings

afterAddToCart?​

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

Defined in: components/FavoriteListDetails.tsx:133

Called after every successful add-to-cart

Parameters​

cart​

Cart

item?​

CartMainItem

Returns​

void

allowAddToCart?​

optional allowAddToCart?: boolean

Defined in: components/FavoriteListDetails.tsx:102

Enable add to cart for products. Clusters show "View cluster" instead (default: true)

allowIncrDecr?​

optional allowIncrDecr?: boolean

Defined in: components/FavoriteListDetails.tsx:139

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

cartId?​

optional cartId?: string

Defined in: components/FavoriteListDetails.tsx:113

ID of an existing cart to add items to

className?​

optional className?: string

Defined in: components/FavoriteListDetails.tsx:76

Extra CSS class applied to the root element

companyId?​

optional companyId?: number

Defined in: components/FavoriteListDetails.tsx:47

Active company ID from the company switcher. Overrides the user's default company for price calculation. Triggers a re-fetch when changed.

configuration?​

optional configuration?: any

Defined in: components/FavoriteListDetails.tsx:79

Configuration object for URL generation

createCart?​

optional createCart?: boolean

Defined in: components/FavoriteListDetails.tsx:116

Auto-create cart if none exists

enableStockValidation?​

optional enableStockValidation?: boolean

Defined in: components/FavoriteListDetails.tsx:142

Validate stock before adding to cart (default: false)

favoriteListId​

favoriteListId: string

Defined in: components/FavoriteListDetails.tsx:50

The favorite list ID to display

favoriteListItemComponent?​

optional favoriteListItemComponent?: ComponentType<FavoriteListItemProps>

Defined in: components/FavoriteListDetails.tsx:166

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/FavoriteListDetails.tsx:38

GraphQL client for the Propeller SDK. Resolved from PropellerProvider when omitted.

gridPaginationComponent?​

optional gridPaginationComponent?: ComponentType<GridPaginationProps>

Defined in: components/FavoriteListDetails.tsx:168

includeTax?​

optional includeTax?: boolean

Defined in: components/FavoriteListDetails.tsx:162

Include tax in prices. Pass from PriceContext's usePrice()

itemLabels?​

optional itemLabels?: Record<string, string>

Defined in: components/FavoriteListDetails.tsx:160

Label overrides for FavoriteListItem UI strings

itemsPerPage?​

optional itemsPerPage?: number

Defined in: components/FavoriteListDetails.tsx:67

Number of items to show per page (default: 12)

labels?​

optional labels?: Record<string, string>

Defined in: components/FavoriteListDetails.tsx:82

UI string overrides

language?​

optional language?: string

Defined in: components/FavoriteListDetails.tsx:145

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

onAddToCart?​

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

Defined in: components/FavoriteListDetails.tsx:122

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/FavoriteListDetails.tsx:119

Called after a new cart is created internally by AddToCart

Parameters​

cart​

Cart

Returns​

void

onItemAdded?​

optional onItemAdded?: (item) => void

Defined in: components/FavoriteListDetails.tsx:64

Called after an item is added to the list from the in-list search modal. Use this to refresh the source the lists overview reads from (e.g. the user object), so the per-list count stays correct after navigating back.

Parameters​

item​

Product | Cluster

Returns​

void

onItemClick?​

optional onItemClick?: (item) => void

Defined in: components/FavoriteListDetails.tsx:108

Callback when an item title or image is clicked

Parameters​

item​

Product | Cluster

Returns​

void

onItemDelete?​

optional onItemDelete?: (itemId, itemType?) => void

Defined in: components/FavoriteListDetails.tsx:53

Action method for deleting a single favorite list item. If not provided, delete button is hidden

Parameters​

itemId​

string

itemType?​

string

Returns​

void

onItemsDelete?​

optional onItemsDelete?: (items) => void

Defined in: components/FavoriteListDetails.tsx:56

Batched delete callback for the floating bar "Remove" action. When provided, it is called once with all selected items; otherwise the component falls back to calling onItemDelete per item

Parameters​

items​

object[]

Returns​

void

onListLoaded?​

optional onListLoaded?: (list) => void

Defined in: components/FavoriteListDetails.tsx:59

Called after the favorite list is fetched, with the full list object

Parameters​

list​

FavoriteList

Returns​

void

onProceedToCheckout?​

optional onProceedToCheckout?: () => void

Defined in: components/FavoriteListDetails.tsx:148

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

Returns​

void

onRequestQuoteClick?​

optional onRequestQuoteClick?: (cart) => void

Defined in: components/FavoriteListDetails.tsx:151

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

Parameters​

cart​

Cart

Returns​

void

paginationVariant?​

optional paginationVariant?: string

Defined in: components/FavoriteListDetails.tsx:73

Pagination display variant: 'compact' or 'full' (default: 'compact')

showAvailability?​

optional showAvailability?: boolean

Defined in: components/FavoriteListDetails.tsx:93

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

showDelete?​

optional showDelete?: boolean

Defined in: components/FavoriteListDetails.tsx:105

Show delete button on each item (default: true)

showModal?​

optional showModal?: boolean

Defined in: components/FavoriteListDetails.tsx:136

Show modal after successful add (default: false)

showPagination?​

optional showPagination?: boolean

Defined in: components/FavoriteListDetails.tsx:70

Show pagination controls (default: true)

showSku?​

optional showSku?: boolean

Defined in: components/FavoriteListDetails.tsx:99

Display the SKU beneath item names (default: true)

showStock?​

optional showStock?: boolean

Defined in: components/FavoriteListDetails.tsx:96

Show numeric stock quantity inside ItemStock (default: true)

showStockComponent?​

optional showStockComponent?: boolean

Defined in: components/FavoriteListDetails.tsx:90

Show stock availability on items (default: false)

stockLabels?​

optional stockLabels?: Record<string, string>

Defined in: components/FavoriteListDetails.tsx:157

Label overrides for ItemStock UI strings

titleLinkable?​

optional titleLinkable?: boolean

Defined in: components/FavoriteListDetails.tsx:87

Should item titles link to the PDP (default: true)

user?​

optional user?: Contact | Customer

Defined in: components/FavoriteListDetails.tsx:41

The logged in user for which the favorite list is going to be displayed. Resolved from PropellerProvider when omitted.