Settings

List of built-in settings. (You can create your own settings.)

Basics

Page: The page's root component.
Layout: The page's layout component.
Wrapper: Component(s) that wrap the page's root component.
route: The page's route.
prerender: Whether to pre-render the page, and pre-rendering settings.
ssr: Enable/disable Server-Side Rendering (SSR).
stream: Enable/disable HTML Streaming and specify stream type.
server: Server integration settings.
client: Add client code.
redirects: Permanent redirections (HTTP status code 301).
keepScrollPosition: Whether the page scrolls to the top upon navigation.
prefetchStaticAssets: Link prefetching settings.
baseAssets: Base URL of server.
baseServer: Base URL of static assets.
headersResponse: Add HTTP headers to the HTTP response.
csp: Content Security Policy (CSP).
extends: Install Overview > Extensions.
react: Options passed to React functions such as createRoot() or hydrateRoot().

Settings that set <head> tags (aka document metadata):

Settings that alias Vite settings (see also API > CLI):

host: Make development/preview server available over LAN and public addresses.
port: Change port of development/preview server.
root: Set the project root directory.
mode: Set the mode to run in.
force: Disable Vite's cache.

Most users don't need to know about these settings.

meta: Create new hooks or settings, or modify existing ones.
passToClient: Determines what pageContext values are sent to the client-side.
clientRouting: Enable Client Routing.
hydrationCanBeAborted: Whether your UI framework allows the hydration to be aborted.
trailingSlash: Whether URLs should end with a trailing slash.
disableUrlNormalization: Disable automatic URL normalization.
reactStrictMode: Whether to use React's <StrictMode>.
clientHooks: Whether hooks are loaded on the client-side.
filesystemRoutingRoot: URL root for Filesystem Routing.
injectScriptsAt: Where scripts are injected in the HTML.