# @firecms/formex 中文文档

规范地址：https://npmcn.com/package/%40firecms/formex/

版本：3\.5\.2
npm 元数据更新时间：2026-11-10T18:02:56.641Z
中文译文更新时间：2026-11-14T19:35:50.205Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40firecms/formex
原文对照：https://npmcn.com/package/%40firecms/formex/?lang=original
项目主页：https://github.com/firecmsco/firecms#readme
源码仓库：https://github.com/firecmsco/firecms

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

- 包体积（解压后）：128 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=18\.3\.1 \|\| \>=19\.0\.0，react-dom \>=18\.3\.1 \|\| \>=19\.0\.0
- 首次发布：2024-02-12T21:49:24.736Z
- 最新版本发布：2026-11-10T18:02:56.272Z
- 近 30 天下载量：6376（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：386（近 12 个月 79 个）

## 中文简介

Formex是一个轻量级,灵活的库,旨在简化React应用程序内的形式处理. 通过利用React强大的上下文和钩子特征,Formex允许高效地以最低锅炉板代码的形式进行状态管理.

## 安装

```sh
npm install @firecms/formex
```

也可以使用：`pnpm add @firecms/formex`、`yarn add @firecms/formex`、`bun add @firecms/formex`

## README

# Formex - 反应表单库

Formex是一个轻量级,灵活的库,旨在简化React应用程序内的形式处理. 通过利用React强大的上下文和钩子特征,Formex允许高效地以最低锅炉板代码的形式进行状态管理.

## 特征

-   轻而易举
-   支持自定义字段组件
-   内建验证处理
-   提供外地一级和形式一级的国家管理

## 安装

要安装Formex, 您可以使用 npm 或纱线 :

```sh
npm install @firecms/formex

# or if you're using yarn

yarn add @firecms/formex
```

## 快速启动

要从Formex开始,您首先需要创建您的形式上下文,并使用 `useCreateFormex` 钩. 然后,你可以使用 `<Field />` formex 提供的组件.

### 步骤1: 创建窗体控制器

```jsx
import React from 'react';
import { useCreateFormex } from 'formex-library';

const MyForm = () => {
    const formController = useCreateFormex({
        initialValues: {
            name: '',
            email: '',
        },
        // Optionally add a validation function
        // validation: values => {
        //   const errors = {};
        //   if (!values.name) errors.name = 'Name is required';
        //   return errors;
        // },
        onSubmit: (values) => {
            console.log('Form Submitted:', values);
        },
    });

    return (
        <form onSubmit={formController.handleSubmit}>
            {/* Field components go here */}
        </form>
    );
};
```

### 步骤2:使用 `<Field />` 组件

```jsx
import { Field } from 'formex-library';

// Inside your form component
<Field name="name">
  {({ field }) => (
    <input
      {...field}
      placeholder="Your name"
    />
  )}
</Field>

<Field name="email">
  {({ field }) => (
    <input
      {...field}
      type="email"
      placeholder="Your email"
    />
  )}
</Field>

<button type="submit">Submit</button>
```

### 处理提交材料

在窗体元素内将窗体输入和提交按钮并传递 `submitForm` 从表单控制器到表单 `onSubmit` 事件:

```jsx
<form onSubmit={formController.handleSubmit}>
    {/* Fields and submit button */}
</form>
```

## API 参考

### `useCreateFormex`

钩来创建窗体控制器.

**参数**

-   `initialValues`: 带有窗体初始值的对象.
-   `initialErrors` (可选) : 初始验证错误的对象 .
-   `validation` (可选):用于验证窗体数据的函数.
-   `validateOnChange` (可选):如果 `true`,当字段改变时,验证字段.
-   `onSubmit`: 提交表单时起火的函数.

### `<Field />`

用于制取单个形式字段的组件 .

**道具**

-   `name`:形式字段的名称.
-   `as` (可选) : 应当渲染的组件或 HTML 标记 。 默认为 `"input"`。 。 。 .
-   `children`: 返回字段输入组件的函数。 接收字段道具作为其参数.

**示例**

```jsx
<Field name="username">
  {({ field }) => <input {...field} />}
</Field>
```

## 自定义

Formex的设计是灵活的. 您可以创建自定义字段组件,使用任何验证库,或者与UI组件库相集.

### 使用 UI 图书馆

```jsx
import { Field } from 'formex-library';
import { TextField } from 'some-ui-library';

<Field name="username">
  {({ field }) => (
    <TextField {...field} label="Username" />
  )}
</Field>
```

### 自定义验证

利用 `validation` 函数在 `useCreateFormex` 以整合任何验证逻辑或库.

```jsx
const validate = values => {
  const errors = {};
  if (!values.email.includes('@')) {
    errors.email = 'Invalid email';
  }
  return errors;
};
```

## 结论

Formex提供了一种简单而强大的在React应用程序中管理表格的方法. 它减少了需要的锅炉平板码数量并提供了与自定义组件和验证策略合作的灵活性. Formex 可以帮助简化表格管理程序.

关于进一步的例子和高级用法,参见Formex文档或源代码.

## 常见问题

### @firecms/formex 是什么？

Formex是一个轻量级,灵活的库,旨在简化React应用程序内的形式处理\. 通过利用React强大的上下文和钩子特征,Formex允许高效地以最低锅炉板代码的形式进行状态管理\.

### 如何安装 @firecms/formex？

在项目目录运行 npm install @firecms/formex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18\.3\.1 \|\| \>=19\.0\.0）、react-dom（\>=18\.3\.1 \|\| \>=19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @firecms/formex 支持 TypeScript 吗？

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

### @firecms/formex 支持 ESM 还是 CommonJS？

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

### @firecms/formex 可以商用吗？

@firecms/formex 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @firecms/formex 的下载量有多少？

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

### @firecms/formex 还在维护吗？

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