API Reference / Angular InstantSearch Widgets / ais-query-rule-context
Aug. 23, 2019

ais-query-rule-context

You are reading the documentation for Angular InstantSearch v3, which is in beta. You can find the v2 documentation here.

Widget signature
<ais-query-rule-context
  [trackedFilters]="object"
  // Optional parameters
  [transformRuleContexts]="function"
></ais-query-rule-context>

About this widget

The ais-query-rule-context 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 (e.g., 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
<ais-query-rule-context
  [trackedFilters]="trackedFilters"
></ais-query-rule-context>

Properties

trackedFilters
type: 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} (e.g. 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
<ais-query-rule-context
  [trackedFilters]="trackedFilters"
></ais-query-rule-context>
transformRuleContexts
type: function
Optional

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
<ais-query-rule-context
  // ...
  [transformRuleContexts]="transformRuleContexts"
></ais-query-rule-context>

Did you find this page helpful?