UI Libraries / Recommend / TrendingItems

TrendingItems

A

The TrendingItems component lets you render Trending items.

The Trending Products and Trending Facets models are a beta product.

Installation# A

The Recommend React package is available on the npm registry.

Copy 
1
2
3

yarn add @algolia/recommend-react
# or
npm install @algolia/recommend-react

If you don’t want to use a package manager, you can use a standalone endpoint:

Copy 
1
2
3
4

<script src="https://cdn.jsdelivr.net/npm/@algolia/recommend-react"></script>
<script>
  const { FrequentlyBoughtTogether, RelatedProducts, TrendingItems, TrendingFacets } = window['@algolia/recommend-react'];
</script>

Usage# A

You can customize how to render each item by passing a custom component to the itemComponent prop.

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

import { TrendingItems } from '@algolia/recommend-react';
import recommend from '@algolia/recommend';

const recommendClient = recommend('AJ0P3S7DWQ', '90dfaaf5755e694f341fe68f6e41a6d4');
const indexName = 'YOUR_INDEX_NAME';

function TrendingItems({ item }) {
  return (
    <pre>
      <code>{JSON.stringify(item)}</code>
    </pre>
  );
}

function App() {
  // ...

  return (
    <TrendingItems
      recommendClient={recommendClient}
      indexName={indexName}
      itemComponent={TrendingItems}
    />
  );
}

You can access trending items for a facet by passing a facet to your component.

Copy 
1
2
3
4
5
6
7

    <TrendingItems
      recommendClient={recommendClient}
      indexName={indexName}
      itemComponent={TrendingItems}
      facetName={facetName}
      facetValue={facetValue}
    />

Parameters# A

itemComponent #
type: ({ item }) => JSX.Element
Required

The component to display each item.
headerComponent #
type: (props: ComponentProps) => JSX.Element

The function to render a header for your items.

The default implementation is:

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

function HeaderComponent(props) {
  return (
    if (!props.translations.title) {
      return null;
    }

    return (
      <h3 className={cx('auc-Recommend-title', props.classNames.title)}>
        {props.translations.title}
      </h3>
    );
  );
}
fallbackComponent #
type: () => JSX.Element

A fallback component to render when no recommendations are returned.
view #
type: ViewProps

The view component to render your items into. For example, you can use the horizontalSlider UI component.

The default implementation is:

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

function ListView(props) {
  return (
    <div className="auc-Recommend-container">
      <ol className="auc-Recommend-list">
        {props.items.map(item => (
          <li key={item.objectID} className="auc-Recommend-item">
            <props.itemComponent item={item} />
          </li>
        ))}
      </ol>
    </div>
  );
}
environment #
type: typeof window
default: window

The environment in which your application is running.

This is useful if you’re using Recommend in a different context than window.

This component also accepts all the props that useTrendingItems supports:

recommendClient #
type: RecommendClient
Required

The initialized Algolia recommend client.
indexName #
type: string
Required

The name of the target index.
maxRecommendations #
type: number

The number of recommendations to retrieve. Depending on the available recommendations and the other request parameters, the actual number of hits may be lower than that. If maxRecommendations isn’t provided or set to 0, all matching recommendations are returned, and no fallback request is performed.
threshold #
type: number
Required

Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
fallbackParameters #
type: Omit<SearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>

List of search parameters to send.

Additional filters to use as fallback when there aren’t enough recommendations.
queryParameters #
type: Omit<SearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>

List of search parameters to send.
transformItems #
type: (items: Array<RecordWithObjectID<TItem>>) => items

A function to transform the retrieved items before passing them to the component. It’s useful to add or remove items, change them, or reorder them.
facetName #
type: string
Optional

The facet attribute to get recommendations for. This parameter is used along with facetValue.
facetValue #
type: string
Optional

The value of the target facet.
facetName #
type: string
Optional

The facet attribute to get recommendations for. This parameter is used along with facetValue.
facetValue #
type: string
Optional

The value of the target facet.
Previous
RelatedProducts
Next
TrendingFacets
Did you find this page helpful?