InputNumber数字输入框

通过鼠标或键盘，输入范围内的数值。

何时使用

当需要获取标准数值时。

代码演示

基本

数字输入框。

import { InputNumber } from 'antd';
function onChange(value) {
  console.log('changed', value);
}
ReactDOM.render(<InputNumber min={1} max={10} defaultValue={3} onChange={onChange} />, mountNode);

不可用

点击按钮切换可用状态。

import { InputNumber, Button } from 'antd';
class App extends React.Component {
  state = {
    disabled: true,
  };
  toggle = () => {
    this.setState({
      disabled: !this.state.disabled,
    });
  };
  render() {
    return (
      <>
        <InputNumber min={1} max={10} disabled={this.state.disabled} defaultValue={3} />
        <div style={{ marginTop: 20 }}>
          <Button onClick={this.toggle} type="primary">
            Toggle disabled
          </Button>
        </div>
      </>
    );
  }
}
ReactDOM.render(<App />, mountNode);

格式化展示

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

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

import { InputNumber } from 'antd';
function onChange(value) {
  console.log('changed', value);
}
ReactDOM.render(
  <>
    <InputNumber
      defaultValue={1000}
      formatter={value => `$ ${value}`.replace(/\B(?=(\d{3})+(?!\d))/g, ',')}
      parser={value => value.replace(/\$\s?|(,*)/g, '')}
      onChange={onChange}
    />
    <InputNumber
      defaultValue={100}
      min={0}
      max={100}
      formatter={value => `${value}%`}
      parser={value => value.replace('%', '')}
      onChange={onChange}
    />
  </>,
  mountNode,
);

无边框

没有边框。

import { InputNumber } from 'antd';
ReactDOM.render(<InputNumber min={1} max={10} defaultValue={3} bordered={false} />, mountNode);

三种大小

三种大小的数字输入框，当 size 分别为 large 和 small 时，输入框高度为 40px 和 24px ，默认高度为 32px。

import { InputNumber } from 'antd';
function onChange(value) {
  console.log('changed', value);
}
ReactDOM.render(
  <div className="site-input-number-wrapper">
    <InputNumber size="large" min={1} max={100000} defaultValue={3} onChange={onChange} />
    <InputNumber min={1} max={100000} defaultValue={3} onChange={onChange} />
    <InputNumber size="small" min={1} max={100000} defaultValue={3} onChange={onChange} />
  </div>,
  mountNode,
);

.code-box-demo .ant-input-number {
  margin-right: 10px;
}
.ant-row-rtl .code-box-demo .ant-input-number {
  margin-right: 0;
  margin-left: 10px;
}

高精度小数

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

TypeScript

JavaScript

import { InputNumber } from 'antd';
function onChange(value: string) {
  console.log('changed', value);
}
ReactDOM.render(
  <InputNumber<string>
    style={{ width: 200 }}
    defaultValue="1"
    min="0"
    max="10"
    step="0.00000000000001"
    onChange={onChange}
    stringMode
  />,
  mountNode,
);

键盘行为

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

TypeScript

JavaScript

import { InputNumber, Checkbox, Space } from 'antd';
const App = () => {
  const [keyboard, setKeyboard] = React.useState(true);
  return (
    <Space>
      <InputNumber min={1} max={10} keyboard={keyboard} defaultValue={3} />
      <Checkbox
        onChange={() => {
          setKeyboard(!keyboard);
        }}
        checked={keyboard}
      >
        Toggle keyboard
      </Checkbox>
    </Space>
  );
};
ReactDOM.render(<App />, mountNode);

超出边界

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

TypeScript

JavaScript

import { InputNumber, Button, Space } from 'antd';
const Demo = () => {
  const [value, setValue] = React.useState<string | number>('99');
  return (
    <Space>
      <InputNumber min={1} max={10} value={value} onChange={setValue} />
      <Button
        type="primary"
        onClick={() => {
          setValue(99);
        }}
      >
        Reset
      </Button>
    </Space>
  );
};
ReactDOM.render(<Demo />, mountNode);

API

属性如下

方法

FAQ

为何受控模式下，value 可以超出 min 和 max 范围？

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

为何动态修改 min 和 max 让 value 超出范围不会触发 onChange 事件？

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