@nteract/octicons

octicon react components, styled for use within nteract packages

Stats

StarsIssuesVersionUpdatedCreatedSize
@nteract/octicons
2.0.03 years ago4 years agoMinified + gzip package size for @nteract/octicons in KB

Readme

@nteract/octicons

This package contains a set of React icon components used within nteract applications. These icons are based on the GitHub Octicons icon set.

Installation

$ yarn add @nteract/octicons
$ npm install --save @nteract/octicons

Usage

The example below shows how to use the icons in this package to render a save button.

import { DownArrow } from "@nteract/actions";

export default () => {
  return (
    <button>
      <DownArrow /> Save
    </button>
  );
};

Documentation

We're working on adding more documentation for this component. Stay tuned by watching this repository!

Support

If you experience an issue while using this package or have a feature request, please file an issue on the issue board and add the pkg:octicons label.

License

BSD-3-Clause

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.