NavigateOptions

History options for navigation.

Compatibility

ReactAvailable in this renderer's browser integration.

React SSRAvailable to this renderer's SSR integration; browser event handlers run after hydration.

PreactAvailable in this renderer's browser integration.

Preact SSRAvailable to this renderer's SSR integration; browser event handlers run after hydration.

Import from @kasperrt/smolter/react @kasperrt/smolter/preact

Signature

interface NavigateOptions {
  state?: unknown;
  viewTransition?: boolean;
  replace?: boolean;
  /** Preserve scroll in integrations that manage scroll restoration. */
  preventScrollReset?: boolean;
}

Usage

History options for navigation. replace updates the current entry instead of pushing another one. It does not skip loading or bypass shouldRevalidate.

await router.navigate("/tasks?q=edit", { replace: true });

Fields

state

state?: unknown;

viewTransition

viewTransition?: boolean;

replace

replace?: boolean;

preventScrollReset

preventScrollReset?: boolean;

Preserve scroll in integrations that manage scroll restoration.

View implementation ↗

smolter_