Socket
Socket
Sign inDemoInstall

iconfont

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

iconfont

CLI that converts Icon Font CSS StyleSheets into CommonJS modules exporting the unicodes by name.


Version published
Weekly downloads
45
increased by125%
Maintainers
1
Weekly downloads
 
Created
Source

IconFont

CLI to convert CSS StyleSheets for Icon Fonts like FontAwesome to a CommonJS module or Alloy TSS file that exports all unicodes by name.

I use them in native iOS & Android apps build with Titanium.

Example

Install the CLI npm

Install the CLI via NPM like this:

$ [sudo] npm install -g iconfont

CommonJS

Generate it

Just point the CLI to the CSS file:

$ iconfont font-awesome.css

This would create a file named font-awesome.js in the same directory as the CSS file. If you want to write to a different path, simply pass it as the second argument:

$ iconfont font-awesome.css ~/fa.js

Use it

In Titanium, I'd use the module like this:

var icons = require('font-awesome');

var button = Ti.UI.createButton({
	font: {
		fontFamily: 'FontAwesome'
	},
	title: icons.flag
});

In Alloy you can do:

alloy.js

Alloy.Globals.icons = require('font-awesome');

index.tss

"Button": {
	title: Alloy.Globals.icons.flag
}

Alloy TSS

Credits: Jong Eun Lee.

Generate it

Add the -t or --tss flag:

$ iconfont font-awesome.css -t

Or when using the second output-argument, make sure its extension is .tss:

$ iconfont font-awesome.css ~/fa.tss

Use it

Since you cannot import TSS files at the moment, you'd probably copy-paste the contents of the generated file to your app/styles/app.tss file.

index.xml

Use the classes just like in HTML:

<Label class="fa-thumbs-up otherClassName"></Label>

index.tss

And overwrite any property using additional class names:

".otherClassName": {
	font: {
		fontSize: 40
	}
}

Notes

  • For JS:
    • Icon names are camel-cased (arrow-up becomes arrowUp).
    • If all icon names share the same prefix this will be stripped out (icon-flag becomes flag).
  • The CLI expects selectors ending with :before.
  • The CLI expects declerations with a content property and a valid (unicode) string as value.

Changelog

  • 0.3.0: Adds support for generating TSS files
  • 0.2.0:
    • Adds support for non-unicode content
    • Fixes camelCase for some-1 (#3)
  • 0.1.0: Initial release

Issues

Please report issues and features requests in the repo's issue tracker.

License

Distributed under MIT License.

Keywords

FAQs

Package last updated on 09 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc