widgets configure

Edit this page

Description

The configure widget is a headless widget that let you configure the settings of your search using the parameters described by the general Algolia documentation

This widget has no visible UI, so you should only use it for search parameters users shouldn’t expect to change.

Live example

You can find an example at the end of the page.

Usage

Usage
const search = instantsearch( /* parameters */ );

const widget = instantsearch.widgets.configure( searchParameters: SearchParameters, );
search.addWidget(widget);

Options

  • searchParametersSearchParameters

    The Configure widget options are search parameters

Example

search.addWidget(
  instantsearch.widgets.configure({
    analytics: true,
    ruleContexts: ['desktop', 'cool-users'],
    distinct: 3,
  })
);

Can't find what you are looking for? Open an issue, we'll get back to you.