Giter VIP home page Giter VIP logo

gaia-icons's Introduction

gaia-icons

Installation

$ bower install gaia-components/gaia-icons

Usage

<span data-icon="camera"></span>

Examples

Contributions

If you wish to make changes to the icon-font you'll need to follow these steps:

  1. Add, remove or change repsective .svg files inside images/
  2. Run $ npm install to get pull in all the required build tools.
  3. Make sure you fontforge and ttfautohint installed on your machine. The grunt-webfont readme outlines the prerequisites.
  4. Run $ grunt
  5. Load index.html locally in your browser and check your icon looks good.
  6. Submit a pull-request
  7. Module owner will review, land, and stamp a new version.

Guidelines

For best results, it is recommended to follow these guidelines:

  • Make the document 30px ร— 30px (In Inkscape: File > Document Properties... > Custom size)
  • Make the icon 24px ร— 24px
  • Center the icon (In Inkscape: Object > Align and Distribute... > Align relative to page)
  • Make sure to have only one <path> with no overlap per icon
  • Optimise the icons using svgo, then export to plain SVG file ($ inkscape -l icon.svg icon.svg)

Gaia usage

Gaia hackers, please read the introduction to 'Version controlled packages in Gaia' to find out how to use this package in your Gaia app.

Get a report

You can get a report of unused icons on a project by doing:

$ node bin/report.js path/to/your/project/

Please note, that dynamically inserted icons may still be marked as unused in the report.

Current owners

  • Wilson Page [:wilsonpage]

gaia-icons's People

Contributors

wilsonpage avatar gmarty avatar freaktechnik avatar rnowm avatar justindarc avatar crh0716 avatar douglassherk avatar hobinjk avatar jwatt avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.