vue-awesome

Vue-Awesome

Font Awesome component for Vue.js, using inline SVG.

Vue-Awesome is built upon Font Awesome v4.5.0 and depends on Vue.js v1.0.17+.

Installation

manual

Just download dist/vue-awesome.js and include it in your HTML file:

<script src="path/to/vue-awesome/dist/vue-awesome.js"></script>

npm

$ npm install vue-awesome

bower

$ bower install vue-awesome

Usage

<!-- basic -->
<icon name="repo"></icon>

<!-- with options -->
<icon name="sync" scale="2" spin></icon>
<icon name="comment" flip="horizontal"></icon>
<icon name="repo-forked" label="Forked Repository"></icon>

CommonJS

var Vue = require('path/to/vue')

// requiring the UMD module
var Icon = require('path/to/vue-awesome/dist/vue-awesome')

// or with vue-loader you can require the src directly
var Icon = require('path/to/vue-awesome/src/components/Icon.vue')

// register component to use

AMD

require.config({
  paths: {
    'vue-awesome': 'path/to/vue-conticon/dist/vue-awesome'
  }
})

require(['vue-awesome'], function (Icon) {
  // register component to use...
})

Global variable

The component class is exposed as window.VueAwesome.

Local development

$ npm i
$ npm run dev

Open http://localhost:8080/demo to see the demo.

Related projects

• Vue-Octicon by the same author of Vue-Awesome.
• SVG files are generated using fa2svg by @riobard.