homestars-icons

HomeStars Componentized Icons

A set of React components containing SVG icons. View all currently available icons

Installation

Using npm:

$ npm i --save homestars-icons

Usage

1. Import an icon into your app.

import { Project } from "homestars-icons";

1. Most colour options can be specified via the stroke prop:

render = () => {
  return <Project stroke="#000000" />;
}

Some icons can accept a fill value as well; some have even more robust colouring options.

<Lock 
  stroke="LightSteelBlue"
  fill="Goldenrod"
  keyholeFill="DarkSlateGrey"
/>

The default in most cases is #000000; notable exceptions include logo icons.

1. The default size is 22px x 22px, but can be adjusted via the size prop.

Contributing

1. Clone this project

$ git clone [e-mail]:homestars/icons.git

1. Install dependencies

$ npm install

1. Start the dev environment

$ npm start

Publishing

1. To publish one must have an npm account and be added to the to the https://www.npmjs.com/org/homestarsdotcom team.

2. Additionaly, one has to login into npm from the command line

npm login

1. Finally, after committing changes to master, run following command to publish to npm:

$ npm run patch

This will increment the version, build a distribution, and publish to NPM.

1. Finally, update the npm version of the homestars-icon package in the package.json of your project.

npm upgrade homestars-icons