react-crypto-icons
v1.0.5
Published
A simple React component that can display 600 crypto icons
Downloads
802
Maintainers
Readme
React Crypto Icons
A simple React component that can display 600 crypto icons
React Crypto Icons provides a simple icon component that can display crypto logos
Dependencies
This library requires the following packages to be installed:
Installation
React Crypto Icons requires Node.js v12+ to run.
Install React Crypto Icons from npm
npm install react-crypto-icons
Or with yarn
yarn add react-crypto-icons
Icons
This project supports nearly 600 (okay 594) SVG icons taken from the cryptocurrency-icons project. You can check out the supported icons here!
Usage
All icon names should be lowercase to avoid capitalization mismatching. To ensure consistant icon sizing, you MUST specify a size for each icon.
import React from "react";
import Icon from "react-crypto-icons";
function App() {
return (
<div className="App">
<Icon name="btc" size={25} />
</div>
);
}
export default App;
Pretty much all there is to it :)
Development
We love contributions 'round these parts!
React Crypto Icons is written in TypeScript and will be tested using jest. Make sure all new features are tested before creating PR.
If you are into making SVGs, head over to the cryptocurrency-icons project. I am sure they would love the extra iconage.
Build:
npm run build
Run tests:
npm run test
License
MIT
Free Software, Yee Haw!
[icons] http://cryptoicons.co