| name | capri |
| description | Capri static site generator with island architecture. Use when creating components, pages, configuring hydration, fetching data, or working with this Capri project. Use when this capability is needed. |
| metadata | {"author":"capri-js"} |
Capri (Preact)
Capri is a static site generator with island architecture. Only components with .island.tsx suffix ship JavaScript to the browser. Everything else renders to static HTML with zero JS.
Coming from Next.js?
- No
getStaticProps - fetch data in main.server.tsx or use useFetch in components
- No
<Head> component - use CSS selector injection in the render function
- No API routes - this is pure static generation
getStaticPaths exists but lives in main.server.tsx
Coming from Astro?
- Islands use
.island.tsx file suffix instead of client:* directives
- Hydration timing via
export const options = { loading: "visible" }
- No frontmatter - use Preact components throughout
Project Structure
├── main.tsx # Client entry - hydrates islands
├── main.server.tsx # SSR entry - renders static HTML, exports getStaticPaths
├── router.tsx # File-based routing logic
├── pages/ # Page components (auto-discovered)
│ └── root.tsx # Home page (/)
├── components/
│ ├── islands/ # Interactive components (.island.tsx)
│ └── ui/ # Static components (no JS shipped)
├── index.html # HTML template
└── vite.config.ts # Capri plugin config
Islands (Interactive Components)
Any component with .island.tsx suffix becomes interactive:
import { useState } from "preact/hooks";
export default function Counter({ start = 0 }) {
const [count, setCount] = useState(start);
return <button onClick={() => setCount((c) => c + 1)}>{count}</button>;
}
Hydration Options
Control when islands hydrate by exporting an options object:
export const options = {
loading: "visible",
media: "(max-width: 768px)",
};
- eager: Hydrate immediately (default)
- idle: Hydrate when browser is idle (requestIdleCallback)
- visible: Hydrate when scrolled into view (IntersectionObserver)
- media: Only hydrate when media query matches (e.g., mobile-only islands)
Data Fetching
In entry files (for CMS/API data)
Fetch data at the top level of main.server.tsx:
const posts = await fetchPosts();
export async function getStaticPaths() {
return ["/", ...posts.map((p) => `/blog/${p.slug}`)];
}
In components (using Suspense pattern)
Preact uses the throw-promise pattern for Suspense:
const cache = new Map();
export function useFetch<T>(url: string): T {
if (!cache.has(url)) {
cache.set(
url,
fetch(url).then((r) => r.json()),
);
}
const result = cache.get(url);
if (result instanceof Promise) throw result;
return result;
}
Routing
File-based routing
Files in pages/ map to routes:
pages/root.tsx → /pages/about.tsx → /aboutpages/blog/post.tsx → /blog/post
Dynamic routes
Export getStaticPaths from main.server.tsx:
export async function getStaticPaths() {
const posts = await fetchAllPosts();
return ["/", "/about", ...posts.map((p) => `/blog/${p.slug}`)];
}
The router in router.tsx handles URL matching.
Head/Meta Management
Using preact-iso's prerender
import { prerender } from "preact-iso";
export async function render(url: string) {
const { html } = await prerender(<App path={url} />);
return { "#app": html };
}
CSS selector injection
Return an object with CSS selectors as keys:
export async function render(url: string) {
const { html } = await prerender(<App path={url} />);
return {
"#app": html,
title: getPageTitle(url),
"meta[name=description]": { content: getPageDescription(url) },
};
}
Common Tasks
| Task | How |
|---|
| Add a page | Create pages/name.tsx |
| Add an island | Create components/islands/name.island.tsx |
| Add static component | Create components/ui/name.tsx (no .island suffix) |
| Lazy-load island | Add export const options = { loading: "visible" } |
| Mobile-only island | Add export const options = { media: "(max-width: 768px)" } |
| Add dynamic routes | Export getStaticPaths() from main.server.tsx |
Commands
npm run dev
npm run build
npm run preview
Vite Config
import capri from "@capri-js/preact";
import preact from "@preact/preset-vite";
export default {
plugins: [
preact(),
capri({
prerender: ["/", "/about"],
followLinks: true,
spa: "/preview",
islandGlobPattern: "**/*.island.*",
sitemap: { origin: "https://example.com" },
}),
],
};
Key Files
main.server.tsx - SSR render function, getStaticPathsmain.tsx - Client hydration entryrouter.tsx - URL to component mappingvite.config.ts - Build configurationcomponents/async/use-fetch.ts - Data fetching utility
Source: capri-js/capri — distributed by TomeVault.
