跳至正文
组件

Bar Field方条文本框

方条系列基础文本框,支持标签、图标、后缀和错误提示。

正在加载…

安装

pnpm dlx shadcn@latest add https://yiui.dev/r/bar-field.json
会连带安装 shadcn 组件 button。已存在的文件会询问是否覆盖。

用法

import { BarField } from "@/components/ui/bar-field/bar-field"

;<BarField label="名称" name="name" />

它是方条系列的基础文本框。普通文本、搜索、密码和验证码使用它;需要手机号格式整理或证件号校验时,使用 phone-input、id-number-input。suffix 支持单位和密码切换按钮;footerAction 用于忘记密码等操作。type="search" 时有内容就显示清除键(与方条下拉的清除键同一档,替代浏览器自带的蓝色清除钮),其他类型可用 clearable 打开;清除只触发 onValueChange(""),并把焦点留在输入框里。无标签时必须提供 aria-label 或 aria-labelledby,placeholder 不能代替名称。

放进网格工具栏

放进网格工具栏时会自动去掉外框、圆角和底色,铺满整格,焦点环画在格子内侧;单独使用时不受影响。

示例

尺寸与状态

正在加载…

后缀

正在加载…

API

导出 BarFieldProps 类型。根元素的 data-slot 为 bar-field。

可访问性

字段通过 label 关联输入框,error 和 description 用 aria-describedby 关联。支持 name、form 和原生输入属性;非受控表单重置恢复 defaultValue。窄容器标签移到条上方。文字输入聚焦使用加深边框,后缀按钮用键盘聚焦环。

源码