Function UNSAFE_useScrollRestoration`Internal`

UNSAFE_useScrollRestoration(
    options?: {
        getKey?: GetScrollRestorationKeyFunction;
        storageKey?: string;
    },
): void
When rendered inside a RouterProvider, will restore scroll positions on navigations
Parameters
- options: { getKey?: GetScrollRestorationKeyFunction; storageKey?: string } = {}
  Options
  - OptionalgetKey?: GetScrollRestorationKeyFunction
    A function that returns a key to use for scroll restoration. This is useful for custom scroll restoration logic, such as using only the pathname so that subsequent navigations to prior paths will restore the scroll. Defaults to location.key.
  - OptionalstorageKey?: string
    The key to use for storing scroll positions in sessionStorage. Defaults to "react-router-scroll-positions".
Returns void
Name
UNSAFE_useScrollRestoration

Mode
framework

Mode
data
- Defined in packages/react-router/lib/dom/lib.tsx:2975