middleware
This is the React InstantSearch v7 documentation. React InstantSearch v7 is the latest version of React InstantSearch and the stable version of React InstantSearch Hooks.
If you were using React InstantSearch v6, you can upgrade to v7.
If you were using React InstantSearch Hooks, you can still use the React InstantSearch v7 documentation, but you should check the upgrade guide for necessary changes.
If you want to keep using React InstantSearch v6, you can find the archived documentation.
function middleware({ instantSearchInstance }) { return { onStateChange({ uiState }) {}, subscribe() {}, unsubscribe() {} } }
About this widget
The middleware
function returns an object with onStateChange
, subscribe
, and unsubscribe
functions.
The middleware
function doesn’t perform any actions itself but allows you to inject functionality into InstantSearch.js:
- For example, you can send events to Google Analytics
- To send click and conversion events, use the
insights
middleware.
Requirements
InstantSearch.js v4.8.3 or later.
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
function middleware({ instantSearchInstance }) {
return {
onStateChange({ uiState }) {
// Do something with `uiState` every time the state changes.
},
subscribe() {
// Do something when the InstantSearch instance starts.
},
unsubscribe() {
// Do something when the InstantSearch instance is disposed of.
}
}
}
function Middleware() {
const { addMiddlewares } = useInstantSearch();
React.useLayoutEffect(() => {
return addMiddlewares(middleware);
}, [addMiddlewares]);
}
function App() {
return (
<InstantSearch
searchClient={searchClient}
indexName="instant_search"
>
<Middleware />
</InstantSearch>
);
}
Options
instantSearchInstance
|
type: object
Required
You have access to the instance of |
||
Copy
|
Hooks
onStateChange
|
type: ({ uiState }) => void
Required
The function is called with |
||
Copy
|
|||
subscribe
|
type: () => void
Required
This function is called when the InstantSearch instance starts (when |
||
Copy
|
|||
unsubscribe
|
type: () => void
Required
The function is called when the InstantSearch instance is disposed of. You can clean up anything you initiated in the |
||
Copy
|