Skip to main content

Component example

Props

Props should be passed as attributes to the component element. Where a prop below defaults to a setting, leaving it off uses what you’ve set under Branding & Web Components, and setting it overrides that on this one product.
required
The slug or ID of the specific product to display.
The display mode for the product component.Options: mini, fullDefaults to mini
The text to display on the “add to cart” button.Defaults to the Add to Cart Button label (Add to Cart)
The text to display after the price if the product type is bundle.E.g £99/pack, where pack is the bundle-text.Defaults to the Bundle Text label (bundle)
The path to the cart page.Defaults to /cart
boolean
Whether to hide the “add to cart” button for the product. Written as one word, with no hyphens.Defaults to false
boolean
Whether to redirect to the cart page after adding the product to the cart.Defaults to the After Adding to Cart setting on the Product tab
boolean
Whether to show the quantity field for the product.Defaults to the Show Quantity Selector setting on the Product tab
boolean
Whether to show the name of the collection.Defaults to true
Whether to show a “show more” link.Defaults to false
The text to display on the “show more” link.Defaults to the “More” Link Text label (More)
The text to display on sale price badges.Defaults to the Sale Badge Text label (Sale)
The text to display on subscriber price badges.Defaults to the Subscriber Badge Text label (Subscribers)
The label text for subscriber pricing.Defaults to the Subscriber Price Label (for subscribers)
boolean
Whether to show subscriber pricing information.Defaults to the Show Subscriber Pricing setting on the Product tab
The text on the waitlist button for a sold-out event.Defaults to the Waitlist Button Text label (Join Waitlist)
Full view only. Where the gallery thumbnails sit: side or bottom.Defaults to the Thumbnail position setting on the Product tab
For an event, how upcoming dates are shown: list or calendar.Defaults to the Default view setting on the Product tab
number
For an event, how many upcoming dates the list shows.Defaults to the Upcoming dates to show setting on the Product tab
boolean
Full view only. Whether to show buttons for sharing the product.Defaults to false
Full view only. Columns in the related products grid on a phone. related-columns-tablet, related-columns-desktop and related-columns-large set the wider breakpoints.

Views

The product component supports two different view modes:

Mini View

The mini view displays the product in a compact format suitable for product grids or collections. It includes the product image, name, price, and add to cart functionality.

Full View

The full view displays the product in an expanded format suitable for dedicated product pages. It includes:
  • Image gallery with thumbnails
  • Detailed product information
  • Product options and variants
  • Full description
  • Product attributes
  • Awards and reviews
  • Related products

Styling

The following parts are available to style the product component:

Mini View Parts

The main container for mini view.
The not found state container for mini view.
The not found text for mini view.
The loading state container.
The colour of the placeholder items that is shown while the product is loading.
The main product container.
The containing div of the product image.
The product image.
The container for the low stock badge in mini view.
The low stock badge element in mini view.
The containing div of the product info.
The product name.
The product price container.
The price badge (sale/subscriber) element.
The sale price display.
The primary subscriber price (for logged-in subscribers).
The subscriber price information.
The crossed-out subscriber price.
The crossed-out regular price.
The crossed-out original price.
The upsell product selection container.
The upsell product select dropdown.
The optional heading above the upsell options.
The one-off or subscribe choice, on a product without upsells.
The frequency dropdown inside a chosen subscribe row.
The billing frequency picker, when it sits below the options rather than inside a row.
The heading above the billing frequency picker.
The billing frequency dropdown.
The “show more” link element.

Full View Parts

The main container for full view.
The not found state container for full view.
The not found title.
The not found message text.
The not found return link.
The main image container.
The main product image.
The container for the low stock badge in full view.
The low stock badge element in full view.
The image thumbnails container.
Individual thumbnail button.
Active thumbnail button state.
The column or row that holds the thumbnail strip.
The arrow at the start of the thumbnail strip, shown when it can scroll that way.
The arrow at the end of the thumbnail strip, shown when it can scroll that way.
The play badge on a video’s thumbnail.
The video player in the main image slot.
The video player in the full-screen overlay.
The product details section.
The product name heading.
The price section container.
The product price.
The price badge for full view.
The sale price for full view.
The primary subscriber price for full view.
The subscriber price for full view.
The crossed-out subscriber price for full view.
The crossed-out regular price for full view.
The crossed-out original price for full view.
The actions section (add to cart, options).
The upsell container for full view.
The upsell select dropdown for full view.
The optional heading above the upsell options in full view.
The one-off or subscribe choice in full view.
The billing frequency picker in full view.
The heading above the billing frequency picker in full view.
The billing frequency dropdown in full view.
The product options section.
A short text option’s text box.
A long text option’s text box.
The character count under a text option.
The additional product details section.
The container around the accordion sections.
One accordion section.
An accordion section’s header.
An accordion section’s content.
Individual attribute name.
Individual attribute value.
The awards section.

