connectors connectConfigure

Description

The Configure connector provides the logic to build a custom widget that will give you ability to override or force some search parameters sent to Algolia API.

Usage

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

const makeConfigure= instantsearch.connectors.connectConfigure(
  function renderFn(
      renderOpts: ConfigureRenderingOptions,
      isFirstRendering: boolean) {
    // render the custom Configure widget
  }
);

const  customConfigure = makeConfigure(instanceOpts: CustomConfigureWidgetOptions);
search.addWidget(customConfigure);

Connector options

ConfigureRenderingOptions

• refine(searchParameters) => undefined

  Sets new searchParameters and trigger a search.

• widgetParamsObject

  All original CustomConfigureWidgetOptions forwarded to the renderFn.

CustomConfigureWidgetOptions

• searchParametersObject

  The Configure widget options are search parameters

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