API Reference / Vue InstantSearch Widgets / ais-configure

ais-configure

Widget signature 
<ais-configure
  // Optional parameters
  v-bind="object searchParameters"
/>
See code examples
See Live example

About this widget

The ais-configure widget lets you provide raw search parameters to the Algolia API without rendering anything.

Any props you add to this widget is forwarded to Algolia. For more information on the different parameters you can set, have a look at the search parameters API reference.

Examples

Copy 
1
2
3
4
5
6

<ais-configure
  :hits-per-page.camel="4"
  :distinct="true"
  :analytics="false"
  :enable-personalization.camel="true"
/>

Props

searchParameters
type: object

A list of search parameters to enable when the widget mounts. Note that the props have to use camel case since they’re directly forwarded to the Algolia API. In HTML or string templates, you can do this by adding .camel before the value of the prop.
Copy 
1
2
3
4
5

<ais-configure
  :hits-per-page.camel="4"
  :distinct="true"
  :enable-personalization.camel="true"
/>

Customize the UI

default

The slot to override the DOM output

Scope

  • searchParameters: object: the current search parameters applied to the search.
  • refine: (object) => void: the function to change the search parameters applied to the search.
Copy 
1
2
3
4
5
6
7
8
9
10
11
12

<ais-configure :enable-rules.camel="false" :hits-per-page.camel="5">
  <div slot-scope="{ searchParameters, refine }">
    <button
      @click="refine({
        ...searchParameters,
        enableRules: !searchParameters.enableRules,
      })"
    >Toggle only query rules</button>
    Currently applied filters:
    <pre>{{ searchParameters }}</pre>
  </div>
</ais-configure>

HTML output

This widget has no HTML output.

Did you find this page helpful?

Vue InstantSearch v3