```dts
function afterNavigate(
callback: (navigation: AfterNavigate) => void
): void;
```
## beforeNavigate
A navigation interceptor that triggers before we navigate to a URL, whether by clicking a link, calling `goto(...)`, or using the browser back/forward controls.
Calling `cancel()` will prevent the navigation from completing. If `navigation.type === 'leave'` — meaning the user is navigating away from the app (or closing the tab) — calling `cancel` will trigger the native browser unload confirmation dialog. In this case, the navigation may or may not be cancelled depending on the user's response.
When a navigation isn't to a SvelteKit-owned route (and therefore controlled by SvelteKit's client-side router), `navigation.to.route.id` will be `null`.
If the navigation will (if not cancelled) cause the document to unload — in other words `'leave'` navigations and `'link'` navigations where `navigation.to.route === null` — `navigation.willUnload` is `true`.
`beforeNavigate` must be called during a component initialization. It remains active as long as the component is mounted.
```dts
function beforeNavigate(
callback: (navigation: BeforeNavigate) => void
): void;
```
## disableScrollHandling
If called when the page is being updated following a navigation (in `onMount` or `afterNavigate` or an action, for example), this disables SvelteKit's built-in scroll handling.
This is generally discouraged, since it breaks user expectations.
```dts
function invalidate(
resource: string | URL | ((url: URL) => boolean),
keepState?: boolean
): Promise;
```
## invalidateAll
```dts
function onNavigate(
callback: (
navigation: OnNavigate
) => MaybePromise<(() => void) | void>
): void;
```
## preloadCode
Programmatically imports the code for routes that haven't yet been fetched.
Typically, you might call this to speed up subsequent navigation.
Takes a route ID such as `/about` or `/blog/[slug]`. Unlike pathnames, route IDs
are never prefixed with the app's [base path](/docs/kit/configuration#paths).
If you have a pathname rather than a route ID, you can convert it with
[`match`](/docs/kit/$app-paths#match) from `$app/paths`:
```js
// @errors: 7031
import { match } from '$app/paths';
import { preloadCode } from '$app/navigation';
const matched = await match('/blog/hello-world');
if (matched) await preloadCode(matched.id);
```
Unlike `preloadData`, this won't call `load` functions.
Returns a Promise that resolves when the modules have been imported.
` element with `data-sveltekit-preload-data`.
If the next navigation is to `href`, the values returned from load will be used, making navigation instantaneous.
Returns a Promise that resolves with the result of running the new route's `load` functions once the preload is complete.
```dts
function preloadData(href: string): Promise<
(
| {
type: 'loaded';
data: Record;
}
| {
type: 'redirect';
location: string;
}
| {
type: 'error';
error: App.Error;
}
) & {
status: number;
}
>;
```
## pushState
Use `goto(url, { state, shallow: true })` instead.
Programmatically create a new history entry with the given `page.state`. Used for [shallow routing](/docs/kit/shallow-routing).
```dts
function pushState(
url: string | URL,
state: App.PageState
): Promise;
```
## refreshAll
Causes all currently active remote functions to refresh, and all `load` functions belonging to the currently active page to re-run.
Returns a `Promise` that resolves when the page is subsequently updated.
```dts
function refreshAll(): Promise;
```
## replaceState
Use `goto(url, { state, shallow: true, replace: true })` instead.
Programmatically replace the current history entry with the given `page.state`. Used for [shallow routing](/docs/kit/shallow-routing).
```dts
function replaceState(
url: string | URL,
state: App.PageState
): Promise;
```
## snapshot
A lifecycle function that captures state before navigating and restores it when traversing history.
By default, the snapshot `id` is generated from the call site. Pass an explicit `id` to keep snapshots stable across deployments or distinguish multiple uses of a shared helper.
The optional `reset` callback runs on navigations where there is no captured value to restore, such as when a new history entry is created. Captured values are serialized with the app's transport hook.
`snapshot` must be called during a component initialization. It remains active as long as the component is mounted.
```dts
function snapshot(options: {
id?: string;
capture: () => T;
restore: (value: T) => void;
reset?: () => void;
}): void;
```
## AfterNavigate
The argument passed to [`afterNavigate`](/docs/kit/$app-navigation#afterNavigate) callbacks.
```dts
type AfterNavigate = (Navigation | NavigationEnter) & {
type: Exclude;
/**
* Since `afterNavigate` callbacks are called after a navigation completes, they will never be called with a navigation that unloads the page.
*/
willUnload: false;
};
```
## BeforeNavigate
The argument passed to [`beforeNavigate`](/docs/kit/$app-navigation#beforeNavigate) callbacks.
```dts
type BeforeNavigate = Navigation & {
/**
* Call this to prevent the navigation from starting.
*/
cancel: () => void;
};
```
## GotoOptions
```dts
interface GotoOptions {/*…*/}
```
```dts
replace?: boolean;
```
- default `false`
If `true`, replaces the current history entry rather than creating a new one.
```dts
replaceState?: boolean;
```
- deprecated Use `replace` instead.
```dts
shallow?: boolean;
```
- default `false`
If `true`, updates the URL and `page.state` without navigating.
```dts
reset?: boolean;
```
- default `true, or false when `shallow` is true`
If `true`, resets the scroll position (to the top of the page, or to the element
matching the URL's `#hash` if there is one) and resets focus (to the ``, or the
`autofocus` element if there is one) once the navigation completes.
If `false`, the current scroll position and focused element are left alone.
```dts
refreshAll?: boolean;
```
- default `false`
If `true`, reruns all `load` functions and queries of the page.
```dts
invalidate?: Array
boolean)>;
```
Causes any `load` functions to rerun if they depend on one of the URLs.
```dts
invalidateAll?: boolean;
```
- deprecated Use `refreshAll` instead.
```dts
state?: App.PageState;
```
An optional object that will be available as `page.state`.
```dts
persistState?: boolean;
```
- default `false`
If `true`, `page.state` will be restored after a full page reload.
```dts
type Navigation =
| NavigationExternal
| NavigationFormSubmit
| NavigationPopState
| NavigationLink;
```
## NavigationBase
```dts
interface NavigationBase {/*…*/}
```
```dts
type: NavigationType;
```
The type of navigation:
- `enter`: The app has hydrated/started
- `form`: The user submitted a `
```dts
shallow: boolean;
```
Whether this is a shallow navigation.
```dts
from: NavigationTarget | null;
```
Where navigation was triggered from
```dts
to: NavigationTarget | null;
```
Where navigation is going to/has gone to
```dts
willUnload: boolean;
```
Whether or not the navigation will result in the page being unloaded (i.e. not a client-side navigation).
```dts
complete: Promise
;
```
A promise that resolves once the navigation is complete, and rejects if the navigation
fails or is aborted. In the case of a `willUnload` navigation, the promise will never resolve
```dts
interface NavigationEnter extends NavigationBase {/*…*/}
```
```dts
type: 'enter';
```
```dts
delta?: undefined;
```
In case of a history back/forward navigation, the number of steps to go back/forward
```dts
event?: undefined;
```
Dispatched `Event` object when navigation occurred by `popstate` or `link`.
```dts
type NavigationExternal = NavigationGoto | NavigationLeave;
```
## NavigationFormSubmit
A navigation triggered by a `