@fayz-ai/plugin-admin

中文文档
0.9.72发布于 2026/11/11MITTypeScriptES Module近 30 天下载 7417

[实验性] Fayz SDK – 管理员 shell 设置插件(只读基础)

中文使用文档
文档目录6 节
  1. 基金会地位——先读此文
  2. 里面的东西
  3. 安装
  4. 使用量
  5. 费兹SDK的一部分
  6. 路线图贡献( I)

@fayz-ai/plugin-admin (英语)

一个小组查看您的应用程序的外壳配置——布局、模块导航和品牌设计.

npm license

每个 SaaS/admin-template app 已经解决了 shell 配置 – sidebar 或 topbar 版式, 用于模块导航的 rail 或制表符, 移动头处理, 无论是显示org/ 品牌设置, 都来自 FayzAppConfig (单位:千美元)src/config/app.tsx 编号 : theme.ts)在建设时间. 今天,一个操作员无法从小组看到其中的任何内容;改变它意味着手动编辑配置文件并重新部署. plugin-admin 添加一个 /admin 页面,可以反映解析后的配置,从而可见而不读取源.

基金会地位——先读此文

这是一个 基础通过, 而非能力完整的插件它传送一个只读的视图 layout 编号 : moduleNav 编号 : mobileHeader 编号 : branding; 存在 无写入路径 还没有。 数据提供者( mock + Supabase stub) 都简单地回放静态解析的配置 —— 没有 shell- config 表格, 而这个插件并不制作 FayzAppConfig.layout (或其任何兄弟姐妹)在跑步时可变异.

后续行动: 电线真实读取/写回这些字段 FayzAppConfig 一旦 shell 级别配置的插件编辑扩展点存在. docs/saas/CUSTOMIZATION.md 已经命名了空隙——saas shell的槽合同(名称排版/菜单槽,像商店头一样发布)是 [planned FAY-1248/FAY-1196],"permana/slots相". plugin-admin写路径是该阶段的消费者,而不是替代:它应该在贝壳槽有已公布的合同可以写入时降落,而不是让这个插件到达周围 defineSaas 和突变配置临时.

里面的东西

  • 一个 /admin 页面:只读卡片用于布局,模块导航风格,移动头处理,品牌能见度
  • 配置镜像 FayzAppConfig 1:1 (中文(简体) )layout, (中文(简体) ), moduleNav, (中文(简体) ), mobileHeader, (中文(简体) ), navTransition, (中文(简体) ), orgSettings, (中文(简体) ), branding)——无新配置形状
  • 一个AI工具, getShellSettings,所以"这个应用程序使用什么布局?"已经奏效了
  • Moc + Supabase 数据提供者( 既是今天的根, 自动选择) 和 完整 i18n

安装

npm install @fayz-ai/plugin-admin

端点 : react, (中文(简体) ), react-dom中。运行时解码包括 @fayz-ai/core, (中文(简体) ), @fayz-ai/ui,以及 @fayz-ai/admin。 。 。 .

使用量

import { defineSaas } from '@fayz-ai/admin'
import { createAdminPlugin } from '@fayz-ai/plugin-admin'

export const app = defineSaas({
  // ...
  layout: 'sidebar',
  moduleNav: 'tabs',
  plugins: [
    createAdminPlugin({
      layout: 'sidebar',
      moduleNav: 'tabs',
      mobileHeader: 'minimal',
      branding: true,
    }),
  ],
})

传递与您已经给出的相同值 defineSaas ——插件并不自动从应用配置中得出它们(目前还没有这样的接线);它只是使你所说的话成为事实.

费兹SDK的一部分

仅针对Saas/admin-template脚手架(scaffolds: ['saas'])——这是小组侧壳配置,不是存储前置问题. 与任何设置对等, 显示应用程序已经曝光; 它增加了可见度, 而不是一个新的设置系统 .

路线图贡献( I)

建设并不断发展于开阔. 见 费兹SDK路线图 财务报告和审定财务报表 docs/saas/CUSTOMIZATION.md 这是脚手架朝向的写道.

版本与发布记录

@fayz-ai/plugin-admin 共发布 81 个版本,首次发布于 2026/07/14;过去 12 个月发布了 81 个版本。

版本发布日期距今
0.9.72latest2026/11/112 天前
0.9.712026/11/113 天前
0.9.702026/11/113 天前
0.9.692026/11/067 天前
0.9.682026/11/068 天前
0.9.672026/11/068 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.9.63-canary.20261028153856。

关于 @fayz-ai/plugin-admin 的常见问题

@fayz-ai/plugin-admin 是什么?

[实验性] Fayz SDK – 管理员 shell 设置插件(只读基础)

如何安装 @fayz-ai/plugin-admin?

在项目目录运行 npm install @fayz-ai/plugin-admin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/plugin-admin 支持 TypeScript 吗?

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

@fayz-ai/plugin-admin 支持 ESM 还是 CommonJS?

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

@fayz-ai/plugin-admin 可以商用吗?

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

@fayz-ai/plugin-admin 的下载量有多少?

根据 npm 官方下载统计,@fayz-ai/plugin-admin 在 2026/10/15 – 2026/11/13 这 30 天内被下载 7,417 次,日均约 247 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fayz-ai/plugin-admin 还在维护吗?

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