ant-design/components/input/index.zh-CN.md
偏右 dab6f43c02 Feat search enter button (#7620)
* Add enterButton for Input.Search

close #7596

* update snapshot
2017-09-15 17:03:43 +08:00

3.1 KiB
Raw Blame History

category subtitle type title
Components 输入框 Data Entry Input

通过鼠标或键盘输入内容,是最基础的表单域的包装。

何时使用

  • 需要用户输入表单域内容时。
  • 提供组合型输入框,带搜索的输入框,还可以进行大小选择。

API

Input

参数 说明 类型 默认值
type 声明 input 类型,同原生 input 标签的 type 属性。另外提供 type="textarea"(该 type 2.12 后废弃,请直接使用 Input.TextArea)。 string text
id 输入框的 id string
value 输入框内容 string
defaultValue 输入框默认内容 string
size 控件大小。注:标准表单内的输入框大小限制为 large。可选 large default small string default
disabled 是否禁用状态,默认为 false boolean false
addonBefore 带标签的 input设置前置标签 string|ReactNode
addonAfter 带标签的 input设置后置标签 string|ReactNode
prefix 带有前缀图标的 input string|ReactNode
suffix 带有后缀图标的 input string|ReactNode
onPressEnter 按下回车的回调 function(e)

如果 InputForm.Item 内,并且 Form.Item 设置了 idoptions 属性,则 value defaultValueid 属性会被自动设置。

Input 的其他属性和 React 自带的 input 一致。

Input.TextArea

2.12 后新增的组件,旧版请使用 Input[type=textarea]

参数 说明 类型 默认值
defaultValue 输入框默认内容 string
value 输入框内容 string
onPressEnter 按下回车的回调 function(e)
autosize 自适应内容高度,可设置为 `true false 或对象:{ minRows: 2, maxRows: 6 }` boolean|object false

Input.TextArea 的其他属性和浏览器自带的 textarea 一致。

Input.Search

参数 说明 类型 默认值
onSearch 点击搜索或按下回车键时的回调 function(value)
enterButton 是否有确认按钮,可设为按钮文字 boolean|ReactNode false

其余属性和 Input 一致。

Input.Group

参数 说明 类型 默认值
size Input.Group 中所有的 Input 的大小,可选 large default small string default
compact 是否用紧凑模式 boolean false
<Input.Group>
  <Input />
  <Input />
</Input.Group>