Guide › Introduction

Pages and routes

Every .tscl file under src/pages is a route. The file's path is the URL.

FileURL
src/pages/index.tscl/
src/pages/about.tscl/about
src/pages/blog/index.tscl/blog
src/pages/users/[id].tscl/users/ada, /users/42, …

Dynamic routes

A segment in square brackets matches any one segment of the URL. Its value reaches the page as an input with the same name, always a string.

{{-- src/pages/users/[id].tscl --}}
@input id: string

<h1>User {{ id }}</h1>

A file without brackets wins over a dynamic one, so src/pages/users/new.tscl handles /users/new.

Listing the pages to build

A static build has to know which pages a dynamic route has. Export entries() from a .load.ts file next to the page; it returns one object per page, and may be async.

// src/pages/users/[id].load.ts
import { users } from '../../data/users.ts'

export function entries() {
  return users.map((user) => ({ id: user.slug }))
}

A dynamic route without entries() fails the build and names the file to add. Each value must be a non-empty string without /, and not . or .., so a page can never be written outside its folder. Other characters are fine: { id: 'grace hopper' } becomes /users/grace%20hopper.

Loading data

The same .load.ts file can export load(). It gets the route's params and the request, and what it returns becomes the page's inputs, next to the params.

// src/pages/users/[id].load.ts
import { findUser } from '../../data/users.ts'

export async function load({ params }) {
  return { user: await findUser(params.id) }
}

{{-- src/pages/users/[id].tscl --}}
@import type { User } from '../../data/users.ts'
@input user: User

<h1>{{ user.name }}</h1>

clarusjs explain shows which pages ran a loader.