# @fayz-ai/ui 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/ui/

版本：0\.94\.0
npm 元数据更新时间：2026-11-11T14:56:55.322Z
中文译文更新时间：2026-11-14T12:08:01.771Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/ui
原文对照：https://npmcn.com/package/%40fayz-ai/ui/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.4 MB，370 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：16 个
- 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
- 首次发布：2026-06-17T23:02:11.531Z
- 最新版本发布：2026-11-11T14:56:55.093Z
- 近 30 天下载量：27237（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：103（近 12 个月 103 个）

## 中文简介

Fayz SDK UI — Radix + 有 CRUD 引擎和布局外壳的 Tailwind 组件库

## 安装

```sh
npm install @fayz-ai/ui
```

也可以使用：`pnpm add @fayz-ai/ui`、`yarn add @fayz-ai/ui`、`bun add @fayz-ai/ui`

## README

# @fayz-ai/ ui (英语)

> 半径+ 尾风原始人 CRUD引擎,每个Fayz应用都穿的管理员外壳.

[![npm](https://img.shields.io/npm/v/@fayz-ai/ui.svg)](https://www.npmjs.com/package/@fayz-ai/ui) [![license](https://img.shields.io/npm/l/@fayz-ai/ui.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

**状态 :** β-发布至npm并在整个法伊兹狗食应用. 事前1.0:小API在1.0之前可能会有变化.

一个由Fayz组成的应用程序需要看起来像一个产品,而不是一堆插件. `@fayz-ai/ui` 是使这个事实真实化的设计层:可访问的 Radix 备份原始文件,一个数据表,布局外壳(app shell, sidebar, 模块页面),一个可主题符号系统,以及一个将插件贡献出KPI,图表和表格的仪表盘部件包. 沙龙,餐厅,诊所——同壳,同部件,同品牌.

哲学:插件描述行为,UI使其一致. 定义一个 KPI 部件一次, 它降落在仪表板网格中, 其布局、 范围以及定制已接通线路 。 进来 `AppShell` 财务报告和审定财务报表 `Sidebar` 并显示一个刚刚宣布的插件 .

## 里面的东西

-   **初级** 按钮、输入、徽章、卡片、相机、工作表、下拉、选择、标签、工具提示、波波弗, `DataTable` (TanStack),收录框, DatePicker, TimePicker, 搜索选择, 货币输入, 确认Dialog, 分块控制, 土司(`sonner`(中文(简体) )
-   **版式** —— 说 `AppShell`, (中文(简体) ), `Sidebar`, (中文(简体) ), `Topbar`, (中文(简体) ), `ModulePage`, (中文(简体) ), `SubpageHeader`, (中文(简体) ), `SaveBar`,页面转换,以及模块头/后按钮槽
-   **纸板包** —— 说 `DashboardCanvas`, (中文(简体) ), `WidgetGrid`, (中文(简体) ), `DashboardGrid`,范围控制,以及 `defineKpiWidget` 编号 : `defineChartWidget` 编号 : `defineTableWidget` 编号 : `defineOnboardingWidget` 编号 : `defineCustomWidget` 与 `KpiCard`, (中文(简体) ), `ChartWidget`, (中文(简体) ), `TableWidget`
-   **主题** —— 说 `ThemeProvider`, (中文(简体) ), `useTheme`, (中文(简体) ), `createFayzTheme`, (中文(简体) ), `fayzThemePresets`,轻/暗符号
-   **存储 + 提用** —— 说 `useLayoutStore`, (中文(简体) ), `useThemeStore`, (中文(简体) ), `cn`阿凡达

## 安装

```bash
npm install @fayz-ai/ui
```

端点 : `react`, (中文(简体) ), `react-dom` (^18/^19), (中文(简体) ), `tailwindcss` (^3.4) (中文(简体) ). 导入 `@fayz-ai/ui/styles.css`。 。 。 .

## 使用量

```tsx
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>
}
```

## 费兹SDK的一部分

顶部的演示文稿层 `@fayz-ai/core`; 管理员在 `@fayz-ai/admin` 它是从它建造的.

## 路线图贡献( I)

建设并不断发展于开阔. 见 [费兹SDK路线图](https://npmcn.com/package/docs/platform/ROADMAP.md#ui) 对于当前空白,缺失的特征,以及良好的第一问题.

## 常见问题

### @fayz-ai/ui 是什么？

Fayz SDK UI — Radix \+ 有 CRUD 引擎和布局外壳的 Tailwind 组件库

### 如何安装 @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 和提交记录判断。