# @fayz-ai/plugin-dashboard 中文文档

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

版本：0\.9\.60
npm 元数据更新时间：2026-11-11T14:55:00.174Z
中文译文更新时间：2026-11-14T12:14:29.758Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：51.2 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 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
- 首次发布：2026-06-17T23:02:11.131Z
- 最新版本发布：2026-11-11T14:54:59.908Z
- 近 30 天下载量：6232（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：76（近 12 个月 76 个）

## 中文简介

\[实验\] Fayz SDK — 插件- 刷板插件

## 安装

```sh
npm install @fayz-ai/plugin-dashboard
```

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

## README

# @fayz-ai/插图-dashboard

> **现状:实验(孵化).** 能力不完全——缺少部分或全部能力栏(数据提供者合同w/supabase+mock配对、实体登记、设置、迁移;见 `docs/plugins/PLUGIN-PATTERNS.md`) (中文(简体) ). 精细在狗食中探索;不准备新安装或生成应用,其API可能会不经通知而改变.

> 每个插件都自制部件的可堆肥的家.

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

SaaS主页从不为一队所拥有. 预订要今天的议程,金融要收入,店铺要顶级产品. 通常的结果是 一个神的成分 进口一切和腐烂。 此插件杀死它 。 它提供 `/` 家庭表面和a **部件登记册**: 每个插件自行贡献 `dashboardWidgets`,而"仪表盘"则会制作,命令,把它们放出一个单一的连贯的网格——不需要插件来知道任何其他插件的存在.

这是Fayz SDK在家用屏幕上的全部赌注. 启用预订+财务+店铺并自填. 应用程序作者解析了——哪个部件显示,顺序,跨度,一个可选的共享时间范围——每个插件拥有自己的数据. 由插件组成一个真正的SaaS家,而不是用手维持一个仪表板.

## 里面的东西

-   这个 `/` 家为 **表面** 执行人: `DashboardCanvas`,完全由部件注册驱动
-   带有同位素的KPI 度量衡 `compute`趋势、目标和货币格式`metrics` • KPI卡
-   自定义应用程序部分,一个登入/启动的核对表,以及应用程序配置 `customWidgets`
-   App级 `layout` 每个插件注册默认值的顶部的校正——能见度,顺序,跨度
-   一个可选共享的粘相 `range` 部件读取 `useDashboardRange()`
-   一个 `getKpiSummary` AI工具让助手可以回答"今天我的生意怎么样?"
-   每层用户偏好(显示/隐藏/重排)持续存在,加上全i18n

## 安装

```bash
npm install @fayz-ai/plugin-dashboard
```

端点 : `@fayz-ai/core`, (中文(简体) ), `@fayz-ai/ui` (+ 数) `react`, (中文(简体) ), `react-dom`) (中文(简体) ).

## 使用量

```tsx
import { defineSaas } from '@fayz-ai/admin'
import { createDashboardPlugin } from '@fayz-ai/plugin-dashboard'

export const app = defineSaas({
  // ...
  plugins: [
    createDashboardPlugin({
      metrics: [
        { id: 'revenue', label: 'Revenue', icon: 'DollarSign', format: 'currency', compute: getRevenue },
      ],
      currency: { code: 'BRL', locale: 'pt-BR' },
      onboardingSteps: [
        { id: 'connect-payments', label: 'Connect payments', done: false },
      ],
      range: true, // shared 7d/30d/90d time-range on the home
    }),
    // other plugins contribute their own widgets into this same home
  ],
})
```

其他插件只是传送 `dashboardWidgets` 他们将自动降落在地上。 使用 `defineKpiWidget` 编号 : `defineChartWidget` 编号 : `defineTableWidget` 从 `@fayz-ai/ui` 来建造它们.

## 费兹SDK的一部分

其它 Fayz 插件所渲染的家表和部件注册 .

## 路线图贡献( I)

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

## 常见问题

### @fayz-ai/plugin-dashboard 是什么？

\[实验\] Fayz SDK — 插件- 刷板插件

### 如何安装 @fayz-ai/plugin-dashboard？

在项目目录运行 npm install @fayz-ai/plugin-dashboard，或使用 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-dashboard 支持 TypeScript 吗？

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

### @fayz-ai/plugin-dashboard 支持 ESM 还是 CommonJS？

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

### @fayz-ai/plugin-dashboard 可以商用吗？

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

### @fayz-ai/plugin-dashboard 的下载量有多少？

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

### @fayz-ai/plugin-dashboard 还在维护吗？

最新版本 0\.9\.60 发布于 2026/11/11（2 天前）；至今共发布 76 个版本，其中过去 12 个月发布了 76 个；首次发布于 2026/06/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。