Code Monkey home page Code Monkey logo

react-text-mask-hoc's Introduction

react-text-mask-hoc · npm

A higher-order text-mask component for React and React Native.

Table of Contents

Install

yarn add react-text-mask-hoc

or

npm install --save react-text-mask-hoc

Usage

import React, {PureComponent} from 'react';
import {createMaskedComponent, InputAdapter} from 'react-text-mask-hoc';

// You can provide your own adapter component or use one of included in the library.
const MaskedInput = createMaskedComponent(InputAdapter);

export default class Example extends PureComponent {
    state = {
        value: '5554953947',
    };

    _onChange = (event) => {
        this.setState({value: event.target.value});
    }

    render() {
        return (
            <div>
                <MaskedInput
                    mask={['(', /[1-9]/, /\d/, /\d/, ')', ' ', /\d/, /\d/, /\d/, '-', /\d/, /\d/, /\d/, /\d/]}
                    guide={false}
                    value={this.state.value}
                    onChange={_this.onChange}
                />
            </div>
        );
    }
}

The only difference in usage in React Native is another adapter specific to the platform is needed.

import {createMaskedComponent, TextInputAdapter} from 'react-text-mask-hoc/ReactNative';

const MaskedInput = createMaskedComponent(TextInputAdapter);

// same as above

API

createMaskedComponent(AdaptedComponent)

A HOC granting text-mask functionality to the wrapped component.

Arguments

  • AdaptedComponent (React.Component): A React component that follows the adapter specification.

Adapters

Adapters are React components that implement a special interface for the createMaskedComponent.

List of adapters included in this library:

  • for React
    • InputAdapter
    • SpanAdapter
  • for React Native
    • TextInputAdapter
    • TextAdapter

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.