Material-ui currency textfield

CurrencyTextField is a react component with automated currency and number format, and with Material-ui look and feel.

CurrencyTextField is a wrapper component for autonumeric and based on react-numeric.

Main features:

Adds thousands separator automatically.
Adds automatically the decimals on blur.
Smart input. User can only type the accepted characters depending on the current value.
Lots of config options...

Installation

npm install @unicef/material-ui-currency-textfield --save

Usage

The component documentation and live demo is available here

import React from 'react'
import CurrencyTextField from '@unicef/material-ui-currency-textfield'

export default function MyComponent() {

  const [value, setValue] = React.useState();

  return (
    <CurrencyTextField
		label="Amount"
		variant="standard"
		value={value}
		currencySymbol="$"
		//minimumValue="0"
		outputFormat="string"
		decimalCharacter="."
		digitGroupSeparator=","
		onChange={(event, value)=> setValue(value)}
    />
  );
}

Development

In order to extend the components, clone the project and install dependencies.

$ git clone https://github.com/unicef/material-ui-currency-textfield.git
$ npm install

The following commands are available:

`npm start`

Builds the app automatically for production to the dist folder, everytime you make changes in the code.

npm start

This build we are utilizing in example project, so each time we make some changes in the app. it builds the app to dist folder. so that we can see changes in the example project.

Now open new tab in bash and run this commands:

cd example 
npm install (only if it is firt time)
npm start

Runs the app in the development mode. Open http://localhost:3000 to view the app in the browser.

It will reload automatically upon edits. Lint errors are also displayed on the console.

`npm run build`

Builds the app for production to the dist folder.

It bundles application in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

`npm run styleguide`

Generates the documentation the development mode. Open http://localhost:6060 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

We use styleguidelist for documenting our custom components.

`npm run styleguide:build`

Builds the styleguide for production to the styleguide folder.
It correctly bundles React-styleguide in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgements

The majority of the source code of this repo was developed by @sureshsevarthi.

Also, this source code is based on react-numeric.

sureshsevarthi/material-ui-currency-textfield