ant-design/components/input/index.zh-CN.md

74 lines
3.0 KiB
Markdown
Raw Normal View History

2016-05-25 18:21:27 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 输入框
type: Data Entry
2016-09-21 11:28:38 +08:00
title: Input
2016-05-25 18:21:27 +08:00
---
通过鼠标或键盘输入内容,是最基础的表单域的包装。
## 何时使用
- 需要用户输入表单域内容时。
- 提供组合型输入框,带搜索的输入框,还可以进行大小选择。
## API
### Input
2016-12-05 13:05:58 +08:00
| 参数 | 说明 | 类型 | 默认值 |
2017-10-24 17:31:12 +08:00
|-----------|-----------------------------------------|------------|-------|
2017-05-22 14:44:58 +08:00
| type | 声明 input 类型,同原生 input 标签的 type 属性。另外提供 `type="textarea"`(该 type `2.12` 后废弃,请直接使用 `Input.TextArea`)。 | string | `text` |
2016-12-05 13:05:58 +08:00
| 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 | |
2016-12-05 13:05:58 +08:00
| onPressEnter | 按下回车的回调 | function(e) | |
2016-05-25 18:21:27 +08:00
> 如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 和 `options` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
2017-01-09 22:03:10 +08:00
Input 的其他属性和 React 自带的 [input](https://facebook.github.io/react/docs/events.html#supported-events) 一致。
2017-05-22 14:44:58 +08:00
### Input.TextArea
> `2.12` 后新增的组件,旧版请使用 `Input[type=textarea]`。
| 参数 | 说明 | 类型 | 默认值 |
2017-10-24 17:31:12 +08:00
|-----------|-----------------------------------------|------------|-------|
2017-05-22 14:44:58 +08:00
| defaultValue | 输入框默认内容 | string | |
| value | 输入框内容 | string | |
| onPressEnter | 按下回车的回调 | function(e) | |
| autosize | 自适应内容高度,可设置为 `true|false` 或对象:`{ minRows: 2, maxRows: 6 }` | boolean\|object | false |
`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
#### Input.Search
2016-12-02 15:12:01 +08:00
`Added in 2.5.0`
2016-12-05 13:05:58 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------------------------------------|-----------|-------|
| onSearch | 点击搜索或按下回车键时的回调 | function(value) | |
2016-11-24 14:56:08 +08:00
其余属性和 Input 一致。
2016-05-25 18:21:27 +08:00
#### Input.Group
2016-12-05 13:05:58 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------------------------------------|-------------|-------|
| size | `Input.Group` 中所有的 `Input` 的大小,可选 `large` `default` `small` | string | `default` |
| compact | 是否用紧凑模式 | boolean | false |
2016-05-25 18:21:27 +08:00
```html
2016-12-05 13:05:58 +08:00
<Input.Group>
2016-05-25 18:21:27 +08:00
<Input />
<Input />
</Input.Group>
2016-06-03 15:00:01 +08:00
```