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

在很多业务场景中，产品要求我们实现一个交原创内容，盗版必究。【转载请注明来源】互：用户输入数字时，将数字按千分位分隔。著作权归作者所有，禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】一般我们会采用,作为分隔符，例如【未经授权禁止转载】100,000,000，但是react或者说web没有原生的方【关注微信公众号：wwwtangshuangnet】原创内容，盗版必究。法实现这个效果，因此，我们必须自己实现这【版权所有】唐霜 www.tangshuang.net【本文受版权保护】一需求。

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

【本文受版权保护】原创内容，盗版必究。【原创内容，转载请注明出处】

接下来，我就简单的阐述我的实现过程。【本文首发于唐霜的博客】

接口设计著作权归作者所有，禁止商业用途转载。

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

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

【原创不易，请尊重版权】本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。【未经授权禁止转载】

数字的格式化本文版权归作者所有，未经授权不得转载。

【关注微信公众号：wwwtangshuangnet】本文版权归作者所有，未经授权不得转载。未经授权，禁止复制转载。原创内容，盗版必究。

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

你可以看到，在第一次输入时，它会自动格式本文版权归作者所有，未经授权不得转载。【作者：唐霜】化。同时支持删除时格式化。

本文版权归作者所有，未经授权不得转载。原创内容，盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】【原创内容，转载请注明出处】本文作者：唐霜，转载请注明出处。

【未经授权禁止转载】著作权归作者所有，禁止商业用途转载。【原创不易，请尊重版权】

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著作权归作者所有，禁止商业用途转载。nge属性，只能直接接收数字，而无法接受【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.nete。于是我做了一个特殊处理，通过Prox著作权归作者所有，禁止商业用途转载。本文版权归作者所有，未经授权不得转载。y代理e，让外部在读取e.target.本文作者：唐霜，转载请注明出处。原创内容，盗版必究。value时，读到的是反转为数字的值。

【访问 www.tangshuang.net 获取更多精彩内容】本文版权归作者所有，未经授权不得转载。本文版权归作者所有，未经授权不得转载。【访问 www.tangshuang.net 获取更多精彩内容】

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为：【转载请注明来源】

【访问 www.tangshuang.net 获取更多精彩内容】原创内容，盗版必究。【本文首发于唐霜的博客】

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

这样就解决了外部读取e.target.v【访问 www.tangshuang.net 获取更多精彩内容】【转载请注明来源】alue时，读取真正需要的数据的问题。

非受控【未经授权禁止转载】

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

本文作者：唐霜，转载请注明出处。未经授权，禁止复制转载。本文作者：唐霜，转载请注明出处。

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} />
}

在用户输入的时候，即使是非受控状态，也可【本文首发于唐霜的博客】【原创不易，请尊重版权】以通过text这个状态值来实时的改变内容【原创不易，请尊重版权】【本文首发于唐霜的博客】。这样，就算非受控情况下，也能做到格式化著作权归作者所有，禁止商业用途转载。原创内容，盗版必究。数字。

光标位置【未经授权禁止转载】

【访问 www.tangshuang.net 获取更多精彩内容】【原创内容，转载请注明出处】【本文受版权保护】

当用户在数字串中间进行输入时，如果不做处【原创内容，转载请注明出处】转载请注明出处：www.tangshuang.net理，react受控组件会直接将光标放在末【关注微信公众号：wwwtangshuangnet】【原创不易，请尊重版权】尾，这是我们不希望看到的。我们希望在编辑本文作者：唐霜，转载请注明出处。【版权所有】唐霜 www.tangshuang.net过程中，光标位置能准确放在我们需要输入的转载请注明出处：www.tangshuang.net【关注微信公众号：wwwtangshuangnet】地方。

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

未经授权，禁止复制转载。【本文首发于唐霜的博客】著作权归作者所有，禁止商业用途转载。

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

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

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

