https://github.com/byteball/stablecoin-icons
https://github.com/byteball/stablecoin-icons
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/byteball/stablecoin-icons
- Owner: byteball
- Created: 2021-02-04T14:05:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-11T16:57:25.000Z (about 5 years ago)
- Last Synced: 2025-04-14T14:17:17.966Z (about 1 year ago)
- Language: JavaScript
- Size: 93.8 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [React] Bonded stablecoin Icons
Link to bonded stablecoins: [ostable.org](https://ostable.org)
Link to token registry: [tokens.ooo](https://tokens.ooo/)
## Install
``npm i stablecoin-icons``
## Use
``import Icon from "stablecoin-icons"``
## Required packages:
- react
## Props
| Props name | Type | Descriprion |
| ------ | ------ | ------ |
| symbol | string | Token name |
| type | number | 1 - for growth; 2 - for interest; 3 - for stable |
| pegged | string | example: BTC, ETH, GOLD |
`type` is optional if the `symbol` is known, it is used as fallback to choose the type of the default icon when `symbol`'s icon is not found in this library.
This component supports all SVG props.
## Example
```js
import Icon from "stablecoin-icons"
export const App = () => {
return
}
```
## How do I add an icon for my stablecoin ?
- Go to the [template](https://www.figma.com/file/hE06ZP7Dsj9SVJycPlhomc/template?node-id=0%3A1) on figma and log in
- Click on the "Duplicate to your drafts"
- Go to your to drafts and select template
- Add a logo like this, what is your coin associated with (in the center of the circle, as in other icons) and save it as svg
- Create a folder "src/icons/[pegged name (for example, BTC or ETH)]". Save and move your icons there. The icon names must match the token name.
- Remove the height and width attributes in your SVG tags
- Import and add your icons to "src/iconList" as done with others
- Great, you did it! (After your PR is approved, a new version of the library will be released)
If you need help with this, write to @Taump on [Obyte Discord](https://discord.obyte.org/)