React 带千分位分隔符数字输入框的实现-唐霜

在很多业务场景中，产品要求我们实现一个交本文作者：唐霜，转载请注明出处。【版权所有】唐霜 www.tangshuang.net互：用户输入数字时，将数字按千分位分隔。【版权所有，侵权必究】【本文首发于唐霜的博客】一般我们会采用,作为分隔符，例如 100,000,000，但是react或者说web没有原生的方转载请注明出处：www.tangshuang.net本文作者：唐霜，转载请注明出处。法实现这个效果，因此，我们必须自己实现这【版权所有，侵权必究】【原创不易，请尊重版权】一需求。

【访问 www.tangshuang.n【本文受版权保护】本文作者：唐霜，转载请注明出处。et 获取更多精彩内容】【本文受版权保护】【未经授权禁止转载】

我接到需求之后，去市面上找了一圈儿，以a未经授权，禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】ntd的rc-input-number为本文作者：唐霜，转载请注明出处。未经授权，禁止复制转载。例，核心代码相对比较少一些，功能覆盖了我著作权归作者所有，禁止商业用途转载。【作者：唐霜】的需求，但是很可惜，在某些处理细节上没有本文作者：唐霜，转载请注明出处。未经授权，禁止复制转载。覆盖全（例如在逗号后面删除）。而外网搜索【原创不易，请尊重版权】【原创不易，请尊重版权】得到的一个被多次提及的组件input-n【原创不易，请尊重版权】本文版权归作者所有，未经授权不得转载。umber-format，则功能太过复杂原创内容，盗版必究。【版权所有】唐霜 www.tangshuang.net，代码量巨大，超出了我的承受能力。我最终【作者：唐霜】本文版权归作者所有，未经授权不得转载。决定自己实现一个组件，目标是以最少的代码【转载请注明来源】本文作者：唐霜，转载请注明出处。量，直接了当的（不考虑其他场景下的通用性【版权所有】唐霜 www.tangshuang.net【版权所有，侵权必究】）实现需求。

接下来，我就简单的阐述我的实现过程。

接口设计

原创内容，盗版必究。未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】

<InputNumber 
  value={value}
  onChange={e => setValue(e.target.value)}
  placeholder="请输入数字"
  max={100}
  min={0}
  inputRef={el}
/>

完成开发之后，我发现input[type【关注微信公众号：wwwtangshuangnet】转载请注明出处：www.tangshuang.net=number]支持step属性，但是如【本文受版权保护】【本文首发于唐霜的博客】果需要支持微调功能，就必须自己再模拟两个【本文受版权保护】【原创不易，请尊重版权】按钮，导致复杂html结构。所以，最终我【版权所有】唐霜 www.tangshuang.net转载请注明出处：www.tangshuang.net只能放弃支持step属性。inputRe【本文首发于唐霜的博客】本文版权归作者所有，未经授权不得转载。f则是代替原来的ref属性，因为reac原创内容，盗版必究。【转载请注明来源】t会默认把ref绑定到组件上，所以只能找本文作者：唐霜，转载请注明出处。【本文首发于唐霜的博客】替代方案。还有一个点，由于格式化数据输入【原创内容，转载请注明出处】转载请注明出处：www.tangshuang.net框是使用input[type=text]著作权归作者所有，禁止商业用途转载。未经授权，禁止复制转载。模拟的，因此，在手机上，无法直接唤起数字著作权归作者所有，禁止商业用途转载。【作者：唐霜】键盘，也是一大损失。

数字的格式化

用户在输入的过程中，需要实时的将数字按千【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有，禁止商业用途转载。分位分隔符进行格式化。如果你用过antd【未经授权禁止转载】【版权所有，侵权必究】的组件，它会要求你传入一个formatt【访问 www.tangshuang.net 获取更多精彩内容】未经授权，禁止复制转载。er和parser来决定怎么做格式化，以【关注微信公众号：wwwtangshuangnet】著作权归作者所有，禁止商业用途转载。及接收值之前怎么处理。我为了减少代码，就原创内容，盗版必究。【转载请注明来源】写死用,进行分隔。效果如下：

