use-imask !npm !npm bundle size !NPM

React hook that exposes IMask object

Installation

``bash
npm install use-imask
`

or if you use yarn

`bash
yarn add use-imask
`

Usage

`typescript jsx
const maskOptions = { mask: Number }; // make sure options don't change on each render (use constant or useMemo or ref)

function Example() {
const [value, setValue] = useState("");

const [ ref ] = useIMask(maskOptions, {
// use onAccept callback instead of onChange to change value
onAccept: e => {
setValue(e.target.value);
},
});

return (

);
}
``

Props

|name|type|description|
|---|---|---|
|options|\|mask options, when options change updateOptions function is called by the IMask object
|onAccept|(e: ChangeEvent\, mask: InputMask\ \| undefined) => void|function called on IMask accept event
|onComplete|(e: ChangeEvent\, mask: InputMask\ \| undefined) => void|function called on IMask complete event

Return value

|name|type|description|
|---|---|---|
|ref|RefObject\|apply this to your input element
|maskRef|RefObject\ \| undefined\>|ref with IMask object