efflux-icons

---

Icon Set Last Updated: [Tue Apr 23 2019]

• Bundled with Webpack
• Developed with Hot Module Replacement (HMR)
• Includes linting with ESLint
• Formatted with Prettier
• Testing with Jest.

Installation

1. Install modules - yarn

2. Start example and start coding - yarn start

3. Run tests - yarn test

4. Bundle with - yarn build

5. To test if it works correctly in another project you can use yarn to sym-link the development version of efflux-icons on your pc to another existing project on your local machine:

   1. yarn link inside efflux-icons root folder.
   2. yarn link efflux-icons inside of the project folder you want to use efflux-icons in.

Note: Making changes to the efflux-icons projects will require rebuilding the bundle.js via yarn build in order for new changes to reflect in the linked project.

NPM equivalent

yarn	npm
yarn	npm install
yarn test	npm run test
yarn build	npm run build

Basic Usage

import React from 'react'
import Icon from 'efflux-icons';

export default function Example() {
  return (
    <div>
      <Icon name={'Home'} color={'blue'} />
    </div>
  )
}

Props

prop name	type	description	required	default
name	String	name of icon to be used as source	yes	n/a
color	String	color to be used in stroke and fill properties	no	black
size	Number	size of icon in px this defines the bounding box of the icon relative to width & height	no	20px

Icon Catalogue

The following Icons are available within this icon library. These Icons are ordered in alphabetical order

preview	name
	Arrow Down
	Arrow Left
	Arrow Right
	Arrow Up
	Bell
	Chart
	Check
	Close
	Currency
	External
	Facebook
	Home
	Instagram
	Laptop
	Location Pin
	Lock
	Mail Pending
	Mail
	Menu
	Overflow
	Phone
	Refresh
	Soundcloud
	Star
	Twitter
	User Add
	User Roles
	User Search
	Users
	Video
	Vimeo
	Youtube
	Warning

Development Roadmap

This project is still in development. When properly tested the following tasks will be completed:

• Add Jest Tests for components