2018-03-20 11:06:04 +00:00
## API
### Input
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-03-20 11:06:04 +00:00
| addonAfter | The label text displayed after (on the right side of) the input field. | string\|slot | |
| addonBefore | The label text displayed before (on the left side of) the input field. | string\|slot | |
| defaultValue | The initial input content | string | |
| disabled | Whether the input is disabled. | boolean | false |
| id | The ID for input | string | |
| prefix | The prefix icon for the Input. | string\|slot | |
| 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` |
| suffix | The suffix icon for the Input. | string\|slot | |
| type | The type of input, see: [MDN ](https://developer.mozilla.org/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types )(use `Input.TextArea` instead of `type="textarea"` ) | string | `text` |
| value(v-model) | The input content value | string | |
2019-09-28 12:45:07 +00:00
| allowClear | allow to remove input content with clear icon | boolean | |
2018-03-20 11:06:04 +00:00
### Input Events
2019-09-28 12:45:07 +00:00
| Events Name | Description | Arguments |
| ----------- | ------------------------------------------------------------------ | ----------- |
| change | callback when user input | function(e) | |
| pressEnter | The callback function that is triggered when Enter key is pressed. | function(e) |
2018-03-20 11:06:04 +00:00
2019-09-28 12:45:07 +00: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 of `Input` are automatically set.
2018-03-20 11:06:04 +00:00
2019-09-28 12:45:07 +00:00
### Input.TextArea
2018-03-20 11:06:04 +00:00
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-03-20 11:06:04 +00:00
| autosize | Height autosize feature, can be set to `true|false` or an object `{ minRows: 2, maxRows: 6 }` | boolean\|object | false |
| defaultValue | The initial input content | string | |
| value(v-model) | The input content value | string | |
### Input.TextArea Events
2019-09-28 12:45:07 +00:00
| Events Name | Description | Arguments |
| ----------- | ------------------------------------------------------------------ | ----------- |
| pressEnter | The callback function that is triggered when Enter key is pressed. | function(e) |
2018-03-20 11:06:04 +00:00
The rest of the props of `Input.TextArea` are the same as the original [textarea ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea ).
#### Input.Search
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2019-04-07 09:19:18 +00:00
| enterButton | to show an enter button after input. This prop is conflict with addon. | boolean\|slot | false |
2018-03-20 11:06:04 +00:00
### Input.Search Events
2019-09-28 12:45:07 +00:00
2018-03-20 11:06:04 +00:00
| Events Name | Description | Arguments |
| --- | --- | --- |
2018-09-05 13:28:54 +00:00
| search | The callback function that is triggered when you click on the search-icon or press Enter key. | function(value, event) |
2018-03-20 11:06:04 +00:00
Supports all props of `Input` .
#### Input.Group
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-03-20 11:06:04 +00:00
| compact | Whether use compact style | boolean | false |
| size | The size of `Input.Group` specifies the size of the included `Input` fields. Available: `large` `default` `small` | string | `default` |
2019-09-28 12:45:07 +00:00
```html
2018-03-20 11:06:04 +00:00
< a-input-group >
< a-input / >
< a-input / >
< / a-input-group >
2019-09-28 12:45:07 +00:00
```
2019-09-11 10:11:48 +00:00
#### Input.Password (Added in 1.14.0)
2019-04-07 09:19:18 +00:00
2019-09-28 12:45:07 +00:00
| Property | Description | Type | Default |
| ---------------- | -------------------------- | ------- | ------- |
| visibilityToggle | Whether show toggle button | boolean | true |