1.0.0-alpha.2 • Published 12 months ago

@talixo/masked-input v1.0.0-alpha.2

Weekly downloads
15
License
MIT
Repository
github
Last release
12 months ago

Talixo Masked Input

UI Component which represents Masked Input

How to install

Package is available as @talixo/masked-input in NPM registry, so you can use it in your project using npm install @talixo/masked-input --save or yarn add @talixo/masked-input.

Requirements

Your package should additionally have some extra dependencies:

  • @talixo/shared: ^0.1.0
  • prop-types: ^15.6.1
  • react: ^16.2.0
  • react-dom: ^16.2.0

These packages are required by @talixo/masked-input, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

It allows any props which are allowed for div. Additionally, it handles some differently:

Property nameTypeDefaultDescription
classNamestringn/aAdditional class name passed to wrapper.
onBlurfunctionn/aEvent called when input has lost focus.
onChangefunctionn/aEvent called when input inside has changed.
onFocusfunctionn/aEvent called when input is focused.
renderInputstringn/aInput element.
renderMaskfunctionn/aFunction which returns masking element to render when input is blurred. First argument function is value passed either by parent changing value prop or by children if props.value is undefined.
valueanyn/aMasking element to render when input is blurred.

Changelog

  • 0.1.0 - initial version