API Reference / React InstantSearch Widgets / Configure
Apr. 11, 2019
Widget signature
<Configure
  {...object searchParameters}
/>

About this widget

The Configure widget lets you provide raw search parameters to the Algolia API.

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.

This widget can be used with react-dom and react-native. It doesn’t render anything on screen, it only apply the provided parameters to the search.

Examples

1
2
3
4
5
6
7
8
9
import { Configure } from 'react-instantsearch-dom';

<Configure
  filters="free_shipping:true"
  hitsPerPage={4}
  analytics={false}
  enablePersonalization={true}
  distinct
/>

Props

searchParameters
type: object

A list of search parameters to enable when the widget mounts.

1
2
3
4
5
6
7
<Configure
  filters="free_shipping:true"
  hitsPerPage={4}
  analytics={false}
  enablePersonalization={true}
  distinct
/>

HTML output

This widget has no HTML output.

Did you find this page helpful?