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.
Signature
<PoweredBy
  // Optional props
  theme={'light' | 'dark'}
  classNames={object}
  ...props={ComponentProps<'div'>}
/>

​
Import

JavaScript
import { PoweredBy } from "react-instantsearch";
View demo

​
About this widget

<PoweredBy> is a widget that lets you display the Algolia logo to redirect to the Algolia website. Algolia requires that you display a “Search by Algolia” logo with a link if you’re on a community plan (open source, not-for-profit, or DocSearch).
You can also create your own UI with usePoweredBy.

​
Examples

JavaScript
import React from "react";
import { liteClient as algoliasearch } from "algoliasearch/lite";
import { InstantSearch, PoweredBy } from "react-instantsearch";

const searchClient = algoliasearch("YourApplicationID", "YourSearchOnlyAPIKey");

function App() {
  return (
    <InstantSearch indexName="instant_search" searchClient={searchClient}>
      <PoweredBy />
    </InstantSearch>
  );
}

​
Props

​
theme
"light" | "dark"
default:"light"
The version of the logo to use, legible on light or dark backgrounds.
JavaScript
<PoweredBy theme="dark" />;
​
classNames
Partial<PoweredByClassNames>
The CSS classes you can override and pass to the widget’s elements. It’s useful to style widgets with class-based CSS frameworks like Bootstrap or Tailwind CSS.
  • root. The root element of the widget.
  • light. The root element of the widget with the light theme.
  • dark. The root element of the widget with the dark theme.
  • link. The link element.
  • logo. The SVG logo.
JavaScript
<PoweredBy
  classNames={{
    root: "MyCustomPoweredBy",
    link: "MyCustomPoweredByLink MyCustomPoweredByLink--subclass",
  }}
/>;
​
...props
React.ComponentProps<'div'>
Any <div> prop to forward to the root element of the widget.
JavaScript
<PoweredBy className="MyCustomPoweredBy" title="My custom title" />;

​
Hook

React InstantSearch let you create your own UI for the <PoweredBy> widget with usePoweredBy. Hooks provide APIs to access the widget state and interact with InstantSearch. The usePoweredBy Hook returns APIs.

​
Usage

First, create your React component:
JavaScript
function CustomPoweredBy() {
  const { url } = usePoweredBy();

  return <>{/* Your JSX */}</>;
}
Then, render the widget:
JavaScript
<CustomPoweredBy />

​
APIs

Hooks return APIs, such as state and functions. You can use them to build your UI and interact with React InstantSearch.
​
url
string
The URL to redirect to.

​
Example

JavaScript
import React from "react";
import { usePoweredBy } from "react-instantsearch";

function CustomPoweredBy() {
  const { url } = usePoweredBy();

  // Download the "Search by Algolia" logo for light and dark themes.
  // https://algolia.frontify.com/d/1AZwVNcFZiu7/style-guide#/basics/algolia-logo

  return <>{/* Your JSX */}</>;
}
⌘I