queryRuleContext

About this widget

The queryRuleContext widget lets you apply ruleContexts based on filters to trigger contextual Query Rules.

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

Examples

1
2
3
4
5
6
instantsearch.widgets.queryRuleContext({
  trackedFilters: {
    genre: () => ['Comedy', 'Thriller'],
    rating: values => values,
  },
});

Customize the UI - connectQueryRules

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

This connector is also used to build other widgets: QueryRuleCustomData

It’s a 3-step process:

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

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

// 3. Instantiate
search.addWidget(
  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).

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

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

  // Render the widget
}

1
2
3
4
5
6
7
8
9
10
11
12
13
const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  const { widgetParams } = renderOptions;

  widgetParams.container.innerHTML = '...';
};

// ...

search.addWidget(
  customQueryRuleContext({
    container: document.querySelector('#queryRuleContext'),
  })
);

Create and instantiate the custom widget

We first create custom widgets from our rendering function, then we instantiate them. When doing that, there are two types of parameters you can give:

• Instance parameters: they are predefined parameters that you can use to configure the behavior of Algolia.
• Your own parameters: to make the custom widget generic.

Both instance and custom parameters are available in connector.widgetParams, inside the renderFunction.

const customQueryRuleContext = instantsearch.connectors.connectQueryRules(
  renderQueryRuleContext
);

search.addWidget(
  customQueryRuleContext({
    // Optional parameters
    trackedFilters: object,
    transformRuleContexts: function,
  })
);

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

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

Full example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Create the render function
const renderQueryRuleContext = (renderOptions, isFirstRender) => {
  // We don't provide anything to render for this widget.
};

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

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