antd-masked-input

A Ant Design Input component for <input> masking, built on top of inputmask-core. A fork of antd-mask-input from antoniopresto with "one or more" (+) support. Probably, it's a temporary package till original one not be having the same mechanic.

Install

npm

npm install antd-masked-input --save

yarn

yarn add antd-masked-input

Usage

Give MaskedInput a mask:

import React from 'react'
import MaskedInput from 'antd-masked-input'

class Demo extends React.Component {
  state = {
    email: ''
  }

  _onChange = (e) => {
    this.setState({[e.target.name]: e.target.value})
  }

  render() {
    return <>
        <MaskedInput mask="*+@*+.*+" name="email" size="20" onChange={this._onChange}/>
    </>
  }
}

Create some wrapper components if you have a masking configuration which will be reused:

function CustomInput(props) {
  return <MaskedInput
    mask="1111-WW-11"
    placeholder="1234-WW-12"
    size="11"
    {...props}
    formatCharacters={{
      'W': {
        validate(char) { return /\w/.test(char ) },
        transform(char) { return char.toUpperCase() }
      }
    }}
  />
}

Props

mask : string

The masking pattern to be applied to the <input>.

See the inputmask-core docs for supported formatting characters.

onChange : (event: SyntheticEvent) => any

A callback which will be called any time the mask's value changes.

This will be passed a SyntheticEvent with the input accessible via event.target as usual.

Note: this component currently calls onChange directly, it does not generate an onChange event which will bubble up like a regular <input> component, so you must pass an onChange if you want to get a value back out.

formatCharacters: Object

Customised format character definitions for use in the pattern.

See the inputmask-core docs for details of the structure of this object.

placeholderChar: string

Customised placeholder character used to fill in editable parts of the pattern.

See the inputmask-core docs for details.

Other props

See Ant Design Input

MIT Licensed