Skip to content

jtassin/react-opensource-component-template

Repository files navigation

react-opensource-component-template

npm version Build Status codecov Code Climate

React component for displaying formatted amount with currency

Demo & Examples

Live demo: jtassin.github.io/react-opensource-component-template

To build the examples locally, run:

npm install
npm start

Then open localhost:3000 in a browser.

Installation

The easiest way to use react-opensource-component-template 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/ReactFormattedAmount.min.js i n your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-opensource-component-template --save

Usage

One installed, just require and use the component:

import React from `react`;
import MyComponent from 'react-opensource-component-template';

React.render(<MyComponent>Replace with real example</MyComponent>, document.querySelector('#main'));

Properties

PROPERTIES

Notes

ADDITIONAL USAGE NOTES

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published