【作者：唐霜】【作者：唐霜】本文版权归作者所有，未经授权不得转载。

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

第二段代码就考虑到了当改变值后，是否会多【原创不易，请尊重版权】原创内容，盗版必究。出或少掉一个,。基于useEffect的特性，我可以很著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net好的处理这个逻辑，useEffect具有未经授权，禁止复制转载。【版权所有，侵权必究】watch的效果，这一点确实让hooks【版权所有】唐霜 www.tangshuang.net未经授权，禁止复制转载。让人着迷。

【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有，禁止商业用途转载。【作者：唐霜】【作者：唐霜】

总之，经过一些记录、监听、比较，我可以准原创内容，盗版必究。【原创内容，转载请注明出处】确的定位光标了。但是，由于我使用了ref【本文受版权保护】【关注微信公众号：wwwtangshuangnet】，那么，我的这个组件，就无法实现跨端（R本文作者：唐霜，转载请注明出处。【版权所有，侵权必究】N）使用了。这也是一个不可避免的问题，不【原创不易，请尊重版权】【版权所有】唐霜 www.tangshuang.net过暂且不考虑这么深远吧。

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

小数点【转载请注明来源】

小数点看上去简单的不行，实际上是一个巨大著作权归作者所有，禁止商业用途转载。本文作者：唐霜，转载请注明出处。的难点。由于当我们输入小数点时，实际的表本文作者：唐霜，转载请注明出处。【原创不易，请尊重版权】达值，是相同的，这会使得我们经过格式化后著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】，丢掉小数点。例如 1,234. 和【本文首发于唐霜的博客】1,234 的实际值都是【版权所有】唐霜 www.tangshuang.net1234，这就会导致我们的格式化函数num2st本文版权归作者所有，未经授权不得转载。【未经授权禁止转载】r格式化之后只能得到 1,234 而无法得到著作权归作者所有，禁止商业用途转载。1,234. 这就是一件极其麻烦的事。这该怎么办呢？

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

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

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

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

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

0 & 00原创内容，盗版必究。

【原创内容，转载请注明出处】【原创不易，请尊重版权】【未经授权禁止转载】

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

【访问 www.tangshuang.net 获取更多精彩内容】【原创不易，请尊重版权】本文作者：唐霜，转载请注明出处。

【转载请注明来源】【未经授权禁止转载】【本文受版权保护】【关注微信公众号：wwwtangshuangnet】未经授权，禁止复制转载。

另外，当用户输入的时候，数字开头是00时【原创内容，转载请注明出处】【关注微信公众号：wwwtangshuangnet】，也应该根据整数还是小数进行清除。

著作权归作者所有，禁止商业用途转载。本文版权归作者所有，未经授权不得转载。著作权归作者所有，禁止商业用途转载。

精度未经授权，禁止复制转载。

著作权归作者所有，禁止商业用途转载。原创内容，盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】原创内容，盗版必究。

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

转载请注明出处：www.tangshuang.net【本文受版权保护】【转载请注明来源】

结语原创内容，盗版必究。

【未经授权禁止转载】【关注微信公众号：wwwtangshuangnet】【未经授权禁止转载】【本文首发于唐霜的博客】

看上去要实现一个数字输入框非常简单，实际本文作者：唐霜，转载请注明出处。未经授权，禁止复制转载。上却有很多坑点等着我们去踩。很多细节都是【本文受版权保护】【未经授权禁止转载】在不断的尝试和发现中补全，很难在一开始就【本文受版权保护】【访问 www.tangshuang.net 获取更多精彩内容】全部想到。我已经将代码在github开源【转载请注明来源】著作权归作者所有，禁止商业用途转载。，你可以通过这里阅读源码【原创不易，请尊重版权】。如果你发现还有什么细节没有被考虑在内，【版权所有，侵权必究】本文作者：唐霜，转载请注明出处。可以及时与我反馈。

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

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

2021-04-04 9354 React

唐霜

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