Marracash

Lightweight & easy to use react currency input component.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

React project

Installing

A step by step series of examples that tell you how to include and use the library in your javascript project

pull the repository to you local machine by running this command

npm i -S marracash

And voila you have the module in your node_modules

you only need to import the module to your project now by doing

//ES6 syntax
import Marracash from 'marracash';
or
//pure js syntax
const Marracash = require('marracash')

To add default component styles

//ES6 syntax
import 'marracash/dist/styles.css';

Usage

<Marracash />

| Props | definition | required | type | default value | | :-----------: |:-------------:| :-----:| :-----: | :---------: | currency | Object containing precision, symbol, decimal and thousand | false | object | { decimal: ",", thousand: ".", symbol: "€", precision: 2} | | disabled | disable or enable the input | false | boolean | FALSE | | showSymbol | Show or hide the currency symbol | false | boolean | TRUE | | id | To override default id | false | string | vx-price-input| | styles | Provide inline styles to input element | false | object | | | placeholder | Provide className to input element | false | string | | | className | Provide placeholder to input element | false | string | | | onChange | Function that sends back the price entered whenever a change is made | false | Function | 0 | | AllowEmpty | Ability to control what happens if price input gets cleared | false | boolean | TRUE | | defaultValue | Default value provided to the input element in cents | false | number | |

Running the tests

Automated end to end tests are not yet available

Unit tests

To run a unit test run this command

npm run test:unit

Component tests

To run a unit test run this command

npm run test:cmp

Deployment

For deploying a fix please check with authors.

Built With

• Accounting - used for formatting money and currency.
• Mocha - Used for Unit testing.
• Jest - Used for component testing.

Contributing

Please check with the authors

Versioning

We use npm for versioning

npm version patch/minor/major