npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-octicon

v3.0.1

Published

A GitHub Octicons icon React component

Downloads

545

Readme

react-octicon

Travis npm package Coveralls

A React component which renders an icon using the GitHub Octicons icon font.

All Octicons

Note: Github Octicons has switched from providing an icon font to being a library for generating SVG markup for string templating engines, so this component uses the last version which provided an icon font, version 4.

As such, the available icons and their appearance may not match with what's on the Github Octicons documentation site.

Demo

https://insin.github.io/react-octicon/

Usage

Note: Webpack is required in order to use this component.

Install and use the Octicon component like so:

npm install --save react-octicon
import React from 'react'
import {render} from 'react-dom'
import Octicon from 'react-octicon'

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

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

Usage with nwb

If you use nwb to build and serve the React app you're using this component in, it will automatically configure Webpack to handle CSS, image and font dependencies for you.

Usage with Webpack

This component handles the Octicons CSS dependency for you, but you must use Webpack and configure it to handle CSS and associated font and image files.

For example, using the following webpack loaders:

npm install --save-dev css-loader file-loader style-loader
module: {
  rules: [
    {
      test: /\.css$/,
      use: [
        'style-loader',
        'css-loader'
      ]
    },
    {
      test: /\.(eot|otf|svg|ttf|woff|woff2)$/,
      use: 'file-loader'
    }
  ]
}

See Webpack's Loading CSS documentation for more info.

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

Any additional props given, such as event handlers or aria-* attributes, will be passed to the element rendered by the component.

MIT licensed