poweredBy

Shows the Algolia logo with a link to the Algolia homepage.

Signature

poweredBy({
  container: string | HTMLElement,
  // Optional parameters
  theme?: string,
  cssClasses?: object,
});

Package manager

import { poweredBy } from "instantsearch.js/es/widgets";

const { poweredBy } = instantsearch.widgets;
// or directly use instantsearch.widgets.poweredBy()

See this widget in action

Preview this widget and its behavior.

About this widget

The poweredBy widget is used to display an Algolia logo and to redirect to Algolia’s homepage.

Algolia requires that you use this widget if you’re on a community plan (open source, not-for-profit, or DocSearch).

Examples

JavaScript

poweredBy({
  container: "#powered-by",
});

Options

container · string | HTMLElement · required

The CSS Selector or HTMLElement to insert the widget into.

string

poweredBy({
  container: "#powered-by",
});

poweredBy({
  container: document.querySelector("#powered-by"),
});

theme · 'light'|'dark' · default: "light"

The version of the logo to use, legible on light or dark backgrounds.

JavaScript

poweredBy({
  // ...
  theme: "dark",
});

cssClasses · object · default: "{}"

The CSS classes you can override:

• root. The root element of the widget.
• link. The link element.
• logo. The SVG element.

JavaScript

poweredBy({
  // ...
  cssClasses: {
    root: "MyCustomPoweredBy",
    link: ["MyCustomPoweredByLink", "MyCustomPoweredByLink--subclass"],
  },
});

HTML output

HTML

<div class="ais-PoweredBy ais-PoweredBy--light">
  <a
    href="..."
    target="_blank"
    class="ais-PoweredBy-link"
    aria-label="Search by Algolia"
    rel="noopener noreferrer"
  >
    <!-- <svg> ... </svg> -->
  </a>
</div>

Customize the UI with connectPoweredBy

If you want to create your own UI of the poweredBy widget, you can use connectors.

To use connectPoweredBy, you can import it with the declaration relevant to how you installed InstantSearch.js.

Package manager

import { connectPoweredBy } from "instantsearch.js/es/connectors";

const { connectPoweredBy } = instantsearch.connectors;
// or directly use instantsearch.connectors.connectPoweredBy()

Then it’s a 3-step process:

JavaScript

// 1. Create a render function
const renderPoweredBy = (renderOptions, isFirstRender) => {
  // Rendering logic
};

// 2. Create the custom widget
const customPoweredBy = connectPoweredBy(renderPoweredBy);

// 3. Instantiate
search.addWidgets([
  customPoweredBy({
    // 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).

JavaScript

const renderPoweredBy = (renderOptions, isFirstRender) => {
  const { url, widgetParams } = renderOptions;

  if (isFirstRender) {
    // Do some initial rendering and bind events
  }

  // Render the widget
};

Rendering options

url · string

The URL to redirect to.

JavaScript

const renderPoweredBy = (renderOptions, isFirstRender) => {
  const { url } = renderOptions;

  document.querySelector("#powered-by").innerHTML = `
    <a href="${url}">Powered by Algolia</a>
  `;
};

widgetParams · object

All original widget options forwarded to the render function.

JavaScript

const renderPoweredBy = (renderOptions, isFirstRender) => {
  const { widgetParams } = renderOptions;

  widgetParams.container.innerHTML = "...";
};

// ...

search.addWidgets([
  customPoweredBy({
    container: document.querySelector("#powered-by"),
  }),
]);

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.

JavaScript

const customPoweredBy = connectPoweredBy(renderPoweredBy);

search.addWidgets([
  customPoweredBy({
    url?: string,
  }),
]);

Instance options

url · string · default: "https://algolia.com"

The URL to redirect to.

JavaScript

customPoweredBy({
  url: "https://algolia.com/about",
});

Full example

HTML

<div id="powered-by"></div>

// Create the render function
const renderPoweredBy = (renderOptions, isFirstRender) => {
  const { url, widgetParams } = renderOptions;

  widgetParams.container.innerHTML = `
    <a href="${url}">Powered by Algolia</a>
  `;
};

// Create the custom widget
const customPoweredBy = connectPoweredBy(renderPoweredBy);

// Instantiate the custom widget
search.addWidgets([
  customPoweredBy({
    container: document.querySelector("#powered-by"),
  }),
]);