solid-start

Solid Start（@tanstack/solid-start）

此技能基于 start-core。请先阅读 @tanstack/start-client-core#start-core，了解基础概念。

此技能介绍 TanStack Start 的 Solid 专用绑定、设置和模式。

CRITICAL：所有代码默认都是同构的。加载器会在服务端和客户端运行。服务端专用逻辑请使用 createServerFn。

CRITICAL：不要将 @tanstack/solid-start 与 SolidStart（@solidjs/start）混淆。它们是完全不同的框架，API 也各不相同。

CRITICAL：类型会被完全推断。绝不要进行类型断言，也不要为推断出的值添加类型注解。

包 API 概览

@tanstack/solid-start 重新导出了 @tanstack/start-client-core 中的所有内容，此外还包括：

• useServerFn — 用于在组件中调用服务端函数的 Solid Hook

所有核心 API（createServerFn、createMiddleware、createStart、createIsomorphicFn、createServerOnlyFn、createClientOnlyFn）均可从 @tanstack/solid-start 导入。

服务端实用工具（getRequest、getRequestHeader、setResponseHeader、setCookie、getCookie）从 @tanstack/solid-start/server 导入。

完整项目设置

1. 安装依赖

npm i @tanstack/solid-start @tanstack/solid-router solid-js
npm i -D vite vite-plugin-solid typescript

2. package.json

{
  "type": "module",
  "scripts": {
    "dev": "vite dev",
    "build": "vite build",
    "start": "node .output/server/index.mjs"
  }
}

3. tsconfig.json

{
  "compilerOptions": {
    "jsx": "preserve",
    "jsxImportSource": "solid-js",
    "moduleResolution": "Bundler",
    "module": "ESNext",
    "target": "ES2022",
    "skipLibCheck": true,
    "strictNullChecks": true
  }
}

4. vite.config.ts

import { defineConfig } from 'vite'
import { tanstackStart } from '@tanstack/solid-start/plugin/vite'
import solidPlugin from 'vite-plugin-solid'

export default defineConfig({
  plugins: [
    tanstackStart(), // MUST come before solid plugin
    solidPlugin({ ssr: true }),
  ],
})

5. 路由工厂（src/router.tsx）

import { createRouter } from '@tanstack/solid-router'
import { routeTree } from './routeTree.gen'

export function getRouter() {
  const router = createRouter({
    routeTree,
    scrollRestoration: true,
  })
  return router
}

6. 根路由（src/routes/__root.tsx）

import {
  Outlet,
  createRootRoute,
  HeadContent,
  Scripts,
} from '@tanstack/solid-router'
import { HydrationScript } from 'solid-js/web'
import { Suspense } from 'solid-js'

export const Route = createRootRoute({
  head: () => ({
    meta: [
      { charSet: 'utf-8' },
      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
      { title: 'My TanStack Start App' },
    ],
  }),
  // shellComponent renders the HTML document shell (always SSR'd)
  shellComponent: RootDocument,
})

function RootDocument(props: { children: any }) {
  return (
    <html>
      <head>
        <HydrationScript />
      </head>
      <body>
        <HeadContent />
        <Suspense>{props.children}</Suspense>
        <Scripts />
      </body>
    </html>
  )
}

7. 索引路由（src/routes/index.tsx）

import { createFileRoute } from '@tanstack/solid-router'
import { createServerFn } from '@tanstack/solid-start'

const getGreeting = createServerFn({ method: 'GET' }).handler(async () => {
  return 'Hello from TanStack Start!'
})

export const Route = createFileRoute('/')({
  loader: () => getGreeting(),
  component: HomePage,
})

function HomePage() {
  const greeting = Route.useLoaderData()
  return <h1>{greeting()}</h1>
}

useServerFn Hook

使用 useServerFn 在 Solid 组件中调用服务端函数，并自动处理重定向：

import { createServerFn, useServerFn } from '@tanstack/solid-start'
import { createSignal } from 'solid-js'

const updatePost = createServerFn({ method: 'POST' })
  .validator((data: { id: string; title: string }) => data)
  .handler(async ({ data }) => {
    await db.posts.update(data.id, { title: data.title })
    return { success: true }
  })

function EditPostForm(props: { postId: string }) {
  const updatePostFn = useServerFn(updatePost)
  const [title, setTitle] = createSignal('')

  return (
    <form
      onSubmit={async (e) => {
        e.preventDefault()
        await updatePostFn({ data: { id: props.postId, title: title() } })
      }}
    >
      <input value={title()} onInput={(e) => setTitle(e.target.value)} />
      <button type="submit">Save</button>
    </form>
  )
}

与 React 版本不同，useServerFn 不会对返回的函数进行任何记忆化处理（不需要 useCallback 等效项，因为 Solid 的 setup 只会运行一次）。

Solid 专用组件

@tanstack/solid-router 中的所有路由组件均可在 Start 中使用：

• <Outlet> — 渲染匹配的子路由
• <Link> — 类型安全的导航
• <Navigate> — 声明式重定向
• <HeadContent> — 通过 @solidjs/meta 渲染 head 标签（必须位于 <body> 中，会使用 portals 将内容注入 <head>）
• <Scripts> — 渲染 body 脚本（必须位于 <body> 中）
• <Await> — 配合 <Suspense> 渲染延迟数据
• <ClientOnly> — 仅在水合后渲染子项
• <CatchBoundary> — 包装 Solid.ErrorBoundary 的错误边界

Hooks 参考

@tanstack/solid-router 中的所有 Hook 均可在 Start 中使用。大多数 Hook 返回 Accessor<T>，调用访问器即可读取值：

• useRouter() — 路由器实例（不是 Accessor）
• useRouterState() — Accessor<T>，订阅路由器状态
• useNavigate() — 导航函数（不是 Accessor）
• useSearch({ from }) — Accessor<T>，经过验证的搜索参数
• useParams({ from }) — Accessor<T>，路径参数
• useLoaderData({ from }) — Accessor<T>，加载器数据
• useMatch({ from }) — Accessor<T>，完整的路由匹配信息
• useRouteContext({ from }) — Accessor<T>，路由上下文
• Route.useLoaderData() — Accessor<T>，类型化的加载器数据（在路由文件中优先使用）
• Route.useSearch() — Accessor<T>，类型化的搜索参数（在路由文件中优先使用）

常见错误

1. CRITICAL：从错误的包导入

// WRONG — this is the SPA router, NOT Start
import { createServerFn } from '@tanstack/solid-router'

// CORRECT — server functions come from solid-start
import { createServerFn } from '@tanstack/solid-start'

// CORRECT — routing APIs come from solid-router (re-exported by Start too)
import { createFileRoute, Link } from '@tanstack/solid-router'

2. CRITICAL：忘记调用 Accessor

大多数 Hook 都会返回 Accessor<T>。必须调用它才能读取值。

// WRONG
const data = Route.useLoaderData()
return <h1>{data.message}</h1>

// CORRECT
const data = Route.useLoaderData()
return <h1>{data().message}</h1>

3. HIGH：缺少 Scripts 组件

如果根路由的 <body> 中没有 <Scripts />，客户端 JavaScript 就不会加载，应用也无法完成水合。

4. HIGH：Vite 配置中 Solid 插件的位置早于 Start 插件

// WRONG
plugins: [solidPlugin(), tanstackStart()]

// CORRECT
plugins: [tanstackStart(), solidPlugin()]

交叉引用

• @tanstack/start-client-core#start-core — Start 核心概念
• @tanstack/router-core#router-core — 路由基础知识
• @tanstack/solid-router#solid-router — Solid Router 的 Hook 和组件