mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
d44f404eae
* chore: improve sort api table scripts
* sort api
* add ignore
* Revert "sort api"
This reverts commit 343505d5f0.
* sort api
* Update package.json
* sort api
* Delete sort-api.js
* sort api
* sort api
* sort api
* fix
* Update index.zh-CN.md
* fix input-number
* fix input-number
* sort func
* fix
* Method moved to the end
* carousel method
45 lines
2.6 KiB
Markdown
45 lines
2.6 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Entry
|
|
title: InputNumber
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/XOS8qZ0kU/InputNumber.svg
|
|
---
|
|
|
|
Enter a number within certain range with the mouse or keyboard.
|
|
|
|
## When To Use
|
|
|
|
When a numeric value needs to be provided.
|
|
|
|
## API
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| autoFocus | If get focus when component mounted | boolean | false | - |
|
|
| 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): string | - | - |
|
|
| max | The max value | number | [Number.MAX_SAFE_INTEGER](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) | - |
|
|
| min | The min value | number | [Number.MIN_SAFE_INTEGER](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MIN_SAFE_INTEGER) | - |
|
|
| parser | Specifies the value extracted from formatter | function(string): number | - | - |
|
|
| precision | The precision of input value | number | - | - |
|
|
| readOnly | If readonly the input | boolean | false | - |
|
|
| 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 | - |
|
|
| value | The 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) | - | - |
|
|
| 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 |
|
|
|
|
## Methods
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| blur() | Remove focus |
|
|
| focus() | Get focus |
|
|
|
|
## Notes
|
|
|
|
Per issues [#21158](https://github.com/ant-design/ant-design/issues/21158), [#17344](https://github.com/ant-design/ant-design/issues/17344), [#9421](https://github.com/ant-design/ant-design/issues/9421), and [documentation about inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number#Using_number_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.
|