> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# configure
> Adds search parameters to your requests.
```ts Signature theme={"system"}
configure(searchParameters: object);
```
## Import
```js Package manager theme={"system"}
import { configure } from "instantsearch.js/es/widgets";
```
```js CDN theme={"system"}
const { configure } = instantsearch.widgets;
// or directly use instantsearch.widgets.configure()
```
Preview this widget and its behavior.
## About this widget
The `configure` widget lets you provide raw search parameters to the Algolia API without rendering anything.
Any props you add to this widget is forwarded to Algolia.
For more information about the different parameters you can set,
see the [search parameters API reference](/doc/api-reference/search-api-parameters).
## Examples
```js JavaScript icon=code theme={"system"}
configure({
hitsPerPage: 8,
enablePersonalization: true,
});
```
## Options
A list of [search parameters](/doc/api-reference/search-api-parameters) to enable when the widget mounts.
```js JavaScript icon=code theme={"system"}
configure({
hitsPerPage: 8,
distinct: true,
clickAnalytics: true,
enablePersonalization: true,
});
```
## HTML output
This widget doesn't have any HTML output.
## Customize the UI with `connectConfigure`
If you want to create your own UI of the `configure` widget, you can use connectors.
To use `connectConfigure`, you can import it with the declaration relevant to how you installed InstantSearch.js.
```js Package manager theme={"system"}
import { connectConfigure } from "instantsearch.js/es/connectors";
```
```js CDN theme={"system"}
const { connectConfigure } = instantsearch.connectors;
// or directly use instantsearch.connectors.connectConfigure()
```
Then it's a 3-step process:
```js JavaScript icon=code theme={"system"}
// 1. Create a render function
const renderConfigure = (renderOptions, isFirstRender) => {
// Rendering logic
};
// 2. Create the custom widget
const customConfigure = connectConfigure(renderConfigure);
// 3. Instantiate
search.addWidgets([
customConfigure({
// instance params
}),
]);
```
### Create a render function
This rendering function is called before the first search (`init` lifecycle step)
and each time results come back from Algolia (`render` lifecycle step).
```js JavaScript icon=code theme={"system"}
const renderConfigure = (renderOptions, isFirstRender) => {
const { refine, widgetParams } = renderOptions;
if (isFirstRender) {
// Do some initial rendering and bind events
}
// Render the widget
};
```
#### Rendering options
Removes the provided `searchParameters` and applies the one provided to the function.
```js JavaScript icon=code theme={"system"}
const renderConfigure = (renderOptions, isFirstRender) => {
const { refine } = renderOptions;
if (isFirstRender) {
const button = document.createElement("button");
button.textContent = 'Sets "hitsPerPage" to 4';
button.addEventListener("click", () => {
refine({ hitsPerPage: 4 });
});
document.querySelector("#configure").appendChild(button);
}
};
```
All original widget options forwarded to the render function.
```js JavaScript icon=code theme={"system"}
const renderConfigure = (renderOptions, isFirstRender) => {
const { widgetParams } = renderOptions;
widgetParams.container.innerHTML = `
${JSON.stringify(widgetParams.searchParameters, null, 2)}
`;
};
// ...
search.addWidgets([
customConfigure({
container: document.querySelector("#configure"),
searchParameters: {
hitsPerPage: 8,
},
}),
]);
```
### Create and instantiate the custom widget
First, create your custom widgets using a rendering function.
Then, instantiate them with parameters.
There are two kinds of parameters you can pass:
* **Instance parameters**. Predefined options that configure Algolia's behavior.
* **Custom parameters**. Parameters you define to make the widget reusable and adaptable.
Inside the `renderFunction`, both instance and custom parameters are accessible through `connector.widgetParams`.
```js JavaScript icon=code theme={"system"}
const customConfigure = connectConfigure(renderConfigure);
search.addWidgets([customConfigure({ searchParameters: {} })]);
```
#### Instance options
A list of [search parameters](/doc/api-reference/search-api-parameters) to enable when this widget renders.
```js JavaScript icon=code theme={"system"}
customConfigure({
searchParameters: {
hitsPerPage: 8,
distinct: true,
clickAnalytics: true,
},
});
```
### Full example
```html HTML theme={"system"}
```
```js JavaScript theme={"system"}
// Create the render function
const renderConfigure = (renderOptions, isFirstRender) => {
const { refine, widgetParams } = renderOptions;
if (isFirstRender) {
const button = document.createElement("button");
const pre = document.createElement("pre");
button.addEventListener("click", () => {
refine({
hitsPerPage: widgetParams.searchParameters.hitsPerPage === 8 ? 4 : 8,
});
});
widgetParams.container.appendChild(button);
widgetParams.container.appendChild(pre);
}
widgetParams.container.querySelector("button").textContent =
`Sets "hitsPerPage" to ${
widgetParams.searchParameters.hitsPerPage === 8 ? 4 : 8
}`;
widgetParams.container.querySelector("pre").innerHTML = JSON.stringify(
widgetParams.searchParameters,
null,
2,
);
};
// Create the custom widget
const customConfigure = connectConfigure(renderConfigure, () => {});
// Instantiate the custom widget
search.addWidgets([
customConfigure({
container: document.querySelector("#configure"),
searchParameters: {
hitsPerPage: 8,
},
}),
]);
```