feat(recommend): introduce trendingItems widget (#6171)

algolia · May 21, 2024 · fdbd8ce · fdbd8ce
1 parent fa165ab
commit fdbd8ce
Show file tree

Hide file tree

Showing 10 changed files with 837 additions and 2 deletions.
diff --git a/bundlesize.config.json b/bundlesize.config.json
@@ -10,11 +10,11 @@
     },
     {
       "path": "./packages/instantsearch.js/dist/instantsearch.production.min.js",
-      "maxSize": "80 kB"
+      "maxSize": "80.5 kB"
     },
     {
       "path": "./packages/instantsearch.js/dist/instantsearch.development.js",
-      "maxSize": "175.25 kB"
+      "maxSize": "175.75 kB"
     },
     {
       "path": "packages/react-instantsearch-core/dist/umd/ReactInstantSearchCore.min.js",

diff --git a/packages/instantsearch.js/src/__tests__/common-widgets.test.tsx b/packages/instantsearch.js/src/__tests__/common-widgets.test.tsx
@@ -27,6 +27,7 @@ import {
   numericMenu,
   relatedProducts,
   frequentlyBoughtTogether,
+  trendingItems,
 } from '../widgets';
 
 import type { TestOptionsMap, TestSetupsMap } from '@instantsearch/tests';
@@ -513,6 +514,27 @@ const testSetups: TestSetupsMap<TestSuites> = {
       })
       .start();
   },
+  createTrendingItemsWidgetTests({ instantSearchOptions, widgetParams }) {
+    const { facetName, facetValue, ...params } = widgetParams;
+    const facetParams =
+      facetName && facetValue ? { facetName, facetValue } : {};
+
+    instantsearch(instantSearchOptions)
+      .addWidgets([
+        trendingItems({
+          container: document.body.appendChild(document.createElement('div')),
+          ...facetParams,
+          ...params,
+        }),
+      ])
+      .on('error', () => {
+        /*
+         * prevent rethrowing InstantSearch errors, so tests can be asserted.
+         * IRL this isn't needed, as the error doesn't stop execution.
+         */
+      })
+      .start();
+  },
 };
 
 const testOptions: TestOptionsMap<TestSuites> = {
@@ -540,6 +562,7 @@ const testOptions: TestOptionsMap<TestSuites> = {
   createNumericMenuWidgetTests: undefined,
   createRelatedProductsWidgetTests: undefined,
   createFrequentlyBoughtTogetherTests: undefined,
+  createTrendingItemsWidgetTests: undefined,
 };
 
 describe('Common widget tests (InstantSearch.js)', () => {

diff --git a/packages/instantsearch.js/src/widgets/index.ts b/packages/instantsearch.js/src/widgets/index.ts
@@ -47,5 +47,6 @@ export { default as searchBox } from './search-box/search-box';
 export { default as sortBy } from './sort-by/sort-by';
 export { default as stats } from './stats/stats';
 export { default as toggleRefinement } from './toggle-refinement/toggle-refinement';
+export { default as trendingItems } from './trending-items/trending-items';
 export { default as voiceSearch } from './voice-search/voice-search';
 export { default as frequentlyBoughtTogether } from './frequently-bought-together/frequently-bought-together';