@fayz-ai/插图-dashboard
现状:实验(孵化). 能力不完全——缺少部分或全部能力栏(数据提供者合同w/supabase+mock配对、实体登记、设置、迁移;见
docs/plugins/PLUGIN-PATTERNS.md) (中文(简体) ). 精细在狗食中探索;不准备新安装或生成应用,其API可能会不经通知而改变.
每个插件都自制部件的可堆肥的家.
SaaS主页从不为一队所拥有. 预订要今天的议程,金融要收入,店铺要顶级产品. 通常的结果是 一个神的成分 进口一切和腐烂。 此插件杀死它 。 它提供 / 家庭表面和a 部件登记册: 每个插件自行贡献 dashboardWidgets,而"仪表盘"则会制作,命令,把它们放出一个单一的连贯的网格——不需要插件来知道任何其他插件的存在.
这是Fayz SDK在家用屏幕上的全部赌注. 启用预订+财务+店铺并自填. 应用程序作者解析了——哪个部件显示,顺序,跨度,一个可选的共享时间范围——每个插件拥有自己的数据. 由插件组成一个真正的SaaS家,而不是用手维持一个仪表板.
里面的东西
- 这个
/家为 表面 执行人:DashboardCanvas,完全由部件注册驱动 - 带有同位素的KPI 度量衡
compute趋势、目标和货币格式metrics• KPI卡 - 自定义应用程序部分,一个登入/启动的核对表,以及应用程序配置
customWidgets - App级
layout每个插件注册默认值的顶部的校正——能见度,顺序,跨度 - 一个可选共享的粘相
range部件读取useDashboardRange() - 一个
getKpiSummaryAI工具让助手可以回答"今天我的生意怎么样?" - 每层用户偏好(显示/隐藏/重排)持续存在,加上全i18n
安装
npm install @fayz-ai/plugin-dashboard
端点 : @fayz-ai/core, (中文(简体) ), @fayz-ai/ui (+ 数) react, (中文(简体) ), react-dom) (中文(简体) ).
使用量
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路线图 对于当前空白,缺失的特征,以及良好的第一问题.