README.md

Bitcoin Icons (WIP)

Bitcoin Icons is an open-source/open-design set of icons made for Bitcoin centric applications. Included are general icons most applications need like arrows and a home icon, and maybe more importantly Bitcoin-specific icons like a wallet, keys, miner and Bitcoin symbols.

Icons are available as a public Figma community file for design work, with a companion Figma plugin for convenient browsing and insertion. This repository contains icon exports as SVGs for implementation.

For requests, please leave a comment on the Figma file or post an issue to this repo. This could be new icons, improvements to existing icons, more style or export formats, or anything else. Just reach out.

Bitcoin Icons is a sister project of the Bitcoin Wallet UI Kit created by GBKS.

Contributing

For info on how to contribute please see the contribution guidelines. Also see details on the release process.

Folders

• 'SVG' contains the original icon files as exported from Figma
• 'optimized' contains the same files, but optimized via SVGO

The other folders define the npm modules, Figma plugin, images used in this README, etc.

SVG Download

You can download all icons for local use from the releases page.

Node Module

The node module is still in development. For now, you can install it and then pull the SVGs into a build system such as Gulp. In the future, there may be more options for importing the icons, such as font files, javascript imports, etc.

To install the node module pre-release version, run:

npm install @bitcoin-design/bitcoin-icons

React module

First, install @bitcoin-design/bitcoin-icons-react from npm:

npm install @bitcoin-design/bitcoin-icons-react

Now each icon can be imported individually as a React component:

import { BitcoinIcon } from '@bitcoin-design/bitcoin-icons-react/filled'

function MyComponent() {
  return (
    <div>
      <BitcoinIcon style={{height: "5px", width: "5px", color: '#F7931A' }} />
      <p>...</p>
    </div>
  )
}

The outline icons can be imported from @bitcoin-design/bitcoin-icons-react/outline, and the filled icons can be imported from @bitcoin-design/bitcoin-icons-react/filled.

Icons use an upper camel case naming convention and are always suffixed with the word Icon.

Vue module

Note that this library currently only supports Vue 3.

First, install @bitcoin-design/bitcoin-icons-vue from npm:

npm install @bitcoin-design/bitcoin-icons-vue

Now each icon can be imported individually as a Vue component:

<template>
  <div>
    <BitcoinIcon style="height:5px;width:5px;color:#F7931A" />
    <p>...</p>
  </div>
</template>

<script>
import { BitcoinIcon } from '@bitcoin-design/bitcoin-icons-vue/filled'

export default {
  components: { BitcoinIcon }
}
</script>

The outline icons can be imported from @bitcoin-design/bitcoin-icons-vue/outline, and the filled icons can be imported from @bitcoin-design/bitcoin-icons-vue/filled.

Icons use an upper camel case naming convention and are always suffixed with the word Icon.

SVG module

First, install @bitcoin-design/bitcoin-icons-svg from npm:

npm install @bitcoin-design/bitcoin-icons-svg

Now each icon can be imported individually as a Vue component:

import { BitcoinIcon } from '@bitcoin-design/bitcoin-icons-svg/filled'

console.log(BitcoinIcon)
// ==>
// {
//   name: 'bitcoin',
//   svg: '<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">...</svg>'
// };

The outline icons can be imported from @bitcoin-design/bitcoin-icons-svg/outline, and the filled icons can be imported from @bitcoin-design/bitcoin-icons-svg/filled.

Icons use an upper camel case naming convention and are always suffixed with the word Icon.

Figma plugin

The source for the Figma plugin can be found in this repository.