【原创不易，请尊重版权】未经授权，禁止复制转载。

你可以看到，在第一次输入时，它会自动格式【未经授权禁止转载】【原创不易，请尊重版权】化。同时支持删除时格式化。

未经授权，禁止复制转载。【作者：唐霜】【本文首发于唐霜的博客】

function num2str(num) {
  // 完成数字到字符串格式化
}

function str2num(str) {
  // 将格式化后的字符串转化为数字
}

function InputNumber(props) {
  const { value, onChange } = props

  const handleChange = (e) => {
    const num = str2num(e.target.value)
    onChange(num)
  }

  const str = num2str(value)
  return <input value={str} onChange={handleChange} />
}

但这样会有一个问题，就是我们的onCha【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.netnge属性，只能直接接收数字，而无法接受【转载请注明来源】转载请注明出处：www.tangshuang.nete。于是我做了一个特殊处理，通过Prox【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。y代理e，让外部在读取e.target.【访问 www.tangshuang.net 获取更多精彩内容】【原创不易，请尊重版权】value时，读到的是反转为数字的值。

【本文首发于唐霜的博客】【本文受版权保护】

const responseChange = (e, num) => {
  const event = new Proxy(e, {
    get(_, key) {
      const value = _[key]
      if (key === 'target') {
        return new Proxy(value, {
          get(_, key) {
            const value = _[key]
            if (key === 'value') {
              return num
            }
            else {
              return typeof value === 'function' ? value.bind(_) : value
            }
          },
        })
      }
      else {
        return typeof value === 'function' ? value.bind(_) : value
      }
    },
  })
  onChange(event)
}

然后再替换handleChange为：

const handleChange = (e) => {
  const num = str2num(e.target.value)
  responseChange(e, num)
}

这样就解决了外部读取e.target.v【本文受版权保护】未经授权，禁止复制转载。alue时，读取真正需要的数据的问题。

非受控

【关注微信公众号：wwwtangshua【访问 www.tangshuang.net 获取更多精彩内容】【本文首发于唐霜的博客】ngnet】【转载请注明来源】

<InputNumber defaultValue={30} min={0} max={100} />

【本文首发于唐霜的博客】【原创不易，请尊重版权】【关注微信公众号：wwwtangshua著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】ngnet】【原创不易，请尊重版权】

function InputNumber(props) {
  const { defaultValue, value, onChange } = props
  const isControlled = 'value' in props

  const [text, setText] = useState(() => !isControlled ? num2str(defaultValue) : '')

  useEffect(() => {
    if (isControlled) {
      const next = num2str(value)
      setText(next)
    }
  }, [value])

  const handleChange = (e) {
    ...
    if (onChange) {
      responseChange(e, num)
    }
    if (!isControlled) {
      setText(e.target.value)
    }
  }

  return <input value={text} onChange={handleChange} />
}

转载请注明出处：www.tangshua【未经授权禁止转载】本文版权归作者所有，未经授权不得转载。ng.net未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。本文作者：唐霜，转载请注明出处。

光标位置

当用户在数字串中间进行输入时，如果不做处【原创内容，转载请注明出处】本文作者：唐霜，转载请注明出处。理，react受控组件会直接将光标放在末【版权所有，侵权必究】【本文受版权保护】尾，这是我们不希望看到的。我们希望在编辑著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net过程中，光标位置能准确放在我们需要输入的转载请注明出处：www.tangshuang.net未经授权，禁止复制转载。地方。

【访问 www.tangshuang.n【本文受版权保护】未经授权，禁止复制转载。et 获取更多精彩内容】转载请注明出处：www.tangshua著作权归作者所有，禁止商业用途转载。【本文受版权保护】ng.net【原创不易，请尊重版权】【关注微信公众号：wwwtangshua著作权归作者所有，禁止商业用途转载。本文作者：唐霜，转载请注明出处。ngnet】

