Skip to main content
This is the React InstantSearch v7 documentation. If you’re upgrading from v6, see the upgrade guide. If you were using React InstantSearch Hooks, this v7 documentation appliesβ€”just check for necessary changes. To continue using v6, you can find the archived documentation.
You can display a loading indicator to inform users on a slow connection that their search is still in progress. Use InstantSearch’s status indicator to decide when to show a loading indicator. The status can be one of the following:
  • loading: The search is in progress.
  • stalled: The search is in progress, but the response is taking longer than expected.
  • error: The search failed.
  • idle: The search succeeded.
Best practice is to display a loading indicator only when status is stalled, not during a standard (fast) search. Tweak the timing of the stalled status by setting the stalledSearchDelay option. You can then use this condition to display a loading indicator:
React
function LoadingIndicator() {
  const { status } = useInstantSearch();

  if (status === "stalled") {
    return <p>Loading search results</p>;
  }
  return null;
}
If you want the loading indicator to display as soon as the search starts, use the loading status in combination with stalled:
React
function LoadingIndicator() {
  const { status } = useInstantSearch();

  if (status === "loading" || status === "stalled") {
    return <p>Loading search results</p>;
  }
  return null;
}
⌘I