InputNumber
数字输入框

通过鼠标或键盘,输入范围内的数值。
使用import{ InputNumber }from"antd";

何时使用

当需要获取标准数值时。

代码演示

数字输入框。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
+
$
+
$
cascader
+
+
¥

用于配置一些固定组合。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

通过 stringMode 开启高精度小数支持,onChange 事件将返回 string 类型。对于旧版浏览器,你需要 BigInt polyfill。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 keyboard 属性可以控制键盘行为。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

InputNumber 形态变体,可选 outlined filled borderless underlined 四种形态。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.13.0






RMB

在输入框上添加前缀或后缀图标。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

聚焦额外配置属性。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.22.0

三种大小的数字输入框,当 size 分别为 largesmall 时,输入框高度为 40px24px ,默认高度为 32px

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

点击按钮切换可用状态。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

通过 formatter 格式化数字,以展示具有具体含义的数据,往往需要配合 parser 一起使用。

这里有一个更复杂的货币格式化输入框:https://codesandbox.io/s/currency-wrapper-antd-input-3ynzo

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

启用鼠标滚轮控制。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
5.14.0

当通过受控将 value 超出边界时,提供警告样式。

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

使用 status 为 InputNumber 添加状态,可选 error 或者 warning

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

API

通用属性参考:通用属性

参数说明类型默认值版本
addonAfter带标签的 input,设置后置标签ReactNode-4.17.0
addonBefore带标签的 input,设置前置标签ReactNode-4.17.0
autoFocus自动获取焦点booleanfalse-
changeOnBlur是否在失去焦点时,触发 onChange 事件(例如值超出范围时,重新限制回范围并触发事件)booleantrue5.11.0
changeOnWheel允许鼠标滚轮改变数值boolean-5.14.0
controls是否显示增减按钮,也可设置自定义箭头图标boolean | { upIcon?: React.ReactNode; downIcon?: React.ReactNode; }-4.19.0
decimalSeparator小数点string--
placeholder占位符string-
defaultValue初始值number--
disabled禁用booleanfalse-
formatter指定输入框展示值的格式function(value: number | string, info: { userTyping: boolean, input: string }): string-info: 4.17.0
keyboard是否启用键盘快捷行为booleantrue4.12.0
max最大值numberNumber.MAX_SAFE_INTEGER-
min最小值numberNumber.MIN_SAFE_INTEGER-
parser指定从 formatter 里转换回数字的方式,和 formatter 搭配使用function(string): number--
precision数值精度,配置 formatter 时会以 formatter 为准number--
readOnly只读booleanfalse-
status设置校验状态'error' | 'warning'-4.19.0
prefix带有前缀图标的 inputReactNode-4.17.0
suffix带有后缀图标的 inputReactNode-5.20.0
size输入框大小large | middle | small--
step每次改变步数,可以为小数number | string1-
stringMode字符值模式,开启后支持高精度小数。同时 onChange 将返回 string 类型booleanfalse4.13.0
value当前值number--
variant形态变体outlined | borderless | filled | underlinedoutlined5.13.0 | underlined: 5.24.0
onChange变化回调function(value: number | string | null)--
onPressEnter按下回车的回调function(e)--
onStep点击上下箭头的回调(value: number, info: { offset: number, type: 'up' | 'down' }) => void-4.7.0

Ref

名称说明参数版本
blur()移除焦点-
focus()获取焦点(option?: { preventScroll?: boolean, cursor?: 'start' | 'end' | 'all' })cursor - 5.22.0
nativeElement获取原生 DOM 元素-5.17.3

主题变量(Design Token)

组件 Token如何定制?

Token 名称描述类型默认值
activeBg输入框激活状态时背景颜色string#ffffff
activeBorderColor激活态边框色string#1677ff
activeShadow激活态阴影string0 0 0 2px rgba(5,145,255,0.1)
addonBg前/后置标签背景色stringrgba(0,0,0,0.02)
controlWidth输入框宽度number90
errorActiveShadow错误状态时激活态阴影string0 0 0 2px rgba(255,38,5,0.06)
filledHandleBg面性变体操作按钮背景色string#f0f0f0
handleActiveBg操作按钮激活背景色stringrgba(0,0,0,0.02)
handleBg操作按钮背景色string#ffffff
handleBorderColor操作按钮边框颜色string#d9d9d9
handleFontSize操作按钮图标大小number7
handleHoverColor操作按钮悬浮颜色string#1677ff
handleVisible操作按钮可见性true | "auto"auto
handleWidth操作按钮宽度number22
hoverBg输入框hover状态时背景颜色string#ffffff
hoverBorderColor悬浮态边框色string#4096ff
inputFontSize字体大小number14
inputFontSizeLG大号字体大小number16
inputFontSizeSM小号字体大小number14
paddingBlock输入框纵向内边距number4
paddingBlockLG大号输入框纵向内边距number7
paddingBlockSM小号输入框纵向内边距number0
paddingInline输入框横向内边距number11
paddingInlineLG大号输入框横向内边距number11
paddingInlineSM小号输入框横向内边距number7
warningActiveShadow警告状态时激活态阴影string0 0 0 2px rgba(255,215,5,0.1)

全局 Token如何定制?

FAQ

为何受控模式下,value 可以超出 minmax 范围?

在受控模式下,开发者可能自行存储相关数据。如果组件将数据约束回范围内,会导致展示数据与实际存储数据不一致的情况。这使得一些如表单场景存在潜在的数据问题。

为何动态修改 minmaxvalue 超出范围不会触发 onChange 事件?

onChange 事件为用户触发事件,自行触发会导致表单库误以为变更来自用户操作。我们以错误样式展示超出范围的数值。

为何 onBlur 等事件获取不到正确的 value?

InputNumber 的值由内部逻辑封装而成,通过 onBlur 等事件获取的 event.target.value 仅为 DOM 元素的 value 而非 InputNumber 的实际值。例如通过 formatter 或者 decimalSeparator 更改展示格式,DOM 中得到的就是格式化后的字符串。你总是应该通过 onChange 获取当前值。

为何 changeOnWheel 无法控制鼠标滚轮是否改变数值?

不建议使用 type 属性

InputNumber 组件允许你使用 input 元素的所有属性最终透传至 input 元素,当你传入 type="number" 时 input 元素也会添加这个属性,这会使 input 元素触发原生特性(允许鼠标滚轮改变数值),从而导致 changeOnWheel 无法控制鼠标滚轮是否改变数值。