@chakra-ui/form-control

中文文档
2.2.0发布于 2023/11/09MITTypeScriptESM + CJS近 30 天下载 141.5万

反应组件以提供验证状态来组成字段

中文使用文档
文档目录8 节
  1. 安装
  2. 导入组件
  3. 基本用途
  4. 输入
  5. 带有复选框组
  6. 焦点、残疾和残疾国家
  7. 更改所需指标
  8. 添加视觉图标

@ chakra-ui/形式控制

窗体控制组件用于管理窗体控制此类输入字段, 复选框和无线电按钮。 它提供了让你 默认可访问的窗体字段.

  • 窗体控制 - 提供上下文的顶层组件.
  • 窗体标签 - 可见窗体控制标签.
  • 窗体帮助文本 - 窗体控件用于引导用户的辅助文本. 如果添加,则会隐藏在球场出错时.
  • 窗体错误 - 窗体控件的错误反馈。 如果有人帮忙 当控件无效时可见文本,它将替换帮助文本,改为 防止内容转移.
  • 窗体错误 - 显示色盲错误状态的图标 用户.

安装

yarn add @chakra-ui/form-control

# or

npm install @chakra-ui/form-control

导入组件

import {
  FormControl,
  FormLabel,
  FormErrorMessage,
  FormHelperText,
  FormErrorIcon,
} from "@chakra-ui/form-control"

基本用途

这个 FormControl 组件自动提供 id 用于输入 组件将完全无障碍.

输入

<FormControl>
  // automatically gets `htmlFor`
  <FormLabel>First name:</FormLabel>
  // automatically gets `id` and `aria-*` properties
  <Input placeholder="Enter your first name..." />
  // automatically gets `id` and hides if `isInvalid` is passed to `FormControl`
  <FormHelperText>Keep your first name short</FormHelperText>
  // automatically gets `id` and shows if `isInvalid` is passed to `FormControl`
  <FormErrorMessage>First name is invalid</FormErrorMessage>
</FormControl>

带有复选框组

<FormControl as="fieldset">
  <FormLabel as="legend">Who is better:</FormLabel>
  <CheckboxGroup>
    <Checkbox>Naruto</Checkbox>
    <Checkbox>Boruto</Checkbox>
  </CheckboxGroup>
  <FormErrorMessage>C'mon! You must select one</FormErrorMessage>
</FormControl>

焦点、残疾和残疾国家

  • 当 Input 部分接收焦点,通知 FormControl 财务报告和审定财务报表 添加 data-focus 编辑 FormLabel简单通过 _focus 页:1 FormLabel 以样式显示此状态.

  • 若为 isInvalid 传递到 FormControl它会通知 Input 财务报告和审定财务报表 添加 data-invalid 页:1 FormLabel 因此,你可以改变样式 标签.

  • 若为 isDisabled 传递到 FormControl,它让 Input 残疾, 添加 data-disabled 页:1 FormLabel 因此,你可以改变样式 标签.

更改所需指标

修改除以下各项之外的必要指标: FormLabel,简单通过 requiredIndicator 设置到您的自定义指标组件.

<FormControl as="fieldset">
  <FormLabel as="legend" requiredIndicator={CustomIndicator}>
    Who is better:
  </FormLabel>
  <CheckboxGroup>
    <Checkbox>Naruto</Checkbox>
    <Checkbox>Boruto</Checkbox>
  </CheckboxGroup>
  <FormErrorMessage>C'mon! You must select one</FormErrorMessage>
</FormControl>

添加视觉图标

<FormControl
  label="Tell us about yourself:"
  helpText="Keep it short and sweet!"
  errorText="C'mon! You must select one"
>
  <InputGroup>
    <Input paddingRight="32px" />
    <InputRightElement>
      <FormErrorIcon />
    </InputRightElement>
  </InputGroup>
</FormControl>

版本与发布记录

@chakra-ui/form-control 共发布 473 个版本,首次发布于 2020/06/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.2.0latest2023/11/092 年前
0.0.0-dev-20231109134954dev2023/11/092 年前
0.0.0-dev-202311091309492023/11/092 年前
0.0.0-dev-202311091255552023/11/092 年前
0.0.0-dev-202311091125242023/11/092 年前
2.1.12023/09/093 年前

其他发布通道:canary → 0.0.0-canary-2021118164051,pr → 0.0.0-pr-202212011232,next → 2.0.0-next.3,next-dev → 0.0.0-next-dev-202241614737,dev → 0.0.0-dev-20231109134954。

关于 @chakra-ui/form-control 的常见问题

@chakra-ui/form-control 是什么?

反应组件以提供验证状态来组成字段

如何安装 @chakra-ui/form-control?

在项目目录运行 npm install @chakra-ui/form-control,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18)、@chakra-ui/system(>=2.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@chakra-ui/form-control 支持 TypeScript 吗?

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

@chakra-ui/form-control 支持 ESM 还是 CommonJS?

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

@chakra-ui/form-control 可以商用吗?

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

@chakra-ui/form-control 的下载量有多少?

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

@chakra-ui/form-control 还在维护吗?

最新版本 2.2.0 发布于 2023/11/09(2 年前);至今共发布 473 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/06/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。