1.1.4 • Published 2 years ago
coin-icon v1.1.4
coin-icon
Cryptocurrency icons set
install
npm i coin-icon
Glossary
CoinIcon
Optimazed way to use icons, since the icon is loading through URL.
Gettting started
- Fist of all you need to define the path for storing icons files. For example -
images/svg
; - Copy all svg icons from
svg
(github repo) to your public folder'images/svg
; - Set up
CoinIconProvider
with public folder path:
<CoinIconProvider folderPath="'images/svg">
<App />
</CoinIconProvider>
- Import
CoinIcon
to your code:
import { CoinIcon } from 'coin-icon';
<CoinIcon code="btc" />;
Details
- Icon's
width
andheigth
are equal to1em
by default. To change icon's size change thefont-size
of parent or currenttag
. - Contains all properties declared in
HTMLAttributes<HTMLDivElement>
interface from@types/react
package and custom properties described below:
Property | Type | Required | Description |
---|---|---|---|
code | CoinIconCode | No | TypeScript literal type of icon code |
url | string | No | Image URL. For a case, when icon for a code is missing |
Add new icon
- Add new svg file into
svg
folder
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
<title>new-coin</title>
...
</svg>
Make sure that width
and height
property are removed.
- Add to
src/interfaces/index.ts
file:
export const CoinIconNameList = [
...
/* start */
'new-icon',
/* end */
...
];
- Create Pull Request
1.1.4
2 years ago
1.1.3
2 years ago
1.1.2
2 years ago
1.1.1
2 years ago
1.0.15
2 years ago
1.0.14
2 years ago
1.0.13
2 years ago
1.0.12
2 years ago
1.0.11
2 years ago
1.0.10
2 years ago
1.0.9
2 years ago
1.0.8
2 years ago
1.0.7
2 years ago
1.0.6
2 years ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago
0.0.6
2 years ago
0.0.5
2 years ago
0.0.4
2 years ago
0.0.3
2 years ago
0.0.2
2 years ago
0.0.1
2 years ago