Enter a number within certain range with the mouse or keyboard.
When a numeric value needs to be provided.
Common props ref:Common props
Property | Description | Type | Default | Version |
---|---|---|---|---|
addonAfter | The label text displayed after (on the right side of) the input field | ReactNode | - | |
addonBefore | The label text displayed before (on the left side of) the input field | ReactNode | - | |
autoFocus | If get focus when component mounted | boolean | false | - |
bordered | Whether has border style | boolean | true | 4.12.0 |
controls | Whether to show +- controls, or set custom arrows icon | boolean | { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
decimalSeparator | Decimal separator | string | - | - |
defaultValue | The initial value | number | - | - |
disabled | If disable the input | boolean | false | - |
formatter | Specifies the format of the value presented | function(value: number | string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
keyboard | If enable keyboard behavior | boolean | true | 4.12.0 |
max | The max value | number | Number.MAX_SAFE_INTEGER | - |
min | The min value | number | Number.MIN_SAFE_INTEGER | - |
parser | Specifies the value extracted from formatter | function(string): number | - | - |
precision | The precision of input value. Will use formatter when config of formatter | number | - | - |
readOnly | If readonly the input | boolean | false | - |
status | Set validation status | 'error' | 'warning' | - | 4.19.0 |
prefix | The prefix icon for the Input | ReactNode | - | 4.17.0 |
size | The height of input box | large | middle | small | - | - |
step | The number to which the current value is increased or decreased. It can be an integer or decimal | number | string | 1 | - |
stringMode | Set value as string to support high precision decimals. Will return string value by onChange | boolean | false | 4.13.0 |
value | The current value | number | - | - |
onChange | The callback triggered when the value is changed | function(value: number | string | null) | - | - |
onPressEnter | The callback function that is triggered when Enter key is pressed | function(e) | - | - |
onStep | The callback function that is triggered when click up or down buttons | (value: number, info: { offset: number, type: 'up' | 'down' }) => void | - | 4.7.0 |
Name | Description |
---|---|
blur() | Remove focus |
focus() | Get focus |
Token Name | Description | Type | Default Value |
---|---|---|---|
activeBorderColor | Active border color | string | #4096ff |
activeShadow | Box-shadow when active | string | 0 0 0 2px rgba(5, 145, 255, 0.1) |
addonBg | Background color of addon | string | rgba(0, 0, 0, 0.02) |
controlWidth | Width of input | number | 90 |
errorActiveShadow | Box-shadow when active in error status | string | 0 0 0 2px rgba(255, 38, 5, 0.06) |
handleActiveBg | Active background color of handle | string | rgba(0, 0, 0, 0.02) |
handleBg | Background color of handle | string | #ffffff |
handleBorderColor | Border color of handle | string | #d9d9d9 |
handleFontSize | Icon size of control button | number | 7 |
handleHoverColor | Hover color of handle | string | #1677ff |
handleVisible | Handle visible | true | "auto" | auto |
handleWidth | Width of control button | number | 22 |
hoverBorderColor | Hover border color | string | #4096ff |
paddingBlock | Vertical padding of input | number | 4 |
paddingBlockLG | Vertical padding of large input | number | 7 |
paddingBlockSM | Vertical padding of small input | number | 0 |
paddingInline | Horizontal padding of input | number | 11 |
paddingInlineLG | Horizontal padding of large input | number | 11 |
paddingInlineSM | Horizontal padding of small input | number | 7 |
warningActiveShadow | Box-shadow when active in warning status | string | 0 0 0 2px rgba(255, 215, 5, 0.1) |
Per issues #21158, #17344, #9421, and documentation about inputs, it appears this community does not support native inclusion of the type="number"
in the <Input />
attributes, so please feel free to include it as needed, and be aware that it is heavily suggested that server side validation be utilized, as client side validation can be edited by power users.
value
can exceed min
or max
in control?Developer handle data by their own in control. It will make data out of sync if InputNumber change display value. It also cause potential data issues when use in form.
min
or max
which makes value
out of range will not trigger onChange
?onChange
is user trigger event. Auto trigger will makes form lib can not detect data modify source.
onBlur
or other event can not get correct value?InputNumber's value is wrapped by internal logic. The event.target.value
you get from onBlur
or other event is the DOM element's value
instead of the actual value of InputNumber. For example, if you change the display format through formatter
or decimalSeparator
, you will get the formatted string in the DOM. You should always get the current value through onChange
.