API Reference / React InstantSearch / ScrollTo

Sep. 12, 2022

ScrollTo

Signature

<ScrollTo
  // Optional parameters
  scrollOn={string}
/>

Import

Copy

1
import { ScrollTo } from 'react-instantsearch-dom';

See code examples

See live example

About this widget

We released React InstantSearch Hooks, a new InstantSearch library for React. We recommend using React InstantSearch Hooks in new projects or upgrading from React InstantSearch.

The ScrollTo widget makes the page scroll to the component wrapped by it when the searchState is updated. By default when the page number changes, the scroll goes to the wrapped component.

Examples

Copy
import { ScrollTo, Hits } from 'react-instantsearch-dom';

<ScrollTo>
  <Hits />
</ScrollTo>

Props


            scrollOn

type: string

default: page

Optional

The widget state key to listen for changes. See the list of available keys by reading how the searchState is structured.

Copy
<ScrollTo scrollOn="query">
  <Hits/>
</ScrollTo>

Customize the UI with connectScrollTo

If you want to create your own UI of the ScrollTo widget or use another UI library, you can use connectors.

Connectors are higher-order components. They encapsulate the logic for a specific kind of widget and they provide a way to interact with the InstantSearch context.

They have an outer component API that we call exposed props, and they provide some other props to the wrapped components which are called the provided props.

It’s a 3-step process:

// 1. Create a React component
class ScrollTo extends Component {
  render() {
    // return the DOM output
  }
}

// 2. Connect the component using the connector
const CustomScrollTo = connectScrollTo(ScrollTo);

// 3. Use your connected widget
<CustomScrollTo />

See code examples

Create a React component

class ScrollTo extends Component {
  render() {
    const {
      any value,
      boolean hasNotChanged,
    } = this.props;

    // return the DOM output
  }
}

Provided Props


            value

type: any

The current refinement applied to the widget that is listened to.

Copy
class ScrollTo extends Component {
  componentDidUpdate(prevProps) {
    const { value, hasNotChanged } = this.props;

    if (value !== prevProps.value && hasNotChanged) {
      this.el.scrollIntoView();
    }
  }

  render() {
    return (
      <div ref={ref => (this.el = ref)}>
        {this.props.children}
      </div>
    );
  }
}


            hasNotChanged

type: boolean

Whether the refinement came from the scrollOn parameter (for instance, page by default).

Copy
class ScrollTo extends Component {
  componentDidUpdate(prevProps) {
    const { value, hasNotChanged } = this.props;

    if (value !== prevProps.value && hasNotChanged) {
      this.el.scrollIntoView();
    }
  }

  render() {
    return (
      <div ref={ref => (this.el = ref)}>
        {this.props.children}
      </div>
    );
  }
}

const CustomScrollTo = connectScrollTo(ScrollTo);

<CustomScrollTo
  // Optional params
  scrollOn={string}
/>

Exposed Props


            scrollOn