QueryRuleContext | React InstantSearch V6 (Deprecated)

This version of React InstantSearch has been deprecated in favor of the latest version of React InstantSearch.

Signature

<QueryRuleContext
  trackedFilters={object}
  // Optional parameters
  transformRuleContexts={function}
/>

About this widget

The QueryRuleContext widget lets you apply ruleContexts based on filters to trigger context dependent Rules.

Rules offer a custom experience based on contexts. You might want to customize the users’ experience based on the filters of the search (for example, they’re visiting the “Mobile” category, they selected the “Thriller” genre, etc.) This widget lets you map these filters to their associated Rule contexts, so you can trigger context based Rules on refinement.

Examples

1
2
3
4
5
6
7
8
import { QueryRuleContext } from 'react-instantsearch-dom';

<QueryRuleContext
  trackedFilters={{
    genre: () => ['Comedy', 'Thriller'],
    rating: values => values,
  }}
/>

Props

trackedFilters

The filters to track to trigger Rule contexts.

Each filter is a function which name is the attribute you want to track. They receive their current refinements as arguments. You can either compute the filters you want to track based on those, or return static values. When the tracked values are refined, it toggles the associated Rule contexts.

The added Rule contexts follow the format ais-{attribute}-{value} (for example ais-genre-Thriller). If the context of your Rule follows another format, you can specify it using the transformRuleContexts option.

Values are escaped to only consist of alphanumeric characters, hyphens, and underscores.

1
2
3
4
5
6
<QueryRuleContext
  trackedFilters={{
    genre: () => ['Comedy', 'Thriller'], // this tracks two static genre values,
    rating: values => values, // this tracks all the rating values
  }}
/>

transformRuleContexts

A function to apply to the Rule contexts before sending them to Algolia. This is useful to rename Rule contexts that follow a different naming convention.

1
2
3
4
5
6
<QueryRuleContext
  // ...
  transformRuleContexts={ruleContexts =>
    ruleContexts.map(ruleContext => ruleContext.replace('ais-', 'custom-'))
  }
/>