InstantSearch / Angular / V4 / API reference

Ais-Configure | Angular InstantSearch V4 (Deprecated)

Deprecated content
Angular InstantSearch is deprecated. Please use InstantSearch.js instead. For more information, see Migrating from Angular InstantSearch.

Signature

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

Import

Copy

1
2
3
4
5
6
7
8

import { NgAisConfigureModule } from 'angular-instantsearch';

@NgModule({
  imports: [
    NgAisConfigureModule,
  ],
})
export class AppModule {}

1. Follow additional steps in Optimize build size to ensure your code is correctly bundled.
2. This imports all the widgets, even the ones you don’t use. Read the Getting started guide for more information.

About this widget

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

Any attributes 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

Copy 
1
2
3

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

Props

searchParameters

Optional
Type: object

List of search parameters to enable when this widget renders.

Copy 
1
2
3

<ais-configure
  [searchParameters]="{ hitsPerPage: 5, distinct: true, enablePersonalization: true }"
></ais-configure>
Did you find this page helpful?