• Preparing search index...
  • The search index is not available
React Router API Reference
  • React Router API Reference
  • react-router
  • UNSAFE_useScrollRestoration

Function UNSAFE_useScrollRestoration

  • UNSAFE_useScrollRestoration(__namedParameters?): void
  • When rendered inside a RouterProvider, will restore scroll positions on navigations

    Parameters

    • __namedParameters: {
          getKey?: GetScrollRestorationKeyFunction;
          storageKey?: string;
      } = {}
      • OptionalgetKey?: GetScrollRestorationKeyFunction
      • OptionalstorageKey?: string

    Returns void

    • Defined in packages/react-router/lib/dom/lib.tsx:2001

Settings

Member Visibility
React Router API Reference
  • Loading...

Generated using TypeDoc