ant-design/components/input/index.en-US.md

61 lines
2.4 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Entry
2016-09-08 16:53:50 +08:00
title: Input
---
A basic widget for getting the user input is a text field.
Keyboard and mouse can be used for providing or changing data.
2016-09-10 13:43:30 +08:00
## When To Use
- A user input in a form field is needed.
- A search input is required.
## API
### Input
2016-12-05 13:05:58 +08:00
| Property | Description | Type | Default |
|----------------|-----------------------|----------|---------------|
| type | The type of input, `text` or `textarea` | string | `text` |
| id | The ID for input | string | |
| value | The input content value | string | |
| defaultValue | The initial input content | string | |
| size | The size of the input box. Note: in the context of a form, the `large` size is used. Available: `large` `default` `small` | string | `default` |
| disabled | Tell if the input is disabled. | boolean | false |
| addonBefore | The label text displayed before (on the left side of) the input field. | React.Node | |
| addonAfter | The label text displayed after (on the right side of) the input field. | React.Node | |
| prefix | The Input with prefix icon. | React.Node | |
| suffix | The Input with suffix icon. | React.Node | |
2016-12-05 13:05:58 +08:00
| onPressEnter | The callback function that is triggered when pressing Enter key. | function(e) | |
| autosize | Height autosize feature, available when type="textarea", can be set to `true|false` or a object `{ minRows: 2, maxRows: 6 }` | boolean or object | false |
2016-11-24 14:56:08 +08:00
> When `Input` is used in a `Form.Item` context, if the `Form.Item` has the `id` and `options` props defined
then `value`, `defaultValue`, and `id` props are automatically set.
#### Input.Search
2016-12-02 15:12:01 +08:00
`Added in 2.5.0`
2016-12-05 13:05:58 +08:00
| Property | Description | Type | Default |
|-----------|--------------------------------------|------------|---------|
| onSearch | The callback function that is triggered when you click on the search-icon or press Enter key. | function(value) | |
2016-11-24 14:56:08 +08:00
Support all props of `Input`.
#### Input.Group
2016-12-05 13:05:58 +08:00
| Property | Description | Type | Default |
|-----------|----------------------------------|--------|-----------|
| size | The size of `Input.Group` specifies the size of the included `Input` fields. Available: `large` `default` `small` | string | `default` |
| compact | whether use compact style | boolean | false |
```html
2016-12-05 13:05:58 +08:00
<Input.Group>
<Input />
<Input />
</Input.Group>
```