@12-apps/onboarding

中文文档
2.7.0发布于 2026/08/25MITTypeScriptES Module构建来源已验证近 30 天下载 3.3万

上载可重复使用 : React supper + Guided Sector 和 API 绑定上载 Store (.), 主机挂载进度表 (./ server: Create ApiOnboarding - GET/PATCH Progress with save/diission/ reset),一个Hono适配器 (./hono),以及软件包所有

中文使用文档
文档目录3 节
  1. 出口
  2. 数据模型随包而来
  3. 接线

@ 12- apps/ 登机

可重复使用、可续用、每个用户x租户 登入进度 供引导者使用 流动——任何应用程序/页面都可以采用一个小型系统.

  • 坚持用户停止的准确步骤 每个地貌不透明 有效载荷,所以一个新鲜的恢复了它们离开的地方(不是开始).
  • 持久性-不可知性: 向注入的 UI + 钩子聊天 OnboardingStore, (中文(简体) ), 所以你支持Prisma服务器的动作 TRPC、REST之类的.
  • 船舶a Prisma 帮助工具 (单位:千美元)createOnboardingRepository对于普通案件, (单位:千美元) GuidedSection 将国家约束在 @12-apps/ui是因为 SectionOnboarding +分阶.

两只船都一半在这里(12至23日):屏幕和端点持续 通过,每个工厂. 采用.md 是否通过 合同 ——配置表,被咬的接线规则,以及B阶段注释 给一个已经有桌子的宿主.

出口

条目导出什麽
.OnboardingProvider 编号 : useOnboarding客户端状态,通过注入突变 OnboardingStore。 。 。 .
.GuidedSection登陆英雄 – 按步法师(步法师) – 完成总结,由坚持状态所驱动.
.createOnboardingApiStore 编号 : fetchOnboardingState被捆绑到包的OWN端点的商店,因此每个主机中一次声明了URL,身体形状和日期复兴.
.类型OnboardingStore, (中文(简体) ), OnboardingStateSnapshot, (中文(简体) ), GuidedStep, (中文(简体) ), GuidedNav,, , , , , , , ,
./servercreateApiOnboarding({ db })进展表面作为框架中立的路线描述符—— GET 财务报告和审定财务报表 PATCH 与 save 编号 : dismiss 编号 : reset。 。 。 .
./servercreateOnboardingRepository(getPrisma)Prisma 读取/写入其下的帮助(data-commerce + 开始/完成印花).
./honoonboardingRouter({ db, resolveActor })与可挂的Hono路由器相同的表面. hono 是一个可选的对等点.
prisma/onboarding.prisma + 其迁移套装 OWNS的 OnboardingState 模型——一个主机同步它(从下到下)而不是重制.

数据模型随包而来

不要用手把模型复制进你的计划 使用 Prisma 的多文件计划 文件夹并同步软件包本身的部分内容——一个字节的 CCOPY,从不 symlink(一个相通的迁移被Prisma悄悄地跳过):

node node_modules/@12-apps/onboarding/scripts/sync-onboarding-schema.mjs prisma/schema

移民船只在 prisma/migrations/里面的言辞,都是有戒备的 - 如此的东道主已经 onboarding_states 应用为无操作,没有 prisma migrate resolve 跳个舞 见Adopting.md.

接线

// server: one mount. The host keeps only who is calling, and where data lives.
const onboarding = onboardingRouter({
  db: async () => (await getPrismaClient()) as unknown as OnboardingPrisma,
  featureKeys: ['ai_integration'],
  resolveActor: (c) => resolveActorFor(c), // → { userId, clientId } | null
});
app.route('/api/admin/:tenantSlug', onboarding.router);

// browser: the package's own store, against those endpoints
const store = createOnboardingApiStore({ apiBase, featureKey: 'ai_integration' });
const initial = await fetchOnboardingState({ apiBase, featureKey: 'ai_integration' });

<OnboardingProvider featureKey="ai_integration" store={store} initialState={initial}>
  <GuidedSection steps={steps} title="…" configuredSummary={…} />
</OnboardingProvider>

其持久性不是这些路径的主机( localStorage, tRPC, 服务器动作) 仍然通过自己的 OnboardingStore ——接缝不变.

版本与发布记录

@12-apps/onboarding 共发布 44 个版本,首次发布于 2026/07/18;过去 12 个月发布了 44 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.7.0latest2026/08/252 个月前
2.6.02026/08/252 个月前
2.5.02026/08/252 个月前
2.4.02026/08/242 个月前
2.3.02026/08/232 个月前
2.2.12026/08/232 个月前

关于 @12-apps/onboarding 的常见问题

@12-apps/onboarding 是什么?

上载可重复使用 : React supper + Guided Sector 和 API 绑定上载 Store (.), 主机挂载进度表 (./ server: Create ApiOnboarding - GET/PATCH Progress with save/diission/ reset),一个Hono适配器 (./hono),以及软件包所有

如何安装 @12-apps/onboarding?

在项目目录运行 npm install @12-apps/onboarding,或使用 pnpm add / yarn add / bun add。

@12-apps/onboarding 支持 TypeScript 吗?

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

@12-apps/onboarding 支持 ESM 还是 CommonJS?

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

@12-apps/onboarding 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@12-apps/onboarding 可以商用吗?

@12-apps/onboarding 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@12-apps/onboarding 的下载量有多少?

根据 npm 官方下载统计,@12-apps/onboarding 在 2026/10/04 – 2026/11/02 这 30 天内被下载 32,604 次,日均约 1,087 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@12-apps/onboarding 还在维护吗?

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