看上去很简单，实际上却很复杂，首先，我们【未经授权禁止转载】著作权归作者所有，禁止商业用途转载。需要获取input DOM元素，对DOM著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net进行光标操作。光标位置不是永远只前进一格未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。，当格式化过程中多出一个,时，光标前进两格，当删除过程中少了一个,时，光标倒退两格。而由于react的垃圾【未经授权禁止转载】未经授权，禁止复制转载。处理，我们必须自己计算修改后光标的位置（【原创不易，请尊重版权】原创内容，盗版必究。即使不存在多出或少掉一个,的情况下，光标的位置都需要我们自己计算，【未经授权禁止转载】本文版权归作者所有，未经授权不得转载。因为react总会让受控组件的光标放到末【关注微信公众号：wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net尾）。

const { selectionStart: cursor } = e.target
const resetCurr = () => {
  // 输入英文字符等，react会主动把光标移动到最后，因此，这里要做一个主动回调
  requestAnimationFrame(() => {
    el.current.setSelectionRange(cursor - 1, cursor - 1) // -1 是因为我们不需要这个被输入的英文
  })
}

由于react在处理受控组件时，是异步处未经授权，禁止复制转载。未经授权，禁止复制转载。理（react的scheduler），所【版权所有，侵权必究】原创内容，盗版必究。以，我在这里使用了requestAnim【原创不易，请尊重版权】本文版权归作者所有，未经授权不得转载。ationFrame来延后设定光标位置（本文版权归作者所有，未经授权不得转载。【本文首发于唐霜的博客】但是，这是不保险的，我们不能绝对保证re本文版权归作者所有，未经授权不得转载。【访问 www.tangshuang.net 获取更多精彩内容】act内部的处理在一帧内完成）。这样，当【版权所有，侵权必究】【访问 www.tangshuang.net 获取更多精彩内容】react把光标移动到末尾之后，我又把光原创内容，盗版必究。【原创内容，转载请注明出处】标移动了回来。

基于同样的原理，我们需要计算每次值被修改本文版权归作者所有，未经授权不得转载。【本文首发于唐霜的博客】前和修改后的一些信息，从而得到输入完成时原创内容，盗版必究。原创内容，盗版必究。，光标应该放在哪个位置。

【本文受版权保护】【未经授权禁止转载】【作者：唐霜】

const focused = useRef()

const handleChange = (e) => {
  focused.current = [e.target.value, e.target.selectionStart]
}

// 定位光标位置
useLayoutEffect(() => {
  if (!focused.current) {
    return
  }

  const [prevText, cursor] = focused.current

  const prevCommaCount = prevText.split(',').length - 1
  const currentCommaCount = text.split(',').length - 1
  const offset = currentCommaCount - prevCommaCount
  const curr = cursor + offset
  const pos = curr < 0 ? 0 : curr

  el.current.setSelectionRange(pos, pos)
}, [text])

第二段代码就考虑到了当改变值后，是否会多【关注微信公众号：wwwtangshuangnet】原创内容，盗版必究。出或少掉一个,。基于useEffect的特性，我可以很【转载请注明来源】原创内容，盗版必究。好的处理这个逻辑，useEffect具有本文作者：唐霜，转载请注明出处。【转载请注明来源】watch的效果，这一点确实让hooks【未经授权禁止转载】【未经授权禁止转载】让人着迷。

【未经授权禁止转载】著作权归作者所有，禁止商业用途转载。

总之，经过一些记录、监听、比较，我可以准【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有，禁止商业用途转载。确的定位光标了。但是，由于我使用了ref未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。，那么，我的这个组件，就无法实现跨端（R本文版权归作者所有，未经授权不得转载。【本文受版权保护】N）使用了。这也是一个不可避免的问题，不本文版权归作者所有，未经授权不得转载。【版权所有，侵权必究】过暂且不考虑这么深远吧。

