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

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

版本：0\.15\.34
npm 元数据更新时间：2026-11-11T14:54:03.973Z
中文译文更新时间：2026-11-14T12:10:26.679Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：907 kB，115 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 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:13.556Z
- 最新版本发布：2026-11-11T14:54:03.632Z
- 近 30 天下载量：8727（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：88（近 12 个月 88 个）

## 中文简介

Fayz SDK — 插件窗体插件

## 安装

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

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

## README

# @fayz-ai/插件格式

> 模板、文件和签名——任何垂直的文件层.

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

**状态 :** β-前1.0 (中文(简体) ). 核心表面稳定;一些后端侧面(见 `PLUGIN_PATTERNS.md`)仍在着陆. API在1.0前可能会有变化.

每个真正的生意都靠它从未想建立的形式: 麻醉药单、进化笔记、同意合同、录取文件。 插件窗体杀死了那个忙活。 定义模板一次,将一个填好的文档附加到一个人身上,数据存在于你的租户中——而不是PDF中,没有人可以查询.

它会变成一个 `defineSaas` 应用作为文档引擎。 诊所会填充健康安眠药 沙龙会收集同意表 工作室会签合同 同样的插件 同样的 `frm_*` 表格,不同的模板。 文档通过一个细节-tab部件在人物记录中直面,AI助手可以按要求列出模板和客户端文件.

## 里面的东西

-   **模板+文档模式** 由Supabase公司提供支持`frm_*` 与模拟提供者通过 `createSafeDataProvider`
-   **表格类别登记册** (单位:千美元)`frm_categories`由Anamense、Evolução、Laudo、Contrato、Geral等种子
-   **人物细节部件** a 包括: `person.detail.documents` 将文档列表和附加到联系人的分区标签
-   **设置标签** 用于管理模板、文件和类别
-   **文档类型提供者 API** —— 说 `registerDocumentTypeProvider` 让其他插件提供可选择的文档/文件类型
-   **AI 工具** —— 说 `listFormTemplates` 财务报告和审定财务报表 `listDocuments` (只读,允许)
-   **可粘接数据层** -通过你自己的 `dataProvider`或让它自动解决 Supabase 来模拟

## 安装

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

端点 : `react`, (中文(简体) ), `react-dom`。运行时道克 : `@fayz-ai/core`, (中文(简体) ), `@fayz-ai/ui`。 。 。 .

## 使用量

```tsx
import { defineSaas } from '@fayz-ai/admin'
import { createCustomFormsPlugin } from '@fayz-ai/plugin-forms'

export const app = defineSaas({
  // ...
  plugins: [
    createCustomFormsPlugin({
      labels: { pageTitle: 'Documents' },
      // dataProvider: myProvider,  // optional — defaults to Supabase → mock
    }),
  ],
})
```

## 费兹SDK的一部分

旋转的可堆肥插件之一 `@fayz-ai/admin` 成为真实的,垂直的SaaS——这个拥有文件和签名.

## 路线图贡献( I)

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

## 常见问题

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

Fayz SDK — 插件窗体插件

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

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

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

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

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

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

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

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

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

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

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