Skip to main content

Interface: ClusterCardProps

Defined in: components/ClusterCard.tsx:35

Properties​

badgesComponent?​

optional badgesComponent?: ComponentType<BadgesComponentProps>

Defined in: components/ClusterCard.tsx:164

children?​

optional children?: ReactNode

Defined in: components/ClusterCard.tsx:171

Compound mode opt-in. When provided, ClusterCard renders the compound subtree (using <ClusterCard.X> subcomponents) instead of the legacy monolithic layout. Default content per subcomponent matches the legacy render section-for-section.

className?​

optional className?: string

Defined in: components/ClusterCard.tsx:143

Extra CSS class applied to the root element.

cluster​

cluster: Cluster

Defined in: components/ClusterCard.tsx:39

The cluster object to display

columns?​

optional columns?: number

Defined in: components/ClusterCard.tsx:140

Number of grid columns — when 1 the card renders as a compact horizontal row.

configuration?​

optional configuration?: any

Defined in: components/ClusterCard.tsx:146

Configuration object passed to the component

currency?​

optional currency?: string

Defined in: components/ClusterCard.tsx:155

Currency symbol used when formatting the price. Falls back to PropellerInfra.currency, then '€'.

enableAddFavorite?​

optional enableAddFavorite?: boolean

Defined in: components/ClusterCard.tsx:113

Renders a heart-icon toggle button on the cluster image. Defaults to false.

favoriteComponent?​

optional favoriteComponent?: ComponentType<FavoriteComponentProps>

Defined in: components/ClusterCard.tsx:165

imageComponent?​

optional imageComponent?: ComponentType<ImageComponentProps>

Defined in: components/ClusterCard.tsx:163

imageLabels?​

optional imageLabels?: string[]

Defined in: components/ClusterCard.tsx:101

Attribute codes/names to look up on the default product and display as badge overlays on the image. Resolved against defaultProduct.attributes.items[].attributeDescription.name. Attributes with no matching value are silently omitted. Example: ['new', 'sale']

includeTax?​

optional includeTax?: boolean

Defined in: components/ClusterCard.tsx:149

Include tax in the price display

labels?​

optional labels?: Record<string, string>

Defined in: components/ClusterCard.tsx:137

Override any UI string. Available keys: addToFavorites, removeFromFavorites, viewCluster, inStock, lowStock, outOfStock

language?​

optional language?: string

Defined in: components/ClusterCard.tsx:152

Language code used to resolve localised names and slugs. Defaults to 'NL'.

onClusterClick?​

optional onClusterClick?: (cluster) => void

Defined in: components/ClusterCard.tsx:128

Called when the cluster name, image, or "View cluster" button is clicked. When provided, the default <a> navigation is prevented so the consumer can use framework-specific routing (e.g. Next.js router.push).

Parameters​

cluster​

Cluster

Returns​

void

onToggleFavorite?​

optional onToggleFavorite?: (cluster, isFavorite) => void

Defined in: components/ClusterCard.tsx:119

Called whenever the favourite state is toggled. The second argument indicates the new state: true = added, false = removed.

Parameters​

cluster​

Cluster

isFavorite​

boolean

Returns​

void

portalMode?​

optional portalMode?: string

Defined in: components/ClusterCard.tsx:71

Portal access mode. In 'semi-closed' price and stock are withheld from anonymous visitors. Resolved from PropellerProvider when omitted.

priceComponent?​

optional priceComponent?: ComponentType&lt;PriceComponentProps>

Defined in: components/ClusterCard.tsx:161

showAvailability?​

optional showAvailability?: boolean

Defined in: components/ClusterCard.tsx:84

Show only the availability indicator (Available / Not available) inside ItemStock. Only relevant when showStock is true. Defaults to true.

showImage?​

optional showImage?: boolean

Defined in: components/ClusterCard.tsx:50

Show the default product image. Defaults to true.

showManufacturer?​

optional showManufacturer?: boolean

Defined in: components/ClusterCard.tsx:62

Show the default product manufacturer. Defaults to false.

showName?​

optional showName?: boolean

Defined in: components/ClusterCard.tsx:44

Show the cluster name. Defaults to true.

showPrice?​

optional showPrice?: boolean

Defined in: components/ClusterCard.tsx:47

When false, hides the price. Defaults to true.

showShortDescription?​

optional showShortDescription?: boolean

Defined in: components/ClusterCard.tsx:53

Show the cluster short description. Defaults to false.

showSku?​

optional showSku?: boolean

Defined in: components/ClusterCard.tsx:59

Show the SKU. Displays the cluster SKU; falls back to the default product SKU if the cluster SKU is empty. Defaults to true.

showStock?​

optional showStock?: boolean

Defined in: components/ClusterCard.tsx:77

Show default product stock information (quantity badge). Reads defaultProduct.inventory.totalQuantity. Defaults to true.

stockComponent?​

optional stockComponent?: ComponentType&lt;StockComponentProps>

Defined in: components/ClusterCard.tsx:162

stockLabels?​

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

Defined in: components/ClusterCard.tsx:90

Label overrides forwarded to the embedded ItemStock component. Keys: inStock, outOfStock, lowStock, available, notAvailable, pieces

textLabels?​

optional textLabels?: string[]

Defined in: components/ClusterCard.tsx:108

Attribute codes/names to look up on the default product and display as extra text rows below the cluster name. Resolved the same way as imageLabels. Example: ['brand', 'color']

user?​

optional user?: Contact | Customer | null

Defined in: components/ClusterCard.tsx:65

Authenticated user. Resolved from PropellerProvider when omitted.