React Router API Reference
    Preparing search index...

    Function ScrollRestoration

    • Emulates the browser's scroll restoration on location changes. Apps should only render one of these, right before the Scripts component.

      import { ScrollRestoration } from "react-router";

      export default function Root() {
      return (
      <html>
      <body>
      <ScrollRestoration />
      <Scripts />
      </body>
      </html>
      );
      }

      This component renders an inline <script> to prevent scroll flashing. The nonce prop will be passed down to the script tag to allow CSP nonce usage.

      <ScrollRestoration nonce={cspNonce} />
      

      Parameters

      Returns null | Element

      A <script> tag that restores scroll positions on navigation.

      framework

      data

    Index

    Properties

    Properties

    displayName: string