mirror of
https://github.com/wahyd4/ant-design.git
synced 2026-08-09 04:46:52 +10:00
Wei ZhuandGitHub
77b78a9389
* Unify name of ReactNode type in document * Lowser all string type name * Lowercase all number type name * Lowercase all boolean type name * Unify array type * Lowercase all object type name * Unify mutilple types
2.5 KiB
2.5 KiB
category, type, title
| category | type | title |
|---|---|---|
| Components | Data Entry | Input |
A basic widget for getting the user input is a text field. Keyboard and mouse can be used for providing or changing data.
When To Use
- A user input in a form field is needed.
- A search input is required.
API
Input
| 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. | string|ReactNode | |
| addonAfter | The label text displayed after (on the right side of) the input field. | string|ReactNode | |
| prefix | The Input with prefix icon. | string|ReactNode | |
| suffix | The Input with suffix icon. | string|ReactNode | |
| 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 | falseor a object{ minRows: 2, maxRows: 6 }` |
boolean|object |
When
Inputis used in aForm.Itemcontext, if theForm.Itemhas theidandoptionsprops defined thenvalue,defaultValue, andidprops are automatically set.
The rest props fo Input is exactly same as original input.
Input.Search
Added in 2.5.0
| Property | Description | Type | Default |
|---|---|---|---|
| onSearch | The callback function that is triggered when you click on the search-icon or press Enter key. | function(value) |
Support all props of Input.
Input.Group
| 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 |
<Input.Group>
<Input />
<Input />
</Input.Group>