Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
69 lines (38 loc) · 2.75 KB

readme.md

File metadata and controls

69 lines (38 loc) · 2.75 KB
Raw

Ionicons

The premium icon font for Ionic. Designed by @benjsperry.

Note: All brand icons are trademarks of their respective owners. The use of these trademarks does not indicate endorsement of the trademark holder by Drifty, nor vice versa.

Visit ionicons.com and check out the search feature, which has keywords identifying common icon names and styles. For example, if you search for “arrow” we call up every icon that could possibly be used as an arrow. We’ve also included each icon’s class name for easy copy/pasting when you’re developing!

We intend for this icon pack to be used with Ionic, but it’s by no means limited to it. Use them wherever you see fit, personal or commercial. They are free to use and licensed under MIT.

Getting Started

  1. Download and extract the font pack
  2. Copy the ionicons.css to your project
  3. Copy the fonts folder to your project
  4. Ensure the font urls within ionicons.css properly reference the fonts path within your project.
  5. Include a reference to the ionicons.css file from every webpage you need to use it.

Or install with component:

$ component install driftyco/ionicons

Or perhaps you're known to use bower?

$ bower install ionicons

NPM Publishing

  1. get a npm account with our team
  2. go to the project folder
  3. npm adduser or npm login (if you're not already logged in)
  4. npm version <version> give the package a new version number
  5. npm publish
  6. 💥 new package available!
  7. install in your project via npm i --save @shipt/ionicons@latest

HTML Example

You can use ionicons.com to easily find the icon you want to use. Once you've copied the desired icon's CSS classname, simply add the icon and icon's classname, such as ion-home to an HTML element.

<i class="icon ion-home"></i>

Build Instructions

This repo already comes with all the files built and ready to go, but can also build the fonts from the source. Requires Python, FontForge and Sass:

  1. Install FontForge, which is the program that creates the font files from the SVG files:

    $ brew install fontforge ttfautohint

  2. Install Sass

    $ gem install sass

  3. Add or subtract files from the src/ folder you'd like to be apart of the font files.

  4. Modify any settings in the builder/manifest.json file. You can change the name of the font-family and CSS classname prefix.

  5. Run the build command:

    python ./builder/generate.py

License

Ionicons is licensed under the MIT license.