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

38 lines
1.3 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Entry
2016-09-08 16:53:50 +08:00
title: InputNumber
---
Enter a number within certain range with the mouse or keyboard.
2016-09-10 13:43:30 +08:00
## When To Use
When a numeric value needs to be provided.
## API
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| autoFocus | get focus when component mounted | boolean | false |
| defaultValue | initial value | number | |
| disabled | disable the input | boolean | false |
| formatter | Specifies the format of the value presented | function(value: number \| string): string | |
| max | max value | number | Infinity |
| min | min value | number | -Infinity |
| parser | Specifies the value extracted from formatter | function( string): number | |
| precision | precision of input value | number | |
| decimalSeparator | decimal separator | string | |
| size | height of input box | string | |
| step | The number to which the current value is increased or decreased. It can be an integer or decimal. | number\|string | 1 |
| value | current value | number | |
| onChange | The callback triggered when the value is changed. | function(value: number \| string) | |
| onPressEnter | The callback function that is triggered when Enter key is pressed. | function(e) | |
## Methods
| Name | Description |
| ------- | ------------ |
| blur() | remove focus |
| focus() | get focus |