withRoutes
function
Configures server-side routing for the application.
API
function withRoutes(
routes: ServerRoute[],
): ServerRenderingFeature<ServerRenderingFeatureKind.ServerRoutes>;
withRoutes
ServerRenderingFeature<ServerRenderingFeatureKind.ServerRoutes>
Configures server-side routing for the application.
This function registers an array of ServerRoute
definitions, enabling server-side rendering
for specific URL paths. These routes are used to pre-render content on the server, improving
initial load performance and SEO.
@returns
ServerRenderingFeature<ServerRenderingFeatureKind.ServerRoutes>
Description
Configures server-side routing for the application.
This function registers an array of ServerRoute
definitions, enabling server-side rendering
for specific URL paths. These routes are used to pre-render content on the server, improving
initial load performance and SEO.
Usage Notes
import { provideServerRendering, withRoutes, ServerRoute, RenderMode } from '@angular/ssr';
const serverRoutes: ServerRoute[] = [
{
route: '', // This renders the "/" route on the client (CSR)
renderMode: RenderMode.Client,
},
{
route: 'about', // This page is static, so we prerender it (SSG)
renderMode: RenderMode.Prerender,
},
{
route: 'profile', // This page requires user-specific data, so we use SSR
renderMode: RenderMode.Server,
},
{
route: '**', // All other routes will be rendered on the server (SSR)
renderMode: RenderMode.Server,
},
];
provideServerRendering(withRoutes(serverRoutes));
Jump to details