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

55 lines
2.3 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-06-10 16:46:57 +08:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-----------|-----------------------------------------|------------|-------|--------|
2016-06-03 15:00:01 +08:00
| type | 【必须】声明 input 类型,同原生 input 标签的 type 属性。另外提供 `type="textarea"`。 | string | | 'text' |
2016-05-25 18:21:27 +08:00
| id | id | number 或 string | | |
| value | value 值 | any | | |
| defaultValue | 设置初始默认值 | any | | |
| size | 控件大小,默认值为 default 。注:标准表单内的输入框大小限制为 large。 | string | {'large','default','small'} | 'default' |
| disabled | 是否禁用状态,默认为 false | bool | | false |
| addonBefore | 带标签的 input设置前置标签 | node | | |
| addonAfter | 带标签的 input设置后置标签 | node | | |
2016-06-10 16:46:57 +08:00
| onPressEnter | 按下回车的回调 | function(e) | | |
| autosize | 自适应内容高度,只对 `type="textarea"` 有效 | bool or object | `true` or `{ minRows: 2, maxRows: 6 }` | false |
2016-05-25 18:21:27 +08:00
> 如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 和 `options` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
#### Input.Search
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-----------|------------------------------------------|------------|-------|--------|
| defaultValue | 初始默认值 | any | | |
| value | value 值 | any | | |
| onChange | 值改变的回调 | function(e) | | |
| onSearch | 点击搜索或按下回车键时的回调 | function | | |
2016-05-25 18:21:27 +08:00
#### Input.Group
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|-----------|------------------------------------------|------------|-------|--------|
| size | `Input.Group` 中所有的 `Input` 的大小 | string | {'large','default','small'} | 'default' |
```html
<Input.Group className={string}>
<Input />
<Input />
</Input.Group>
2016-06-03 15:00:01 +08:00
```