navigate() — astro Function Reference

Architecture documentation for the navigate() function in router.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1 called by 1

Entity Profile

CoreAstro→ RenderingEngine→ navigate() — astro Function Reference

Dependency Diagram

graph TD
  f381805f_958f_3bc5_bf46_7acaa731699b["navigate()"]
  2b5c33e2_176e_e839_f05f_7f10493f4f74["router.ts"]
  f381805f_958f_3bc5_bf46_7acaa731699b -->|defined in| 2b5c33e2_176e_e839_f05f_7f10493f4f74
  6b23b6bb_d4a4_83cb_3896_2e31c0316793["transition()"]
  6b23b6bb_d4a4_83cb_3896_2e31c0316793 -->|calls| f381805f_958f_3bc5_bf46_7acaa731699b
  6b23b6bb_d4a4_83cb_3896_2e31c0316793["transition()"]
  f381805f_958f_3bc5_bf46_7acaa731699b -->|calls| 6b23b6bb_d4a4_83cb_3896_2e31c0316793
  style f381805f_958f_3bc5_bf46_7acaa731699b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/transitions/router.ts lines 579–593

export async function navigate(href: string, options?: Options) {
	if (inBrowser === false) {
		if (!navigateOnServerWarned) {
			// instantiate an error for the stacktrace to show to user.
			const warning = new Error(
				'The view transitions client API was called during a server side render. This may be unintentional as the navigate() function is expected to be called in response to user interactions. Please make sure that your usage is correct.',
			);
			warning.name = 'Warning';
			console.warn(warning);
			navigateOnServerWarned = true;
		}
		return;
	}
	await transition('forward', originalLocation, new URL(href, location.href), options ?? {});
}