Pages Routing

Put UI components in pages/ to make them routes. A page's server loader returns data, and the component receives it as props. This pattern is inspired by Inertia.js and works with React, Vue, Svelte, and Solid.

Pages mode starts when a pages/ directory exists. It can live alongside routes/: use pages for UI and routes for APIs. Page components normally run on the server for the first render and in the browser for navigation and interaction.

You can also use your own client-side router and call Void's APIs with typed fetch. Pages mode is optional.

Setup

In an empty project, void init can set up Pages for you. Choose Vite+ or plain Vite, then React, Vue, Svelte, or Solid and a database or static starter. The generated app includes the matching Vite config and page files.

If you're adding Pages mode manually, install a framework adapter alongside void:

React

npm install @void/react

Vue

npm install @void/vue

Svelte

npm install @void/svelte

Solid

npm install @void/solid

Add both plugins to your Vite config:

React

import { voidReact } from '@void/react/plugin';
// vite.config.ts
import { defineConfig } from 'vite';
import { voidPlugin } from 'void';

export default defineConfig({
  plugins: [voidPlugin(), voidReact()],
});

Vue

import { voidVue } from '@void/vue/plugin';
// vite.config.ts
import { defineConfig } from 'vite';
import { voidPlugin } from 'void';

export default defineConfig({
  plugins: [voidPlugin(), voidVue()],
});

Svelte

import { voidSvelte } from '@void/svelte/plugin';
// vite.config.ts
import { defineConfig } from 'vite';
import { voidPlugin } from 'void';

export default defineConfig({
  plugins: [voidPlugin(), voidSvelte()],
});

Solid

import { voidSolid } from '@void/solid/plugin';
// vite.config.ts
import { defineConfig } from 'vite';
import { voidPlugin } from 'void';

export default defineConfig({
  plugins: [voidPlugin(), voidSolid()],
});

Each adapter includes its framework's Vite plugin. Pass framework plugin options via voidReact({ react: { ... } }), voidVue({ vue: { ... } }), voidSvelte({ svelte: { ... } }), or voidSolid({ solid: { ... } }) if needed.

Directory Structure

Pages can be flat files such as about.vue or directory-based routes such as about/index.vue. Both map to the same route:

