Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

etch-octicon

joefitzgerald94MIT2.0.0

A GitHub Octicons icon Etch component

etch, octicon, icon

readme

etch-octicon

npm package

An Etch component which renders a GitHub Octicons icon.

All Octicons

Usage

Install and use the Octicon component like so:

npm install --save etch-octicon
import Octicon from 'etch-octicon'

let App = () => <div>
  <Octicon mega spin name="sync"/>
</div>

render(<App/>, document.querySelector('#app'))

Required props

Prop Description
name The name of an icon in the Octicons set, e.g. 'trashcan'

Other props

Prop Description
className An additional class name for the element rendered by the component
mega If true, a double-size icon will be displayed
spin If true, the icon will spin

MIT licensed