Fishrock123 / x-fontawesome

Allows you to use the FontAwesome SVGs with core-icon

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

x-fontawesome

Polymer Web Component that registers Font Awesome SVGs as a core-iconset-svg so you can use them easily in your components.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install x-fontawesome --save

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/x-fontawesome/dist/x-fontawesome.html">
  3. Start using it!

    <x-fontawesome></x-fontawesome>
    
    <core-icon icon="fontawesome-icons:fa-smile-o"></core-icon>

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  • Install local dependencies:

    $ bower install && npm install
  • To test your project, start the development server and open http://localhost:8000.

    $ grunt server
  • To build the distribution files before releasing a new version.

    $ grunt build
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT License

About

Allows you to use the FontAwesome SVGs with core-icon