UI libraries / Angular InstantSearch / Widgets

ais-configure

Angular InstantSearch isn’t compatible with Angular’s Ivy view engine. We’re investigating how best to support this. For more information and to vote for Algolia’s support of Angular 16 and beyond, see the GitHub issue Algolia Support for Angular InstantSearch

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.

See code examples

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

Parameter Description
searchParameters
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>

HTML output

This widget has no HTML output.

Did you find this page helpful?
Angular InstantSearch v4