小数点

小数点看上去简单的不行，实际上是一个巨大【关注微信公众号：wwwtangshuangnet】【版权所有，侵权必究】的难点。由于当我们输入小数点时，实际的表转载请注明出处：www.tangshuang.net原创内容，盗版必究。达值，是相同的，这会使得我们经过格式化后原创内容，盗版必究。著作权归作者所有，禁止商业用途转载。，丢掉小数点。例如 1,234. 和 1,234 的实际值都是 1234，这就会导致我们的格式化函数num2st【本文受版权保护】著作权归作者所有，禁止商业用途转载。r格式化之后只能得到 1,234 而无法得到 1,234. 这就是一件极其麻烦的事。这该怎么办呢？

这时，需要写一段特殊逻辑来覆盖这种情况。【原创不易，请尊重版权】【本文受版权保护】由于我们实际渲染的结果，是状态值text【本文首发于唐霜的博客】本文版权归作者所有，未经授权不得转载。，那么，即使在受控组件情况下，我们也可以【本文受版权保护】【版权所有】唐霜 www.tangshuang.net不通过修改value而直接更新界面。所以【本文受版权保护】本文作者：唐霜，转载请注明出处。，当我们发现末尾是小数点的时候，直接不要本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。调onChange就好了，直接setTe本文作者：唐霜，转载请注明出处。【本文受版权保护】xt来修改界面。

【关注微信公众号：wwwtangshua【作者：唐霜】【原创内容，转载请注明出处】ngnet】【未经授权禁止转载】

if (text === next + '.') { // 删除了一个小数点
  setText(next)
}
else if (next[next.length - 1] === '.' && cursor === next.length) { // 在末尾处理时，处理后末尾为小数点
  setText(next)
}

也就意味着，实际上，即使是受控组件，In【原创不易，请尊重版权】未经授权，禁止复制转载。putNumber组件也有自己的内部临时著作权归作者所有，禁止商业用途转载。【作者：唐霜】态，而这个临时态外部无法直接读取（可通过【版权所有，侵权必究】【本文首发于唐霜的博客】inputRef读取）。这就是设计巧妙的【关注微信公众号：wwwtangshuangnet】【访问 www.tangshuang.net 获取更多精彩内容】地方，我们一般认为一个输入框受控时，va【原创内容，转载请注明出处】【原创不易，请尊重版权】lue是什么，内部展示的才是什么，而万万转载请注明出处：www.tangshuang.net【版权所有】唐霜 www.tangshuang.net没想到，某些情况下，内部展示的可以不一样【版权所有，侵权必究】【未经授权禁止转载】，但是对应相同的一个value。

【作者：唐霜】著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】

本文版权归作者所有，未经授权不得转载。【关注微信公众号：wwwtangshua未经授权，禁止复制转载。转载请注明出处：www.tangshuang.netngnet】

而且，我对小数点后面的值进行了处理。一般未经授权，禁止复制转载。未经授权，禁止复制转载。来说，我们在整数部分千分位分隔符是从个位未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。到十位方向，而小数部分则相反，从0.1往著作权归作者所有，禁止商业用途转载。【版权所有，侵权必究】0.01方向分隔。输入小数点本身，和格式【转载请注明来源】转载请注明出处：www.tangshuang.net化逻辑有冲突，因此，必须做特殊处理。还有原创内容，盗版必究。【作者：唐霜】一个点，即用户可能在一串已经有小数点的数【转载请注明来源】转载请注明出处：www.tangshuang.net字中间，再次输入小数点，这种情况下，我的著作权归作者所有，禁止商业用途转载。【作者：唐霜】处理方式是，把小数点迁移到用户当前输入的【未经授权禁止转载】【版权所有，侵权必究】位置，这种设计我认为是用户体验友好的。最本文作者：唐霜，转载请注明出处。【本文受版权保护】后，当用户在输入框中，只输入了一个.之后，他实际上将获得 0. 而非 . 本身，因此也做了替换（包含用户输入 -.）。

