JSPM

react-flexinput-mask

1.0.12
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q27022F
  • License MIT

Input masked component for React allowing to use variable length sections in mask definitions

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-flexinput-mask) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    react-flexinput-mask

    Input masked component for React allowing to use variable length sections in mask definitions. Ability to enter text sections of variable length allows to impement masked input of e-mail addresses, post addresses and other structured text of variable length.

    Live Demo

    Install

    npm install react-flexinput-mask

    Quick start

    import  React  from  'react';
    import  {FlexInputMask}  from  'react-flexinput-mask';
    
    function App() {
    return (
    <FlexInputMask placeHolder={[
      {text:"abc",delimiterText:"@",regex:"^[a-zA-Z0-9#!%$‘&+*–/=^_~]*$",isVariableLength:true},
      {text:"gmail",delimiterText:".",regex:"^[a-zA-Z0-9]*$",isVariableLength:true},
      {text:"com",regex:"^[a-zA-Z]*",isVariableLength:true}
     ]}/>);
    }

    Properties

    Name Type Default Description
    placeHolder IPlaceHolderItem[] The placeHolder property is an array of sections. Each section contains properties that determine the appearance of the section and the rules for entering symbols.
    style? object used for defining custom style properties (width,height ...)

    Events

    Name Event Handler Type                              Description        
    onSectionGotFocus? (instance: FlexInputMask)=>void fires when any section of placeHolder gets a focus
    onChange? (instance: FlexInputMask, newValue:string)=>boolean) =>void fires when user changes section content. newValue - not commited changes, if onChange handler returns false the changes would be rejected (previous value will be restored)
    onSectionLostFocus? (instance:FlexInputMask) =>void fires when any section of placeHolder losts a focus.