/ux-font-wso2

WSO2 Products User Interface Icons

Primary LanguageCSSOtherNOASSERTION

Font WSO2

Built with Grunt

Font WSO2 gives you scalable vector icons that can instantly customized and use on any website with the power of CSS. http://wso2.github.io/ux-font-wso2/

Font generation is base on sapegin/grunt-webfont

Changelog

v1.3.0 GitHub milestones
v1.2.2 GitHub milestones
v1.2.1 GitHub milestones
v1.2.0 GitHub milestones
v1.1.0 GitHub milestones
v1.0.2 GitHub milestones
v1.0.1 GitHub milestones

Build

Download and run grunt command

grunt

To run documentation locally.

grunt serve

This will run a node http server on the subfolder: /docs. And you can view using: http://127.0.0.1:9001/

Prerequisite

To run the build, this requires grunt > 0.4, node, fontforge & ttfautohint.

Note that ttfautohint is optional, but your generated font will not be properly hinted if it’s not installed. And make sure you don’t use ttfautohint 0.97 because that version won’t work.

OS X

brew install ttfautohint fontforge --with-python

You may need to use sudo for brew, depending on your setup.

fontforge isn’t required for node engine (see below).

Linux

sudo apt-get install fontforge ttfautohint

fontforge isn’t required for the node engine (see below).

Windows

install ttfautohint (optional).

Then install fontforge.

  • Download and install fontforge.
  • Add C:\Program Files (x86)\FontForgeBuilds\bin to your PATH environment variable.

How to Contribute

Add Icons

  • Add SVG icons to the icons folder - Please read the icon design guides
  • Open "icons.properties" and add the name of the icon file with codepoint value

ex:- "service":0xe66d

Optional if want to add sub class names follow the example. You can add them within [] brackets and use || for separate multiple names. See the example below

ex:- "service[cogwheels||gears]":0xe66d

Available Engines

There are two font rendering engines available. See also engine option below.

Engine Pros Cons
fontforge All features supported, The best results You have to install fontforge, Really weird bugs sometimes
node No external dependencies (except optional ttfautohint), Works on all platforms. Doesn’t work with some SVG files, Ligatures aren’t supported.

License

WSO2 Inc. licenses this source under the Apache License, Version 2.0 (LICENSE), You may not use this file except in compliance with the License.