@c15t/tanstack-start

中文文档
3.2.2发布于 2026/11/02Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 7.5万

TanStack cookie consent banner for TanStack Start, built on c15t. Server-rendered banner, request middleware and a preference center.

原始使用文档
文档目录11 节
  1. Key Features
  2. Prerequisites
  3. Installation
  4. Usage
  5. Run c15t on Inth
  6. Documentation
  7. Docs for AI Agents
  8. Support
  9. Contributing
  10. Security
  11. License

c15t: the open standard for cookie banners

@c15t/tanstack-start: TanStack Start cookie banner and cookie consent management

Latest NPM Version Stars License Discord Skills Made by Inth

Cookie banner, consent dialog, and preference center for TanStack Start. A server function in the root loader resolves each visitor's consent policy, such as GDPR opt-in in the EU, so the banner is in the first HTML.

c15t is used by 2,100+ sites, including expo.dev, zed.dev, unkey.dev, mintlify.com, and sazabi.com.

Key Features

  • Works with @tanstack/react-start 1.168.60 or a later 1.x release, including TanStack Start 1.0, on React 18 or 19
  • The root route loader resolves each visitor's policy on the server, so the banner is in the first HTML and does not appear late
  • Your policy downloads at build time with consentManifest() and stays on the server
  • Request middleware reads CDN location, language, and Global Privacy Control headers
  • Prerendered pages and static hosts work too, with createConsentRoute() for same-origin consent requests
  • Prebuilt cookie banner, consent dialog, and preference center with a theme system
  • Headless hooks for a fully custom design
  • Analytics, ads, and pixels follow each visitor's choice through @c15t/integrations: Google Tag Manager, Google Consent Mode v2, GA4, Meta Pixel, PostHog, and more
  • IAB TCF 2.4 banner, dialog, and hooks through the @c15t/react/iab subpath
  • Translations for 53 languages through @c15t/translations

Prerequisites

  • @tanstack/react-start 1.168.60 or a later 1.x release, including TanStack Start 1.0
  • @tanstack/react-router 1.170.41 or a later 1.x release, at the version your @tanstack/react-start release depends on. TanStack Start 1.0 needs at least 1.170.43
  • Vite 7 or later, or Vite 8 or later for TanStack Start 1.0
  • React 18 or 19
  • Node.js 20.19 or later, or Node.js 22.12 or later for TanStack Start 1.0
  • An Inth project (free sign-up). For development and tests, local mode needs no backend

Installation

pnpm add @c15t/tanstack-start

Then add the prebuilt stylesheet to your app-level CSS entry point:

/* src/styles.css */
@import "@c15t/tanstack-start/styles.css";

Using several c15t packages? Install c15t and import c15t/tanstack-start instead. It is the same code.

Usage

  1. Set VITE_C15T_BACKEND_URL to your Inth backend URL in .env
  2. Add consentManifest() from @c15t/tanstack-start/build to vite.config.ts, before tanstackStart(). It downloads your policy at build time and keeps it on the server
// vite.config.ts
import { consentManifest } from '@c15t/tanstack-start/build';
import { tanstackStart } from '@tanstack/react-start/plugin/vite';
import viteReact from '@vitejs/plugin-react';
import { defineConfig } from 'vite';

export default defineConfig({
  plugins: [consentManifest(), tanstackStart(), viteReact()],
});
  1. Resolve the consent state in the root route loader with createConsentStateHandler() in a server function, and pass it to ConsentRoot
// src/routes/__root.tsx
import { createRootRoute, Outlet } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import {
  ConsentBanner,
  ConsentDialog,
  ConsentDialogLink,
  ConsentRoot,
} from '@c15t/tanstack-start';
import {
  consentLoaderOptions,
  createConsentStateHandler,
} from '@c15t/tanstack-start/server';

const getConsentState = createServerFn({ method: 'GET' }).handler(
  createConsentStateHandler()
);

export const Route = createRootRoute({
  ...consentLoaderOptions,
  loader: async () => ({ consent: await getConsentState() }),
  component: RootComponent,
});

function RootComponent() {
  const { consent } = Route.useLoaderData();
  return (
    <ConsentRoot state={consent}>
      <Outlet />
      <ConsentBanner />
      <ConsentDialog />
      <ConsentDialogLink>Privacy settings</ConsentDialogLink>
    </ConsentRoot>
  );
}
  1. For the full setup, see the TanStack Start quickstart

Run c15t on Inth

c15t needs a backend to serve policies and keep consent records. Inth runs it for you. It stores every choice with its region and policy version, audits your live site and pull requests for privacy risk, and on Pro and above keeps each region's consent rules current with managed policy packs. You don't run the consent database, geo lookups, uptime, or upgrades.

Sign-up is free. Run npx @inth/cli c15t to create a project and set up c15t, or create one by hand and copy its backend URL.

For development and tests, local mode keeps choices in the browser and keeps no consent records. Don't ship it to production. Its factory is local(). The old name, offline(), still works and goes away in v4.

Documentation

See the documentation for guides, API reference, and examples.

Docs for AI Agents

This package ships its documentation as Markdown, matched to the installed version. After you install it, point your coding agent at node_modules/@c15t/tanstack-start/AGENTS.md. It indexes every guide in node_modules/@c15t/tanstack-start/docs/.

On the web, every page of the c15t docs has a Markdown version, and llms.txt lists them all. Install the c15t agent skills with npx skills add c15t/skills.

Support

Contributing

Security

Do not open a public issue for a security vulnerability. Report it privately through GitHub's vulnerability reporting. We examine every valid report.

  • Do not share the vulnerability in public forums, issues, or pull requests
  • Give the steps to reproduce it and the versions it affects
  • Give us time to release a fix before you disclose it

License

Apache License 2.0


Built by Inth

版本与发布记录

@c15t/tanstack-start 共发布 21 个版本,首次发布于 2026/09/15;过去 12 个月发布了 21 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.2.2latest2026/11/027 天前
3.2.12026/10/319 天前
3.2.02026/10/3010 天前
3.2.0-canary.0canary2026/10/2316 天前
3.1.02026/10/1723 天前
3.1.0-canary.02026/10/1525 天前

其他发布通道:alpha → 3.0.0-alpha.12,canary → 3.2.0-canary.0。

关于 @c15t/tanstack-start 的常见问题

@c15t/tanstack-start 是什么?

TanStack cookie consent banner for TanStack Start, built on c15t. Server-rendered banner, request middleware and a preference center.

如何安装 @c15t/tanstack-start?

在项目目录运行 npm install @c15t/tanstack-start,或使用 pnpm add / yarn add / bun add。

@c15t/tanstack-start 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@c15t/tanstack-start 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@c15t/tanstack-start 可以商用吗?

@c15t/tanstack-start 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@c15t/tanstack-start 的下载量有多少?

根据 npm 官方下载统计,@c15t/tanstack-start 在 2026/10/09 – 2026/11/07 这 30 天内被下载 75,086 次,日均约 2,503 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@c15t/tanstack-start 还在维护吗?

最新版本 3.2.2 发布于 2026/11/02(7 天前);至今共发布 21 个版本,其中过去 12 个月发布了 21 个;首次发布于 2026/09/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。