React UI Reference

This is the unique merchant identifier given by Depict.

This specifies the market identifier.

Locale object imported from @depict-ai/react-ui/locales. Determines

1. The translations for the UI
2. The locale to request from backend
3. The currency formatting used on the frontend

You have to check demo.depict.ai to see which locales the Depict backend accepts for your specific merchant. The different objects exported from @depict-ai/js-ui/locales have a backend_locale_ property equivalent to their name, so either import the locale with the correct name (recommended) or just set the backend_locale_ property to the correct value.

You can modify or create your own locale object as long as it’s the same format as the ones in @depict-ai/js-ui/locales.

Configuration object lets you customize your website’s search parameters.

This function will be used internally by our components to navigate between Depict Search UI pages.This prop is required in all applications that don’t use Next.JS

Optionally you can override the default session id used for personalization here. This is the ID that will be used to tie together the different tracking events for a user.

A <string, string> map of custom metadata to include in API requests to Depict

DisplayTransformers are functions that take in a list of categories, content search results or products and then can transform or enrich the data for each category, content search result or product card in a batched way. See Creating page URLs and enriching product data.

The unique identifier for the current listing page that will be sent to depict to get the products to display. type can be "listingId" or "externalId"..

• If id is "listingId", it should be a uuid where Depict is the source of truth, you can get them here: https://api.depict.ai/docs#tag/Listing/operation/Get_Listings_v3_listings_get.
• If id is "externalId", it should be the id of the product listing in your system - whatever was passed to Depict during data ingestion.

Accepts one of two “plugins” that determines the layout of your category page. The default value—CategoryTitle—displays the current category title above the product cards. Alternatively, you can opt not to show the category title above the product card by using the EmbeddedNumProducts function imported from the @depict-ai/react-ui SDK. This option is ideal for merchants who prefer to create their titles on the category page. If the latter, the SDK will attempt to position it between the sort and filter button on smaller screens to save space.

Your custom ProductCard component that receives and renders your category data

Used to customize breakpoints on category pages. Handles the number of product card columns displayed at each screen size. Example: [[2, 901], [3, 1024], [4]] means 2 columns at sizes up to 901px, 3 columns at sizes up to 1024px and after that 4 columns at any viewport size.

The spacing between products.

Handles whether or not to show the default breadcrumbs on the category page. If layout is set to "slider" or "slider-without-filters" this will be set to false by default

Handles whether or not to show the default quick links on the category page. If layout is set to "slider" or "slider-without-filters" this will be set to false by default

The layout used for listing the products.

1. "grid" is the default and shows the products in a grid
2. "slider" shows the products in a slider and has default false for showBreadcrumbs and showQuicklinks
3. "slider-without-filters" is the same as "slider" but does also not render any sorting or filter buttons

When using multiple CategoryPage components on the same page, you need to set a unique stateKey for each one, otherwise leave this unset. We recommend using an incrementing number, such as “1”, “2”, “3”, etc. To associate a certain BreadCrumbs or QuickLinks component with a certain CategoryPage component, set the same stateKey on both.

A sparse array containing content blocks to show (or an empty slot or undefined if there’s no block at that index). See ReactContentBlock for how a content block looks like. The index is the row where the content block should be shown.

/**
 * The interface for a content block.
 * Please make sure that you don't have content blocks overlap as that will cause undefined behavior.
 * The height of the content block will be the height of the tallest item in a row, so if there are no products in a row the content block needs to "bring its own height".
 * If you need to load any data in the content block, please make sure to return a placeholder while you're doing so (see `ImagePlaceholder`), to avoid layout shifts and ensure scroll restoration works correctly.
 *
 * - `spanColumns`: How many columns the block should span. This will be capped to the number of columns available.
 * - `spanRows`: How many rows the block should span.
 * - `position`: Where the block should be positioned. Can be `left`, `center` or `right`.
 * - `content`: The content to render in the block - please provide a React component.
 */
export type ReactContentBlock = {
  spanColumns: number;
  spanRows: number;
  position: "left" | "center" | "right";
  content: React.FC;
};

When using multiple CategoryPage components on the same page, you need to set a unique stateKey for each one, otherwise leave this unset. We recommend using an incrementing number, such as “1”, “2”, “3”, etc. To associate a certain BreadCrumbs or QuickLinks component with a certain CategoryPage component, set the same stateKey on both.

When using multiple CategoryPage components on the same page, you need to set a unique stateKey for each one, otherwise leave this unset. We recommend using an incrementing number, such as “1”, “2”, “3”, etc. To associate a certain BreadCrumbs or QuickLinks component with a certain CategoryPage component, set the same stateKey on both.