@berlitz/form-field

中文文档
5.3.3发布于 2025/04/21MITCommonJS近 30 天下载 2035

FormField component for the Max Design System

原始使用文档
文档目录3 节
  1. Installation
  2. Props
  3. Usage

FormField npm version

Use as a child of <Form />. It wraps berlitz form field elements.

Installation

yarn add @berlitz/form-field

Props

ArgumentTypeRequiredDefaultNotes
childrennode✅Form field element
hideLabelbool❌falseHides the label associated with the form element but is still accessible to screen readers
disableMarginbool❌falseDisables margin below component
invalidbool❌falseIndicates that the value of the element is valid
labelstring✅Defines the label for the form field. Required even when the label is hidden
requiredbool❌falseMarks the form field as required
validationMessagestring❌''Provides help text associated with validation
validationMessageLeftbool❌falseMoves validation message to left
lightbool❌falseRenders text in white for dark background
idstring❌generated shortidSpecify ID for the input value and it's label's htmlFor

Usage

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

版本与发布记录

@berlitz/form-field 共发布 176 个版本,首次发布于 2018/09/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.3.3latest2025/04/211.5 年前
5.3.22025/04/171.6 年前
5.3.12025/04/161.6 年前
5.3.02025/04/161.6 年前
5.2.7-test.25canary2022/01/244 年前
5.2.62021/09/205 年前

关于 @berlitz/form-field 的常见问题

@berlitz/form-field 是什么?

FormField component for the Max Design System

如何安装 @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 和提交记录判断。