Product Popularity Plugin

Storefront plugin config for exposing popularity values on product and search data.

Disclaimer: This module depends on compatible plugin behavior being active in the consumer's Vendure backend instance. Configure the backend first, then register this plugin config in the storefront.

Purpose

Use this module when ranking, filtering, or displaying products based on popularity signals.

Features

• Extends product/search query payloads with popularity
• Exposes VendureProductPopularityPlugin for DataProvider pluginConfigs
• Provides ProductPopularityFeatures feature contract

Installation

npm

npm install @haus-storefront-react/vendure-plugin-configs

Yarn

yarn add @haus-storefront-react/vendure-plugin-configs

Note: This is not a public package. Contact the Haus Tech Team for access.

API Reference

Exports

• VendureProductPopularityPlugin
• ProductPopularityFeatures type

Basic Usage

Example 1: Register Plugin in Data Provider

Use this to configure and register the product-popularity plugin in your provider pluginConfigs.

React

import { VendureProductPopularityPlugin } from '@haus-storefront-react/vendure-plugin-configs/product-popularity'

const popularityPlugin = VendureProductPopularityPlugin.init({
  enableFeatures: {
    sortByPopularity: true,
  },
})

React Native

import { Text } from 'react-native'
import { VendureProductPopularityPlugin } from '@haus-storefront-react/vendure-plugin-configs/product-popularity'

const popularityPlugin = VendureProductPopularityPlugin.init({
  enableFeatures: {
    sortByPopularity: true,
  },
})

Example 2: Consume Plugin Functionality

Use this in product listing/detail UI after the plugin has been registered.

React

export function PopularityValue({ product }) {
  return <span>{product.popularity}</span>
}

React Native

import { Text } from 'react-native'

export function PopularityValue({ product }) {
  return <Text>{product.popularity}</Text>
}

---

Made with ❤️ by Haus Tech Team