etch-octicon
v2.0.0
Published
A GitHub Octicons icon Etch component
Downloads
42
Readme
etch-octicon
An Etch component which renders a GitHub Octicons icon.
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