mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 05:28:20 +08:00
2.2 KiB
2.2 KiB
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. | React.Node | |
addonAfter | The label text displayed after (on the right side of) the input field. | React.Node | |
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 or object |
When
Input
is used in aForm.Item
context, if theForm.Item
has theid
andoptions
props defined thenvalue
,defaultValue
, andid
props are automatically set.
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 |
<Input.Group>
<Input />
<Input />
</Input.Group>