queryRuleContext

Signature

queryRuleContext({
  trackedFilters: object,
  // Optional parameters
  transformRuleContexts?: function,
});

Import

import { queryRuleContext } from "instantsearch.js/es/widgets";

const { queryRuleContext } = instantsearch.widgets;
// or directly use instantsearch.widgets.queryRuleContext()

See this widget in action

Preview this widget and its behavior.

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

JavaScript

queryRuleContext({
  trackedFilters: {
    genre: () => ["Comedy", "Thriller"],
    rating: (values) => values,
  },
});

Options

trackedFilters

object

required

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 so that they only consist of alphanumeric characters, hyphens, and underscores.

JavaScript

queryRuleContext({
  trackedFilters: {
    genre: () => ["Comedy", "Thriller"], // this tracks two static genre values,
    rating: (values) => values, // this tracks all the rating values
  },
});

transformRuleContexts

function

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.

JavaScript

queryRuleContext({
  // ...
  transformRuleContexts(ruleContexts) {
    return ruleContexts.map((ruleContext) =>
      ruleContext.replace("ais-", "custom-"),
    );
  },
});

Customize the UI with `connectQueryRules`

If you want to create your own UI of the queryRuleContext widget, you can use connectors.

This connector is also used to build the queryRuleCustomData widget.

To use connectQueryRules, you can import it with the declaration relevant to how you installed InstantSearch.js.

import { connectQueryRules } from "instantsearch.js/es/connectors";

const { connectQueryRules } = instantsearch.connectors;
// or directly use instantsearch.connectors.connectQueryRules()

Then it’s a 3-step process:

JavaScript

// 1. Create a render function
const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  // Rendering logic
};

// 2. Create the custom widget
const customQueryRuleContext = connectQueryRules(renderQueryRuleContext);

// 3. Instantiate
search.addWidgets([
  customQueryRuleContext({
    // instance params
  }),
]);

Create a render function

This rendering function is called before the first search (init lifecycle step) and each time results come back from Algolia (render lifecycle step).

JavaScript

const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  const { widgetParams } = renderOptions;

  if (isFirstRender) {
    // Do some initial rendering and bind events
  }

  // Render the widget
};

Render options

All original widget options forwarded to the render function.

JavaScript

const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  const { widgetParams } = renderOptions;

  widgetParams.container.innerHTML = "...";
};

// ...

search.addWidgets([
  customQueryRuleContext({
    container: document.querySelector("#queryRuleContext"),
  }),
]);

First, create your custom widgets using a rendering function. Then, instantiate them with parameters. There are two kinds of parameters you can pass:

Instance parameters. Predefined options that configure Algolia’s behavior.
Custom parameters. Parameters you define to make the widget reusable and adaptable.

Inside the renderFunction, both instance and custom parameters are accessible through connector.widgetParams.

JavaScript

const customQueryRuleContext = connectQueryRules(renderQueryRuleContext);

search.addWidgets([
  customQueryRuleContext({
    // Optional parameters
    trackedFilters,
    transformRuleContexts,
  }),
]);

Instance options

trackedFilters

object

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 so that they only consist of alphanumeric characters, hyphens, and underscores.

JavaScript

customQueryRuleContext({
  trackedFilters: {
    genre: () => ["Comedy", "Thriller"], // this tracks two static genre values,
    rating: (values) => values, // this tracks all the rating values
  },
});

transformRuleContexts

function

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.

JavaScript

customQueryRuleContext({
  // ...
  transformRuleContexts(ruleContexts) {
    return ruleContexts.map((ruleContext) =>
      ruleContext.replace("ais-", "custom-"),
    );
  },
});

Full example

JavaScript

// Create the render function
const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  // We don't provide anything to render for this widget.
};

// Create the custom widget
const customQueryRuleContext = connectQueryRules(renderQueryRuleContext);

// Instantiate the custom widget
search.addWidgets([
  customQueryRuleContext({
    trackedFilters: {
      genre: () => ["Comedy", "Thriller"],
    },
  }),
]);

InstantSearch.js

queryRuleContext

Import

See this widget in action

About this widget

Examples

Options

Customize the UI with `connectQueryRules`

Create a render function

Render options

Create and instantiate the custom widget

Instance options

Full example

​Import

See this widget in action

​About this widget

​Examples

​Options

​Customize the UI with connectQueryRules

​Create a render function

​Render options

​Create and instantiate the custom widget

​Instance options

​Full example

Import

About this widget

Examples

Options

Customize the UI with `connectQueryRules`

Create a render function

Render options

Create and instantiate the custom widget

Instance options

Full example