<QueryRulesCustomData>

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.

About this widget

This widget displays custom data from Rules.

The <QueryRulesCustomData> widget isn’t available in React InstantSearch, but you can make a custom version with useQueryRules().

See code examples

Examples

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { useQueryRules } from 'react-instantsearch';

export function QueryRulesCustomData(props) {
  const { items } = useQueryRules(props);

  return (
    <>
      {items.map(({ title, link, banner }) => (
        <section key={title}>
          <h2>{title}</h2>
          <a href={link}>
            <img src={banner} alt="" />
          </a>
        </section>
      ))}
    </>
  );
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { useQueryRules, useQueryRulesProps } from 'react-instantsearch';

export function QueryRulesCustomData(props: useQueryRulesProps) {
  const { items } = useQueryRules(props);

  return (
    <>
      {items.map(({ title, link, banner }) => (
        <section key={title}>
          <h2>{title}</h2>
          <a href={link}>
            <img src={banner} alt="" />
          </a>
        </section>
      ))}
    </>
  );
}

Did you find this page helpful?

<QueryRulesCustomData>

About this widget

Examples

On this page