InputNumber数字输入框

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

何时使用#

当需要获取标准数值时。

代码演示

数字输入框。

expand codeexpand code
import { InputNumber } from 'antd';
import React from 'react';

const onChange = (value: number) => {
  console.log('changed', value);
};

const App: React.FC = () => <InputNumber min={1} max={10} defaultValue={3} onChange={onChange} />;

export default App;
+
$
+
$
cascader

用于配置一些固定组合。

expand codeexpand code
import { SettingOutlined } from '@ant-design/icons';
import { Cascader, InputNumber, Select, Space } from 'antd';
import React from 'react';

const { Option } = Select;

const selectBefore = (
  <Select defaultValue="add" style={{ width: 60 }}>
    <Option value="add">+</Option>
    <Option value="minus">-</Option>
  </Select>
);
const selectAfter = (
  <Select defaultValue="USD" style={{ width: 60 }}>
    <Option value="USD">$</Option>
    <Option value="EUR"></Option>
    <Option value="GBP">£</Option>
    <Option value="CNY">¥</Option>
  </Select>
);

const App: React.FC = () => (
  <Space direction="vertical">
    <InputNumber addonBefore="+" addonAfter="$" defaultValue={100} />
    <InputNumber addonBefore={selectBefore} addonAfter={selectAfter} defaultValue={100} />
    <InputNumber addonAfter={<SettingOutlined />} defaultValue={100} />
    <InputNumber
      addonBefore={<Cascader placeholder="cascader" style={{ width: 150 }} />}
      defaultValue={100}
    />
  </Space>
);

export default App;

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

expand codeexpand code
import { InputNumber } from 'antd';
import React from 'react';

const onChange = (value: string) => {
  console.log('changed', value);
};

const App: React.FC = () => (
  <InputNumber<string>
    style={{ width: 200 }}
    defaultValue="1"
    min="0"
    max="10"
    step="0.00000000000001"
    onChange={onChange}
    stringMode
  />
);

export default App;

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

expand codeexpand code
import { Checkbox, InputNumber, Space } from 'antd';
import React, { useState } from 'react';

const App: React.FC = () => {
  const [keyboard, setKeyboard] = useState(true);

  return (
    <Space>
      <InputNumber min={1} max={10} keyboard={keyboard} defaultValue={3} />
      <Checkbox
        onChange={() => {
          setKeyboard(!keyboard);
        }}
        checked={keyboard}
      >
        Toggle keyboard
      </Checkbox>
    </Space>
  );
};

export default App;

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

expand codeexpand code
import { Button, InputNumber, Space } from 'antd';
import React, { useState } from 'react';

const App: React.FC = () => {
  const [value, setValue] = useState<string | number>('99');

  return (
    <Space>
      <InputNumber min={1} max={10} value={value} onChange={setValue} />
      <Button
        type="primary"
        onClick={() => {
          setValue(99);
        }}
      >
        Reset
      </Button>
    </Space>
  );
};

export default App;

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

expand codeexpand code
import ClockCircleOutlined from '@ant-design/icons/ClockCircleOutlined';
import { InputNumber, Space } from 'antd';
import React from 'react';

const App: React.FC = () => (
  <Space direction="vertical" style={{ width: '100%' }}>
    <InputNumber status="error" style={{ width: '100%' }} />
    <InputNumber status="warning" style={{ width: '100%' }} />
    <InputNumber status="error" style={{ width: '100%' }} prefix={<ClockCircleOutlined />} />
    <InputNumber status="warning" style={{ width: '100%' }} prefix={<ClockCircleOutlined />} />
  </Space>
);

export default App;
4.19.0

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

expand codeexpand code
import { InputNumber, Space } from 'antd';
import React from 'react';

const onChange = (value: number) => {
  console.log('changed', value);
};

const App: React.FC = () => (
  <Space>
    <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} />
  </Space>
);

export default App;

点击按钮切换可用状态。

expand codeexpand code
import { Button, InputNumber } from 'antd';
import React, { useState } from 'react';

const App: React.FC = () => {
  const [disabled, setDisabled] = useState(true);

  const toggle = () => {
    setDisabled(!disabled);
  };

  return (
    <>
      <InputNumber min={1} max={10} disabled={disabled} defaultValue={3} />
      <div style={{ marginTop: 20 }}>
        <Button onClick={toggle} type="primary">
          Toggle disabled
        </Button>
      </div>
    </>
  );
};

export default App;

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

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

expand codeexpand code
import { InputNumber, Space } from 'antd';
import React from 'react';

const onChange = (value: number | string) => {
  console.log('changed', value);
};

const App: React.FC = () => (
  <Space>
    <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}
    />
  </Space>
);

export default App;

没有边框。

expand codeexpand code
import { InputNumber } from 'antd';
import React from 'react';

const App: React.FC = () => <InputNumber min={1} max={10} defaultValue={3} bordered={false} />;

export default App;




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

expand codeexpand code
import { UserOutlined } from '@ant-design/icons';
import { InputNumber } from 'antd';
import React from 'react';

const App: React.FC = () => (
  <>
    <InputNumber prefix="" style={{ width: '100%' }} />
    <br />
    <br />
    <InputNumber addonBefore={<UserOutlined />} prefix="" style={{ width: '100%' }} />
    <br />
    <br />
    <InputNumber prefix="" disabled style={{ width: '100%' }} />
  </>
);

export default App;

API#

属性如下

成员说明类型默认值版本
addonAfter带标签的 input,设置后置标签ReactNode-4.17.0
addonBefore带标签的 input,设置前置标签ReactNode-4.17.0
autoFocus自动获取焦点booleanfalse-
bordered是否有边框booleantrue4.12.0
controls是否显示增减按钮,也可设置自定义箭头图标boolean | { upIcon?: React.ReactNode; downIcon?: React.ReactNode; }-4.19.0
decimalSeparator小数点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
size输入框大小large | middle | small--
step每次改变步数,可以为小数number | string1-
stringMode字符值模式,开启后支持高精度小数。同时 onChange 将返回 string 类型booleanfalse4.13.0
value当前值number--
onChange变化回调function(value: number | string | null)--
onPressEnter按下回车的回调function(e)--
onStep点击上下箭头的回调(value: number, info: { offset: number, type: 'up' | 'down' }) => void-4.7.0

方法#

名称描述
blur()移除焦点
focus()获取焦点

FAQ#

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

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

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

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