Getting started
Installation
yarn add api3-logosUsage
React
import { ChainLogo, SymbolLogo, ApiProviderLogo } from 'api3-logos';
<div>
<img src={ChainLogo('43114')} width={50} height={50} alt="43114" />
<img src={SymbolLogo('BTC')} width={50} height={50} alt="BTC" />
<img src={ApiProviderLogo('nodary')} width={50} height={50} alt="nodary" />
</div>;HTML
<template>
<div>
<img src={ChainLogo('43114')} width={50} height={50} alt='43114' />
<img src={SymbolLogo('BTC')} width={50} height={50} alt='BTC' />
<img src={ApiProviderLogo('nodary')} width={50} height={50} alt='nodary' />
</div>
</template>
<script>
import { ChainLogo, SymbolLogo, ApiProviderLogo } from 'api3-logos';
export default {
...
methods: {
getSymbolLogo(symbol) {
return SymbolLogo(symbol);
},
getChainLogo(chainId) {
return ChainLogo(chainId);
},
getApiProviderLogo(apiProvider) {
return ApiProviderLogo(apiProvider);
},
}
...
}
</script>API
ChainLogo
| Prop | Type | Description |
|---|---|---|
| id | string | Chain id |
SymbolLogo
| Prop | Type | Description |
|---|---|---|
| id | string | Symbol id |
Package update
Run the following command to update the package:
yarn changesetThen follow the instructions in the terminal:
🦋 What kind of change is this for logos? (current version is x.x.x)
❯ patch
minor
major🦋 Please enter a summary for this change (this will be in the changelogs).
🦋 (submit empty line to open external editor)
🦋 Summary › [CHANGES]After that, you will be asked to confirm the changeset:
🦋 Summary › [CHANGES]
🦋
🦋 === Summary of changesets ===
🦋 patch: logos
🦋
🦋 Is this your desired changeset? (Y/n) › trueIf you confirm, the changeset will be created and you will be asked to publish it:
🦋 Changeset added! - you can now commit it
🦋
🦋 If you want to modify or expand on the changeset summary, you can find it here
🦋 info .changeset/[MD_FILE]
✨ Done.Commit the changeset and push it to the repository:
git add .
git commit -m "chore: update logos"
git pushMerge the changeset to the main branch:
git checkout main
git merge [BRANCH_NAME]
git pushTo publish the package, merge main to the production branch:
git checkout production
git merge main
git pushChangeset will raise a PR to the production branch. After the PR is merged, the package will be published to npm.
Supported chains and symbols
Visit this page for a list of supported chains and symbols.