mirror of
https://github.com/Tria-plc/emaui.git
synced 2026-08-27 13:10:58 +00:00
81 lines
2.1 KiB
Markdown
Executable File
81 lines
2.1 KiB
Markdown
Executable File
# react-number-format
|
|
|
|
React Number Format is an input-formatter library with a sophisticated and light weight caret engine. It ensures that a user can only enter text that meets specific numeric or string patterns, and formats the input value for display.
|
|
|
|
### Features
|
|
|
|
1. Prefix, suffix and thousands separator.
|
|
1. Input Masking.
|
|
1. Format number in an input or format as a simple text.
|
|
1. Custom pattern formatting.
|
|
1. Custom formatting handler.
|
|
1. Fully customizable
|
|
|
|
### Demos
|
|
|
|
See the many DEMO sections in [the documentation](https://s-yadav.github.io/react-number-format/docs/props).
|
|
|
|
### Install
|
|
|
|
[](https://www.npmjs.com/package/react-number-format)
|
|
|
|
Using `npm`
|
|
|
|
```
|
|
npm install react-number-format
|
|
```
|
|
|
|
Using `yarn`
|
|
|
|
```
|
|
yarn add react-number-format
|
|
```
|
|
|
|
### Documentation
|
|
|
|
Read the full documentation here
|
|
[https://s-yadav.github.io/react-number-format/docs/intro](https://s-yadav.github.io/react-number-format/docs/intro)
|
|
|
|
#### ES6
|
|
|
|
Numeric Format
|
|
|
|
```js
|
|
import { NumericFormat } from 'react-number-format';
|
|
```
|
|
|
|
NumericFormat Props: [https://s-yadav.github.io/react-number-format/docs/numeric_format](https://s-yadav.github.io/react-number-format/docs/numeric_format)
|
|
|
|
Pattern Format
|
|
|
|
```js
|
|
import { PatternFormat } from 'react-number-format';
|
|
```
|
|
|
|
PatternFormat Props: [https://s-yadav.github.io/react-number-format/docs/pattern_format](https://s-yadav.github.io/react-number-format/docs/pattern_format)
|
|
|
|
### Migrate from v4 to v5
|
|
|
|
[https://s-yadav.github.io/react-number-format/docs/migration](https://s-yadav.github.io/react-number-format/docs/migration)
|
|
|
|
### v4 doc
|
|
|
|
[v4 Docs](https://github.com/s-yadav/react-number-format/blob/master/documentation/v4.md)
|
|
|
|
### 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`
|