DominicF96/token-icons

The most comprehensive source for cryptocurrency token & coin logos as SVG format.

Token Icons

Token Icons is the most comprehensive and up-to-date source for cryptocurrency & network logos as icon format. More than 2,500 icons are ready as optimized SVGs as well as React components.

What's New

Network Icons: Use <NetworkIcons chain={"chain-name"} /> to access Network Icons. Enhanced Naming Conventions: Our icons follow a standardized naming convention for effortless identification and use:

• Tokens: Prefixed with Token, followed by the uppercase symbol (e.g., TokenETH, TokenBTC).
• Networks: Prefixed with Network, followed by the CamelCase name (e.g., NetworkBinanceSmartChain, NetworkEthereum).

Monorepo structure

• @token-icons/core: npm package that serves optimized svgs as svg files
• @token-icons/react: React components for token icons
• @token-icons/utils: Private utility and build scripts for the monorepo
• apps/website: Next.js app for https://tokenicons.io
• apps/figma-plugin: Figma plugin for token icons

Installation

To use Token Icons in your project, you can install the necessary packages from npm:

npm i @token-icons/core @token-icons/react
# or
yarn add @token-icons/core @token-icons/react
# or
#bun i @token-icons/core @token-icons/react

This will install the @token-icons/core package, which serves optimized SVGs as SVG files, and the @token-icons/react package, which serves React components for token icons.

You can install either of the packages based on your project's needs.

Usage

Using Individual React Components from @token-icons/react

All the icons from the React library is prefixed with "Token" or "Network". Token Icons: Prefixed uppercase symbol with "Token" e.g. TokenETH, TokenBTC, TokenGRT Network Icons: Prefixed CamelCase network name with "Network" e.g. NetworkBinanceSmartChain, NetworkEthereum, NetworkAvalanche.

import {
  TokenBTC,
  TokenETH,
  TokenGRT,
  NetworkBinanceSmartChain,
  NetworkEthereum,
  NetworkAvalanche,
} from '@token-icons/react'

const App = () => {
  return (
    <>
      <div className="my-class-name">
        <h1>Token Icons</h1>
        <TokenBTC size={64} variant="branded" className="my-custom-class" />
        <TokenETH size={64} variant="branded" className="my-custom-class" />
        <TokenGRT size={64} variant="branded" className="my-custom-class" />
      </div>
      <div className="my-class-name">
        <h1>Network Icons</h1>
        <NetworkEthereum
          size={64}
          variant="branded"
          className="my-custom-class"
        />
        <NetworkAvalanche
          size={64}
          variant="branded"
          className="my-custom-class"
        />
        <NetworkBinanceSmartChain
          size={64}
          variant="branded"
          className="my-custom-class"
        />
      </div>
    </>
  )
}

export default App

Using <TokenIcon /> from @token-icons/react

<TokenIcon /> is designed to accept different props to allow for ease of use.

Props

• symbol?: the ticker symbol of the token. e.g. "ETH", "BTC", "GRT"
• address?: the contract address of the token.
• chain?: the blockchain network of the token.
• variant? = "mono": can be "mono" or "branded" to choose the icon style.
• size?: size of the icon (number or string).
• color?: color of the icon (CSS color value).
• className?: additional CSS class for custom styling.

You need to pass either symbol or address and chain.

<TokenIcon /> accepts a union of types for symbol, address, and chain. This allows for flexibility in using the component.

Using Symbols:

You can pass ticker or symbol of the desired icon. refer to metadata for full list of symbols.

import { TokenIcon } from '@token-icons/react'

const App = () => {
  const symbols = ['ETH', 'GRT', 'BTC']
  const variant = 'mono' // can be "mono" or "branded"
  const size = 48 // can be number or string

  return (
    <div>
      {symbols.map((s) => (
        <TokenIcon
          key={s}
          symbol={s}
          size={size}
          variant={variant}
          className="my-custom-class"
        />
      ))}
    </div>
  )
}

export default App

Chain Specific

You can pass in both chain and an address to render a specific token icon. refer to metadata for full list of symbols, addresses and chains.

import { TokenIcon } from '@token-icons/react'
;<TokenIcon
  chain="ethereum"
  address="0xc944e90c64b2c07662a292be6244bdf05cda44a7"
  size={32}
  variant={'branded'}
  className="my-custom-class"
/>

Using <NetworkIcon /> from @token-icons/react

<NetworkIcon /> is designed to render blockchain network icons.

Props

• network: The blockchain network's identifier. References the Coin Gecko's asset platform fields. Check the networks.json file for a list of available networks.
• variant? = "mono": can be "mono" or "branded" to choose the icon style.
• size?: size of the icon (number or string).
• color?: color of the icon (CSS color value).
• className?: additional CSS class for custom styling.

import { NetworkIcon } from '@token-icons/react'
;<NetworkIcon
  network="ethereum"
  size={32}
  variant={'branded'}
  className="my-custom-class"
/>

---

Using SVGs from @token-icons/core

For projects that don’t use React, icons are also available as *.svg files in the dist/svgs folder. Which contains folders for types (tokens or networks) and variants (branded and mono) svg icons.

Example file paths:

• svgs/tokens/branded/BTC.svg
• svgs/networks/mono/ethereum.svg

If you need to directly import the SVGs, here is the naming convention that you can use:

• {type} {variant} {symbol} (It has to be camelCase)
• tokensBrandedBTC (Token icons are prefixed with "Token" and the symbol is in uppercase)
• networksMonoEthereum (Network icons are prefixed with "Network" and the network name is in PamelCase)

import { tokensBrandedBTC, networksMonoEthereum } from '@token-icons/core'

or you can use the svgs object which contains objects for each type.

import { svgs } from '@token-icons/core'

const IconDisplay = () => {
  return (
    <div>
      <img src={svgs.tokens.brandedETH} alt="Ethereum Branded Token Icon" />
      <img
        src={svgs.networks.brandedEthereum}
        alt="Ethereum Branded Network Icon"
      />
    </div>
  )
}

or with a dynamic import

const type = 'tokens'
const variant = 'branded'
const iconName = 'BTC'

const svgModule = await import(
  `@token-icons/core/svgs/${type}/${variant}/${iconName}.svg`
)

const response = await fetch(svgModule.default.src)

const svgContent = await response.text()

console.log(svgContent)

not all of the icons have both branded & mono variants

---

Website

The Token Icons website (https://tokenicons.io) provides a searchable collection of all available icons. You can browse, search, and download icons directly from the website.

Contributing

We welcome contributions to token-icons! If you'd like to contribute, please refer to our Contributing Guide.

Adding a new icon is super easy.

1. Fork the repo, create a branch git checkout -b branch-name
2. Add or update icons to the related folders of core/src/raw-svgs/
3. Push your changes and create a pull request.
4. Github Actions will make sure to update the metadata, create React components and update the packages as necessary.

License

MIT

Give a Star ⭐️

If you like this project, please give it a star ⭐️ on GitHub. This helps us to maintain the project and make it better for everyone.