【作者：唐霜】【作者：唐霜】

0 & 00

当输入的数字实际代表的值为0时，或者当输【转载请注明来源】本文作者：唐霜，转载请注明出处。入的小数末尾为0时，都和格式化逻辑有冲突【未经授权禁止转载】【转载请注明来源】。格式化过程中，会将小数末尾的00去掉，转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。这就导致我们无法输入.01小数。同时，由【未经授权禁止转载】本文版权归作者所有，未经授权不得转载。于-0实际为0，所以导致我们无法输入-0原创内容，盗版必究。【转载请注明来源】.1这样的值。如何解决这类问题呢？答案还未经授权，禁止复制转载。原创内容，盗版必究。是：特殊处理。

另外，当用户输入的时候，数字开头是00时【原创内容，转载请注明出处】原创内容，盗版必究。，也应该根据整数还是小数进行清除。

原创内容，盗版必究。本文作者：唐霜，转载请注明出处。本文作者：唐霜，转载请注明出处。本文作者：唐霜，转载请注明出处。

精度

JS的数精度有限，无论是整数还是小数，都【关注微信公众号：wwwtangshuangnet】【关注微信公众号：wwwtangshuangnet】有17位限制，这导致我们无法输入一个比1【原创不易，请尊重版权】【版权所有，侵权必究】7个位置更多的数（变成e数）。因此，我支原创内容，盗版必究。【作者：唐霜】持precise属性来让开发者决定，当前未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。这个输入框是否可以用字符串表达数字。一旦转载请注明出处：www.tangshuang.net【转载请注明来源】开启字符串表达数字之后，外部接收到的就会本文版权归作者所有，未经授权不得转载。著作权归作者所有，禁止商业用途转载。是字符串，而非真实的数字。

【本文受版权保护】【关注微信公众号：wwwtangshua本文作者：唐霜，转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】ngnet】【关注微信公众号：wwwtangshua未经授权，禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】ngnet】

结语

看上去要实现一个数字输入框非常简单，实际【版权所有】唐霜 www.tangshuang.net本文作者：唐霜，转载请注明出处。上却有很多坑点等着我们去踩。很多细节都是本文版权归作者所有，未经授权不得转载。著作权归作者所有，禁止商业用途转载。在不断的尝试和发现中补全，很难在一开始就【版权所有，侵权必究】【关注微信公众号：wwwtangshuangnet】全部想到。我已经将代码在github开源本文版权归作者所有，未经授权不得转载。【本文首发于唐霜的博客】，你可以通过这里阅读源码。如果你发现还有什么细节没有被考虑在内，【版权所有，侵权必究】【本文首发于唐霜的博客】可以及时与我反馈。

【作者：唐霜】【作者：唐霜】未经授权，禁止复制转载。【关注微信公众号：wwwtangshuangnet】著作权归作者所有，禁止商业用途转载。未经授权，禁止复制转载。未经授权，禁止复制转载。【作者：唐霜】【未经授权禁止转载】【关注微信公众号：wwwtangshuangnet】本文版权归作者所有，未经授权不得转载。【本文首发于唐霜的博客】【关注微信公众号：wwwtangshuangnet】著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net【版权所有】唐霜 www.tangshuang.net本文版权归作者所有，未经授权不得转载。【版权所有】唐霜 www.tangshuang.net【转载请注明来源】【本文受版权保护】【未经授权禁止转载】【原创内容，转载请注明出处】【作者：唐霜】本文版权归作者所有，未经授权不得转载。【版权所有】唐霜 www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有，禁止商业用途转载。

2021-04-04 9491 React

唐霜

React 带千分位分隔符数字输入框的实现

接口设计

数字的格式化

非受控

光标位置

小数点

0 & 00

精度

结语

为价值买单，打赏一杯咖啡

声明

关于

生态