Features

Subscription Products

The product component automatically detects and handles subscription products, including pick-and-mix subscriptions. For subscription products, it integrates with the subscription configuration component to provide frequency selection and item management.

Quick Attributes

When enabled in your web component settings, key product attributes (e.g. Size, Colour, Material) are displayed directly under the product name. You choose which attributes to show and their display order from Settings > Branding & Web Components > Product.

Purchase Options

Where a product has upsells, the page offers them either as a dropdown or as priced boxes showing every option’s price at once. Set which under Upsell Options, and add an optional heading above them with the Upsell Picker Heading label. The product’s own row is named with the Base Option Label, and where you show subscriber pricing, each row uses your Subscriber Price Label.

One-off or Subscribe

A product that a Fixed package sends can be bought once or subscribed to from its own page. Subscribing puts the package in the cart instead of the product, at the quantity chosen and on the frequency picked.
  • Without upsells, the page asks How would you like it? with a row for One-off purchase and one for Subscribe. Where more than one package sends the product, each row is named after its package.
  • With upsells, the subscribe rows join the upsell list, straight after the product’s own row, rather than a second chooser beneath it. The product’s own row is the one-off, and choosing to subscribe leaves any upsell, since the subscription is to this product.
Each subscribe row shows the package’s price with the one-off price struck through beside it, and a note saying how often it’s sent, the fewest that can be subscribed to, what it saves and whether delivery is free, for example “Monthly. Minimum 3. Save 10%”. Where the package is sold at more than one frequency, the note leaves out how often, and choosing the row opens the frequency inside it. With upsells shown as a dropdown, the frequency is asked below instead. The page opens on the one-off purchase unless you set Purchase Option Selected First to Subscribe on the Product tab. Every piece of wording here is on the Labels tab.

Billing Frequency

A subscription package sold at more than one billing frequency lets the shopper choose, as boxes or a dropdown. The frequency they pick is what the subscription is created on. The heading above the choice is set with the Frequency Picker Heading label.

Text Options

A product with a short or long text option, such as an engraving or a gift message, shows a text box with a character count. The add to cart button stays disabled until any required text is filled in. A mini view card has nowhere to type, so it links to the product page with the See Options Button wording instead of adding to the cart.

Quantity Limits

Where a product has a per-customer limit, its quantity stepper stops at the limit and says Max followed by the number per customer.

Gift Vouchers

A gift voucher at a fixed price adds straight to the cart. The amount chooser only opens when there’s an amount to pick or one to type.

Accordion Sections (Full View)

The full view product page uses configurable accordion sections. You can control which sections appear, their order, and whether they default to open or collapsed. Available sections include description, attributes, reviews, awards, press, related products, and custom text blocks. Configure these in your web component settings.

Pricing Display

The component displays pricing based on:
  • Sale prices vs regular prices
  • Subscriber pricing for logged-in subscribers
  • Bundle pricing with custom text
  • Price badges for sales and subscriber discounts
  • Multi-currency pricing based on the customer’s market
The full view includes a gallery with:
  • The main image, with arrows and dots to move through the gallery on a phone
  • A thumbnail strip down the side or along the bottom. It’s held to the size of the main image and scrolls when there are more than fit, with an arrow at each end when there’s more that way, keeping the current image’s thumbnail in view
  • Videos, which show as their poster with a play badge in the strip and play in the gallery’s player. A video only plays when the shopper chooses it, never because it’s first in the gallery. Set the player’s controls and colour on the Video tab, and see adding videos to a product
  • A full-screen overlay, if Enable image overlay is on
  • Fallback placeholder when no images are available

SEO Features (Full View)

The full view automatically injects:
  • Meta tags for social sharing
  • Structured data (JSON-LD) for search engines
  • A page title with the product’s name, keeping your site’s name at the end
  • Product availability and pricing information
The product component uses the add to cart component to handle cart functionality. If you have set styles for the add to cart component, they will be applied to the buttons within this component.