• pages/
  • layout.tsxRoot layout (wraps all pages)
  • index.tsx→ /
  • index.server.tsServer-side loader & action for /
  • about.tsx→ /about
  • users/
    • layout.tsxNested layout for /users/*
    • [id].tsx→ /users/:id
    • [id].server.tsServer-side loader & action for /users/:id
  • blog/
    • hello.md→ /blog/hello (Markdown page)

Keep one file per route. Void reports an error when two page files resolve to the same path, such as about.vue and about/index.vue, or the same page in two route groups.

Each page can have a companion .server.ts, .server.tsx, .server.js, .server.jsx, .server.mts, or .server.mjs file that runs exclusively on the server. Use .server.tsx or .server.jsx when the companion contains JSX (see JSX handlers for the JSX runtime). A companion belongs to its matching page and does not create a separate route:

File	Role
pages/foo.tsx	Page component at /foo
pages/foo.server.tsx	Server companion for that page

A companion can export:

• A loader, which runs on GET and returns the data that becomes the page component's props
• Actions, which handle mutations from forms and programmatic calls. Export a single action or multiple named actions when a page has several mutations
• ssr = false to opt a route out of server-rendered component HTML while keeping server loaders and client-side routing

File-based routing rules are the same as server routing: [param] for dynamic segments, [...param] for catch-all, (group)/ for route groups, and a .dev or .prod suffix for environment-only pages.

Environment-only pages

Add a .dev or .prod suffix before the extension to include a page in only one environment. The suffix is not part of the URL:

pages/
  about.tsx       →  /about, always
  debug.dev.tsx   →  /debug, development only
  stats.prod.tsx  →  /stats, production only
  home.dev.tsx    →  /home in development
  home.prod.tsx   →  /home in production

.dev pages run only on the dev server; .prod pages run in builds, deployments, and production previews.

• A .dev page and a .prod page can share a URL. A plain page and a suffixed page for the same URL is an error wherever both run: home.tsx with home.dev.tsx fails on the dev server, and home.tsx with home.prod.tsx fails the build.
• The suffix goes before .island: chart.dev.island.tsx is a development-only island page. chart.island.dev.tsx is not an island page.
• A companion repeats the suffix: home.dev.server.ts belongs to home.dev.tsx.
• Suffixes apply to page files only. Layouts take no suffix.
• A resource used only by .dev pages and their companions is not provisioned for production.
• The dev server and builds generate types for their own environment. void prepare generates types for both.

How Navigation Works

The first request receives rendered HTML. Later navigations run the loader and update the page without reloading the document. Form submissions run an action, then refresh page props or redirect.

To opt a specific route out of server-rendered component HTML, export ssr = false from its companion .server.ts file:

// pages/dashboard.server.ts
import { defineHandler } from 'void';

export const ssr = false;

export const loader = defineHandler(async () => {
  return { title: 'Dashboard' };
});

The loader still runs on the first request, and its props are embedded in the HTML shell. The page component mounts in the browser instead of hydrating server-rendered markup.

Render and prerender flags combine like this:

Page exports	Behavior
ssr unset or true	Server-render component HTML on request.
ssr = false	Return a client-mounted shell on request.
ssr = false + prerender = true	Prerender a client-mounted shell with embedded loader data.
ssr = false + prerender = false	Return the client-mounted shell only on request; never prerender it.
Island page + ssr = false	Invalid. Island pages already use the island renderer.
output: "static" + prerender unset	Auto-prerender pages that have known paths, including client-only shells.

Use the Link component for SPA navigation between pages. It renders an <a> tag that intercepts clicks and navigates without a full page reload:

React

import { Link } from "@void/react";

<Link href="/users">Users</Link>
<Link href={`/users/${id}`}>View</Link>

Vue

<script setup lang="ts">
import { Link } from '@void/vue';
</script>

<template>
  <Link href="/users">Users</Link>
  <Link :href="`/users/${id}`">View</Link>
</template>

Svelte

<script>
  import { Link } from "@void/svelte";
</script>

<Link href="/users">Users</Link>
<Link href={`/users/${id}`}>View</Link>

Solid

import { Link } from "@void/solid";

<Link href="/users">Users</Link>
<Link href={`/users/${id}`}>View</Link>

Link also supports query data, history replacement, full-page navigation, and cancellation:

<Link href="/users" data={{ page: 2, tag: ['active', 'new'] }}>
  Filtered users
</Link>

<Link href="/users" replace>
  Users
</Link>

<Link href="/logout" reloadDocument>
  Sign out
</Link>

<Link
  href="/settings"
  onNavigate={(event) => {
    if (!confirm('Leave this page?')) {
      event.preventDefault();
    }
  }}
>
  Settings
</Link>

prefetch and reloadDocument work only with GET links. GET data becomes query parameters; use scalar values or arrays.

For programmatic navigation, use useRouter():

import { useRouter } from '@void/vue'; // or "@void/react", "@void/svelte", "@void/solid"

const router = useRouter();
router.visit('/users');
router.refresh(); // re-fetch current page props, keeping the same history entry
router.visit('/logout', { method: 'POST' }); // non-GET navigation

router.visit() updates the page in place for same-origin URLs. http(s) URLs on another origin get a full page load, and other schemes such as javascript: are rejected.

For dynamic route params, use useParams() from the same adapter package:

import { useParams } from '@void/react';

export default function PostPage() {
  const { id } = useParams<{ id: string }>();
  return <h1>Post {id}</h1>;
}

Scroll Restoration

Void manages scroll position for Pages automatically:

• Back/forward navigation and reloads restore the saved scroll position.
• New navigation scrolls to the top of the page.
• Hash links (/docs#api) scroll to the target element. Same-page hash links (#section) skip the server fetch entirely.

To keep the current scroll position, pass preserveScroll: true:

router.visit('/users', { preserveScroll: true });

Link also accepts preserveScroll:

React

<Link href="/users" preserveScroll>
  Users
</Link>

Vue

<Link href="/users" preserve-scroll>Users</Link>

Svelte

<Link href="/users" preserveScroll>Users</Link>

Solid

<Link href="/users" preserveScroll>
  Users
</Link>