API Reference / Angular InstantSearch Widgets / ais-configure
Aug. 23, 2019

ais-configure

You are reading the documentation for Angular InstantSearch v3, which is in beta. You can find the v2 documentation here.

Widget signature
<ais-configure
  // Optional parameters
  [searchParameters]="object"
></ais-configure>

About this widget

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

Any attribtes added to the searchParameters object is forwarded to Algolia. For more information on the different parameters that can be set, have a look at the reference.

Examples

1
2
3
<ais-configure
  [searchParameters]="{ hitsPerPage: 5, enablePersonalization: true }"
></ais-configure>

Props

searchParameters
type: object

List of search parameters to enable when this widget renders.

1
2
3
<ais-configure
  [searchParameters]="{ hitsPerPage: 5, distinct: true, enablePersonalization: true }"
></ais-configure>

HTML output

This widget has no HTML output.

Did you find this page helpful?