API Reference / Vue InstantSearch / ais-query-rule-context

ais-query-rule-context

Signature 
<ais-query-rule-context
  :tracked-filters="object"
  // Optional parameters
  :transform-rule-contexts="function"
/>
See code examples
See live example

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 (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

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<template>
  <ais-query-rule-context :tracked-filters="trackedFilters" />
</template>

<script>
export default {
  data() {
    return {
      trackedFilters: {
        genre: () => ['Comedy', 'Thriller'],
        rating: values => values,
      },
    };
  },
};
</script>

Props

tracked-filters
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} (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. Non-matching characters are replaced with underscores.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<template>
  <ais-query-rule-context :tracked-filters="trackedFilters" />
</template>

<script>
export default {
  data() {
    return {
      trackedFilters: {
        genre: () => ['Comedy', 'Thriller'], // this tracks two static genre values
        rating: values => values, // this tracks all the rating values
      },
    };
  },
};
</script>
transform-rule-contexts
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.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<template>
  <ais-query-rule-context
    [...]
    :transform-rule-contexts="transformRuleContexts"
  />
</template>

<script>
export default {
  data() {
    return {
      transformRuleContexts: ruleContexts =>
        ruleContexts.map(ruleContext => ruleContext.replace('ais-', 'custom-')),
    };
  },
};
</script>
Did you find this page helpful?
Vue InstantSearch v4