topaxi / react-number-format

React component to format numbers in an input or as a text.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Actions Status

react-number-format

React Number format is a input formatter library with a sohpisticated and light weight caret engine.

Features

  1. Prefix, suffix and thousand separator.
  2. Custom pattern formatting.
  3. Masking.
  4. Custom formatting handler.
  5. Format number in an input or format as a simple text.
  6. Fully customizable

Install

npm

Using npm

npm install react-number-format

Using yarn

yarn add react-number-format

ES6

Numeric Format

import { NumericFormat } from 'react-number-format';

Pattern Format

import { PatternFormat } from 'react-number-format';

Read the full documentation here

https://s-yadav.github.io/react-number-format/docs/intro

Migrate from v4 to v5

https://s-yadav.github.io/react-number-format/docs/migration

v4 doc

v4 Docs

Development

  • Clone the repository or download the zip
  • npm i -g yarn to download Yarn
  • yarn to install dependencies
  • yarn start to run example server (http://localhost:8084/)
  • yarn test to test changes
  • yarn build to bundle files

Testing

Test cases are written in jasmine and run by karma

Test files : /test/**/*.spec.js

To run test : yarn test

About

React component to format numbers in an input or as a text.

License:MIT License


Languages

Language:JavaScript 60.4%Language:TypeScript 39.0%Language:HTML 0.4%Language:CSS 0.2%