raf

react-amount-field

React component for displaying input field handling currencies

Showing:

Popularity

Downloads/wk

0

GitHub Stars

2

Maintenance

Last Commit

4yrs ago

Contributors

3

Package

Dependencies

2

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

react-amount-field

npm version Build Status codecov Code Climate

React component for displaying input field transforming decimal value to cent value. It will by example transform 3.56 to 356.

Demo & Examples

Live demo: jtassin.github.io/react-amount-field

To build the examples locally, run:

npm install
npm start

Then open localhost:3000 in a browser.

Installation

The easiest way to use react-amount-field is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/ReactAmountField.min.js in your page. If you use this, make sure you have already included React, and it is available as a global variable. If you want to use the redux-form/material-ui connector, you also need to include material-ui in your dependencies.

npm install react-amount-field --save

or

yarn add react-amount-field

Usage

One installed, just require and use the component:

import React from `react`;
import ReactDOM from `react-dom`;
import AmountField from 'react-amount-field';

ReactDOM.render(<AmountField value="1337"><input type="text" /></AmountField>, document.querySelector('#main'));

Properties

PropsOptionsDefaultDescription
valueString/NumbernullThe value of the field in cents

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start.

License

MIT, see LICENSE for details.

Contributors

Julien TASSIN
Julien TASSIN

Copyright (c) 2016 Julien TASSIN.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial