@fayz-ai/ui

中文文档
0.94.0发布于 2026/11/11MITTypeScriptESM + CJS近 30 天下载 2.7万

Fayz SDK UI — Radix + Tailwind component library with CRUD engine and layout shells

原始使用文档
文档目录5 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK
  5. Roadmap & contributing

@fayz-ai/ui

Radix + Tailwind primitives, a CRUD engine, and the admin shell every Fayz app wears.

npm license

Status: beta — published to npm and used across Fayz dogfood apps. Pre-1.0: minor APIs may change before 1.0.

A composed Fayz app needs to look like one product, not a pile of plugins. @fayz-ai/ui is the design layer that makes that true: accessible Radix-backed primitives, a data table, layout shells (app shell, sidebar, module pages), a themeable token system, and a dashboard widget kit that plugins contribute KPIs, charts, and tables into. Salon, restaurant, clinic — same shell, same widgets, different brand.

The philosophy: plugins describe behavior, the UI renders it consistently. Define a KPI widget once and it lands in the dashboard grid with layout, ranges, and customization already wired. Drop in AppShell and Sidebar and the navigation a plugin declared just appears.

What's inside

  • Primitives — Button, Input, Badge, Card, Modal, Sheet, Dropdown, Select, Tabs, Tooltip, Popover, DataTable (TanStack), Checkbox, DatePicker, TimePicker, SearchSelect, CurrencyInput, ConfirmDialog, SegmentedControl, toast (sonner)
  • Layout — AppShell, Sidebar, Topbar, ModulePage, SubpageHeader, SaveBar, page transitions, and the module header/back-button slots
  • Dashboard kit — DashboardCanvas, WidgetGrid, DashboardGrid, range controls, and defineKpiWidget / defineChartWidget / defineTableWidget / defineOnboardingWidget / defineCustomWidget with KpiCard, ChartWidget, TableWidget
  • Theme — ThemeProvider, useTheme, createFayzTheme, fayzThemePresets, light/dark tokens
  • Stores + utils — useLayoutStore, useThemeStore, cn, Avatar

Install

npm install @fayz-ai/ui

Peer deps: react, react-dom (^18/^19), tailwindcss (^3.4). Import @fayz-ai/ui/styles.css.

Usage

import { Button, KpiCard, defineKpiWidget } from '@fayz-ai/ui'
import '@fayz-ai/ui/styles.css'

export const revenueWidget = defineKpiWidget({
  id: 'revenue',
  title: 'Revenue',
  value: { format: 'currency', amount: 12400, currency: 'BRL' },
})

export function Demo() {
  return <Button variant="default">Save</Button>
}

Part of the Fayz SDK

The presentation layer on top of @fayz-ai/core; the admin surface in @fayz-ai/admin is built from it.

Roadmap & contributing

Built and evolving in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.

版本与发布记录

@fayz-ai/ui 共发布 103 个版本,首次发布于 2026/06/18;过去 12 个月发布了 103 个版本。

版本发布日期距今
0.94.0latest2026/11/112 天前
0.92.02026/11/113 天前
0.91.22026/11/104 天前
0.91.02026/11/067 天前
0.90.02026/11/068 天前
0.89.02026/11/068 天前

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

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

@fayz-ai/ui 是什么?

Fayz SDK UI — Radix + Tailwind component library with CRUD engine and layout shells

如何安装 @fayz-ai/ui?

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

@fayz-ai/ui 支持 TypeScript 吗?

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

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

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fayz-ai/ui 可以商用吗?

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

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

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

@fayz-ai/ui 还在维护吗?

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