0.0.1 • Published 3 years ago

supercons v0.0.1

Weekly downloads
84
License
BSD-3-Clause
Repository
github
Last release
3 years ago

Supercons

A friendly set of open source React icons.

Preview & search the iconset

Massive credit to @superbryntendo for the original set of icons & aesthetic inspiration.

Predecessor projects: spectrum-icons, @hackclub/icons

Banner with fun styling of Supercons

Usage

yarn add supercons
# npm i supercons
import React from 'react'
import Icon from 'supercons'

export default () => (
  <div style={{ color: 'magenta' }}>
    <Icon glyph="like" size={128} />
    <Icon glyph="cloud" size={32} />
  </div>
)

Development setup

  1. Clone & enter the repo.
$ git clone https://github.com/lachlanjc/supercons.git
$ cd supercons
  1. Install dependencies.
$ yarn
  1. Build library.
yarn run prepare
  1. Run docs locally.
yarn run dev

To-do list

  • Drop PropTypes for TypeScript (thanks @anirudhb!)
  • Try using Microbundle for build?
  • Add more icons
  • Forward refs (with proper TypeScript support)
  • Allow tree-shaking by programatically generating a component for each icon
0.0.1

3 years ago