feat: add enabled prop

algolia · Dec 3, 2023 · 2716648 · 2716648
1 parent 0eb314a
commit 2716648
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 5 deletions.
diff --git a/packages/recommend-react/src/FrequentlyBoughtTogether.tsx b/packages/recommend-react/src/FrequentlyBoughtTogether.tsx
@@ -17,7 +17,7 @@ const UncontrolledFrequentlyBoughtTogether = createFrequentlyBoughtTogetherCompo
 
 export type UseFrequentlyBoughtTogetherProps<TObject> = OptionalRecommendClient<
   GetFrequentlyBoughtTogetherProps<TObject>
->;
+> & { enabled?: boolean };
 
 export type FrequentlyBoughtTogetherProps<
   TObject

diff --git a/packages/recommend-react/src/RelatedProducts.tsx b/packages/recommend-react/src/RelatedProducts.tsx
@@ -15,7 +15,7 @@ const UncontrolledRelatedProducts = createRelatedProductsComponent({
 
 export type UseRelatedProductsProps<TObject> = OptionalRecommendClient<
   GetRelatedProductsProps<TObject>
->;
+> & { enabled?: boolean };
 
 export type RelatedProductsProps<TObject> = UseRelatedProductsProps<TObject> &
   Omit<

diff --git a/packages/recommend-react/src/TrendingFacets.tsx b/packages/recommend-react/src/TrendingFacets.tsx
@@ -15,7 +15,7 @@ const UncontrolledTrendingFacets = createTrendingFacetsComponent({
 
 export type UseTrendingFacetsProps<TObject> = OptionalRecommendClient<
   GetTrendingFacetsProps<TObject>
->;
+> & { enabled?: boolean };
 
 export type TrendingFacetsProps<TObject> = UseTrendingFacetsProps<TObject> &
   Omit<

diff --git a/packages/recommend-react/src/TrendingItems.tsx b/packages/recommend-react/src/TrendingItems.tsx
@@ -15,7 +15,7 @@ const UncontrolledTrendingItems = createTrendingItemsComponent({
 
 export type UseTrendingItemsProps<TObject> = OptionalRecommendClient<
   GetTrendingItemsProps<TObject>
->;
+> & { enabled?: boolean };
 
 export type TrendingItemsProps<TObject> = UseTrendingItemsProps<TObject> &
   Omit<

diff --git a/packages/recommend-react/src/useFrequentlyBoughtTogether.ts b/packages/recommend-react/src/useFrequentlyBoughtTogether.ts
@@ -12,6 +12,7 @@ import { useStableValue } from './useStableValue';
 import { useStatus } from './useStatus';
 
 export function useFrequentlyBoughtTogether<TObject>({
+  enabled = true,
   indexName,
   maxRecommendations,
   objectIDs: userObjectIDs,
@@ -38,6 +39,10 @@ export function useFrequentlyBoughtTogether<TObject>({
   }, [userTransformItems]);
 
   useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+
     const param = {
       indexName,
       maxRecommendations,
@@ -90,6 +95,7 @@ export function useFrequentlyBoughtTogether<TObject>({
     });
     return () => {};
   }, [
+    enabled,
     indexName,
     maxRecommendations,
     objectIDs,

diff --git a/packages/recommend-react/src/useRecommendations.ts b/packages/recommend-react/src/useRecommendations.ts
@@ -9,9 +9,12 @@ import { useAlgoliaAgent } from './useAlgoliaAgent';
 import { useStableValue } from './useStableValue';
 import { useStatus } from './useStatus';
 
-export type UseRecommendationsProps<TObject> = GetRecommendationsProps<TObject>;
+export type UseRecommendationsProps<
+  TObject
+> = GetRecommendationsProps<TObject> & { enabled?: boolean };
 
 export function useRecommendations<TObject>({
+  enabled = true,
   fallbackParameters: userFallbackParameters,
   indexName,
   maxRecommendations,
@@ -38,6 +41,10 @@ export function useRecommendations<TObject>({
   }, [userTransformItems]);
 
   useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+
     setStatus('loading');
     getRecommendations({
       fallbackParameters,
@@ -54,6 +61,7 @@ export function useRecommendations<TObject>({
       setStatus('idle');
     });
   }, [
+    enabled,
     fallbackParameters,
     indexName,
     maxRecommendations,

diff --git a/packages/recommend-react/src/useRelatedProducts.ts b/packages/recommend-react/src/useRelatedProducts.ts
@@ -12,6 +12,7 @@ import { useStableValue } from './useStableValue';
 import { useStatus } from './useStatus';
 
 export function useRelatedProducts<TObject>({
+  enabled = true,
   fallbackParameters: userFallbackParameters,
   indexName,
   maxRecommendations,
@@ -40,6 +41,10 @@ export function useRelatedProducts<TObject>({
   }, [userTransformItems]);
 
   useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+
     const param = {
       fallbackParameters,
       indexName,
@@ -95,6 +100,7 @@ export function useRelatedProducts<TObject>({
     return () => {};
   }, [
     client,
+    enabled,
     fallbackParameters,
     hasProvider,
     indexName,

diff --git a/packages/recommend-react/src/useTrendingFacets.ts b/packages/recommend-react/src/useTrendingFacets.ts
@@ -12,6 +12,7 @@ import { useAlgoliaAgent } from './useAlgoliaAgent';
 import { useStatus } from './useStatus';
 
 export function useTrendingFacets<TObject>({
+  enabled = true,
   indexName,
   maxRecommendations,
   recommendClient,
@@ -35,6 +36,10 @@ export function useTrendingFacets<TObject>({
   }, [userTransformItems]);
 
   useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+
     const param = {
       model: 'trending-facets' as TrendingModel,
       indexName,
@@ -79,6 +84,7 @@ export function useTrendingFacets<TObject>({
     });
     return () => {};
   }, [
+    enabled,
     indexName,
     maxRecommendations,
     client,

diff --git a/packages/recommend-react/src/useTrendingItems.ts b/packages/recommend-react/src/useTrendingItems.ts
@@ -12,6 +12,7 @@ import { useStableValue } from './useStableValue';
 import { useStatus } from './useStatus';
 
 export function useTrendingItems<TObject>({
+  enabled = true,
   fallbackParameters: userFallbackParameters,
   indexName,
   maxRecommendations,
@@ -40,6 +41,10 @@ export function useTrendingItems<TObject>({
   }, [userTransformItems]);
 
   useEffect(() => {
+    if (!enabled) {
+      return;
+    }
+
     const param: BatchQuery<TObject> = {
       model: 'trending-items',
       fallbackParameters,
@@ -86,6 +91,7 @@ export function useTrendingItems<TObject>({
     });
     return () => {};
   }, [
+    enabled,
     fallbackParameters,
     indexName,
     maxRecommendations,