mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 11:40:04 +08:00
Code Issues Actions 35 Packages Projects Releases Wiki Activity
c537030dee
ant-design/components/input/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636) 
* 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
2017-01-20 20:10:50 +08:00

2.5 KiB
Raw Blame History

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 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.

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>