npm

react-crypto-compare
TypeScript icon, indicating that this package has built-in type declarations

1.3.2 • Public • Published

react-crypto-compare

A simple cryptocurrencies converter component based on https://min-api.cryptocompare.com. Min React version: 16.8.

Build Status Build Cron Renovate enabled Commitizen friendly Open SourceLove TypeScript

What this component does

Install

npm install --save react-crypto-compare

How to use

First of all, you need a cryptocompare.com api key.

Then

import CryptoCompare from "react-crypto-compare";
// ...
<CryptoCompare from="EUR" to="BTC" amount={10} apikey="<YOUR_CRYPTOCOMPARE.COM_APIKEY>" />;

it renders

<div class="react-crypto-compare">
  <span class="react-crypto-compare-amount">0.001408</span>
  <span class="react-crypto-compare-currency">BTC</span>
</div>

You can set the api key just once to avoid passing it to the component

import CryptoCompare, { setApikey } from "react-crypto-compare";
setApikey("<YOUR_CRYPTOCOMPARE.COM_APIKEY>");
// ...
<CryptoCompare from="EUR" to="BTC" amount={10} />;

please note that the apikey prop, if passed, takes the precedence over the global api key set though setApikey.

CSS Classes

You can customize the look&feel of the component using its classes

.react-crypto-compare
.react-crypto-compare-error
.react-crypto-compare-loading

and its children ones

.react-crypto-compare-amount
.react-crypto-compare-currency

Working example

Run

cd example && npm run start

Possible improvements

  • managing the decimals for every cryptocurrency (at the moment fixed at eight thinking about Bitcoin)
  • passing the CSS classes from the parent component
  • adding an interval-based refresh to have always the most updated conversion
  • managing multiple currencies conversion in a single component
  • adding a render prop to manage the rendered markup from the outside

Why

I've developed it because I'd some spare time (more less 4 hours) and I'd like to play with:

Contributing

PR or issues are welcome 👋

Contributors

Thanks goes to these wonderful people (emoji key):

Stefano Magni
Stefano Magni

💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Package Sidebar

Install

npm i react-crypto-compare

Weekly Downloads

15

Version

1.3.2

License

MIT

Unpacked Size

303 kB

Total Files

8

Last publish

Collaborators

  • noriste