InputNumber数字输入框

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

何时使用#

当需要获取标准数值时。

代码演示

数字输入框。

import { InputNumber } from 'sld';

function onChange(value) {
  console.log('changed', value);
}

ReactDOM.render(<InputNumber min={1} max={10} defaultValue={3} onChange={onChange} />, mountNode);

cascader

前置/后置标签

用于配置一些固定组合。

import { InputNumber, Select, Space, Cascader } from 'sld';
import { SettingOutlined } from '@sld-icon/icons';

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>
);

ReactDOM.render(
  <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>,
  mountNode,
);

高精度小数

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

TypeScript
JavaScript
import { InputNumber } from 'sld';

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,
);

Toggle keyboard

键盘行为

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

TypeScript
JavaScript
import { InputNumber, Checkbox, Space } from 'sld';

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 'sld';

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);

自定义状态

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

TypeScript
JavaScript
import { InputNumber, Space } from 'sld';
import ClockCircleOutlined from '@sld-icon/icons/ClockCircleOutlined';

const ValidateInputs: 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>
);

ReactDOM.render(<ValidateInputs />, mountNode);

4.19.0

三种大小

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

import { InputNumber, Space } from 'sld';

function onChange(value) {
  console.log('changed', value);
}

ReactDOM.render(
  <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>,
  mountNode,
);

不可用

点击按钮切换可用状态。

import { InputNumber, Button } from 'sld';

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 一起使用。

import { InputNumber, Space } from 'sld';

function onChange(value) {
  console.log('changed', value);
}

ReactDOM.render(
  <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>,
  mountNode,
);

无边框

没有边框。

import { InputNumber } from 'sld';

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

￥

前缀

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

import { InputNumber } from 'sld';
import { InfoCircleOutlined, SmileOutlined, UserOutlined } from '@sld-icon/icons';

ReactDOM.render(
  <>
    <InputNumber prefix="￥" style={{ width: '100%' }} />
    <br />
    <br />
    <InputNumber addonBefore={<UserOutlined />} prefix="￥" style={{ width: '100%' }} />
    <br />
    <br />
    <InputNumber prefix="￥" disabled style={{ width: '100%' }} />
  </>,
  mountNode,
);

API#

属性如下

成员	说明	类型	默认值	版本
addonAfter	带标签的 input，设置后置标签	ReactNode	-	-
addonBefore	带标签的 input，设置前置标签	ReactNode	-	-
autoFocus	自动获取焦点	boolean	false	-
bordered	是否有边框	boolean	true	-
controls	是否显示增减按钮，也可设置自定义箭头图标	boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; }	-	-
decimalSeparator	小数点	string	-	-
defaultValue	初始值	number	-	-
disabled	禁用	boolean	false	-
formatter	指定输入框展示值的格式	function(value: number \| string, info: { userTyping: boolean, input: string }): string	-	info: -
keyboard	是否启用键盘快捷行为	boolean	true	-
max	最大值	number	Number.MAX_SAFE_INTEGER	-
min	最小值	number	Number.MIN_SAFE_INTEGER	-
parser	指定从 `formatter` 里转换回数字的方式，和 `formatter` 搭配使用	function(string): number	-	-
precision	数值精度，配置 `formatter` 时会以 `formatter` 为准	number	-	-
readOnly	只读	boolean	false	-
status	设置校验状态	'error' \| 'warning'	-	-
prefix	带有前缀图标的 input	ReactNode	-	-
size	输入框大小	`large` \| `middle` \| `small`	-	-
step	每次改变步数，可以为小数	number \| string	1	-
stringMode	字符值模式，开启后支持高精度小数。同时 `onChange` 将返回 string 类型	boolean	false	-
value	当前值	number	-	-
onChange	变化回调	function(value: number \| string \| null)	-	-
onPressEnter	按下回车的回调	function(e)	-	-
onStep	点击上下箭头的回调	(value: number, info: { offset: number, type: 'up' \| 'down' }) => void	-	-

方法#

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

FAQ#

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

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

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

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

基本
三种大小
前置/后置标签
不可用
高精度小数
格式化展示
键盘行为
无边框
超出边界
前缀
自定义状态
API