# @berlitz/form-field 中文文档

规范地址：https://npmcn.com/package/%40berlitz/form-field/

版本：5\.3\.3
npm 元数据更新时间：2026-11-05T19:18:28.443Z
中文译文更新时间：2026-11-07T23:37:13.254Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40berlitz/form-field
原文对照：https://npmcn.com/package/%40berlitz/form-field/?lang=original
项目主页：https://github.com/berlitz-global/max/blob/master/components/form-field/CHANGELOG.md

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

- 包体积（解压后）：30.4 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- peer 依赖：react 16\.13\.1，polished ^3\.4\.1，styled-components 5\.2\.3
- 首次发布：2018-09-21T02:37:36.562Z
- 最新版本发布：2025-04-21T02:43:19.080Z
- 近 30 天下载量：2035（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：176（近 12 个月 0 个）

## 中文简介

Max 设计系统的窗体字段组件

## 安装

```sh
npm install @berlitz/form-field
```

也可以使用：`pnpm add @berlitz/form-field`、`yarn add @berlitz/form-field`、`bun add @berlitz/form-field`

## README

# 表单字段 [![npm version](https://img.shields.io/npm/v/@berlitz/form-field.svg)](https://www.npmjs.com/package/@berlitz/form-field)

作为孩子使用 `<Form />`。它包装贝利茨形成场元素.

## 安装

```shell
yarn add @berlitz/form-field
```

## 道具

| 参数 | 类型 | 需求 | 默认 | 页:1 |
| --- | --- | --- | --- | --- |
| 儿童 | 节点 | ✅ |  | 窗体字段元素 |
| 隐藏标签 | 嘘 | ❌ | 虚假 | 隐藏与窗体元素相关的标签,但仍可供屏幕阅读器访问 |
| 禁用马金 | 嘘 | ❌ | 虚假 | 禁用组件下方的边距 |
| 无效 | 嘘 | ❌ | 虚假 | 表示元素的值是有效的 |
| 标签 | 字符串 | ✅ |  | 定义窗体字段的标签。 即使在标签被隐藏时也需要 |
| 所需经费 | 嘘 | ❌ | 虚假 | 按要求标记窗体字段 |
| 校验 | 字符串 | ❌ | '' | 提供与验证相关的帮助文本 |
| 校验磁盘 | 嘘 | ❌ | 虚假 | 将验证信件向左移动 |
| 光线 | 嘘 | ❌ | 虚假 | 将文字白白地显示为暗背景 |
| 编号 | 字符串 | ❌ | 生成短发 | 指定输入值的ID, 它是标签的 htmlFor |

## 使用量

```jsx
import FormField from '@berlitz/form-field'
;<Form>
  <FormField label="Fistname">
    <Input name="first-name" type="text" />
  </FormField>
</Form>
```

## 常见问题

### @berlitz/form-field 是什么？

Max 设计系统的窗体字段组件

### 如何安装 @berlitz/form-field？

在项目目录运行 npm install @berlitz/form-field，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（16\.13\.1）、polished（^3\.4\.1）、styled-components（5\.2\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @berlitz/form-field 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/berlitz\_\_form-field 是否存在。

### @berlitz/form-field 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @berlitz/form-field 可以商用吗？

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

### @berlitz/form-field 的下载量有多少？

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

### @berlitz/form-field 还在维护吗？

最新版本 5\.3\.3 发布于 2025/04/21（1\.5 年前）；至今共发布 176 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

