You can take Font Awesome with Vue to the next level by learning a little more about the behind-the-scenes stuff that we do to load icons and fine-tuning it to exactly what you need.
To set a default style, ensure the following have been installed in your Vue app:
In the main.js file, set the config.styleDefault to the style of your choice:
// Set up using Vue 2
import Vue from "vue";
import App from "./App";
// import the fontawesome core
import { library } from "@fortawesome/fontawesome-svg-core";
// import the fontawesome icon component
import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
// import config so we can set a default style
import { config } from "@fortawesome/fontawesome-svg-core";
// import icon style(s)
import { fad } from "@fortawesome/pro-duotone-svg-icons";
// add the icon style(s) you have installed to the library
library.add(fad);
// add FontAwesomeIcon to the Vue component
Vue.component("font-awesome-icon", FontAwesomeIcon);
// set the default style
config.styleDefault = "duotone";
Vue.config.productionTip = false;
new Vue({
el: "#app",
components: { App },
template: "<App/>",
});
// Set up using Vue 3
import { createApp } from "vue";
import App from "./App.vue";
// import the fontawesome core
import { library } from "@fortawesome/fontawesome-svg-core";
// import fontawesome icon component
import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
// import config so we can set a default style
import { config } from "@fortawesome/fontawesome-svg-core";
// import icon style(s)
import { fad } from "@fortawesome/pro-duotone-svg-icons";
// add the icon style(s) you have installed to the library
library.add(fad);
// set the default style
config.styleDefault = "duotone";
// add FontAwesomeIcon to the Vue component
createApp(App)
.component("font-awesome-icon", FontAwesomeIcon)
.use(store)
.use(router)
.mount("#app");
Now you are ready to add your icons and have them render using the default style you've set (Duotone in this example's case):
// no need to specify the style again, it was set in the main.js file - these icons will all render using the Duotone style
<font-awesome-icon icon="fish" />
<font-awesome-icon icon="frog" size="sm" bounce />
<font-awesome-icon icon="dog" size="3x" />
<font-awesome-icon icon="cat" size="2x" flip="horizontal" />
We've worked hard to make Font Awesome as performant and lean as possible - by splitting styles up, using tree shaking, keeping code as light as possible - but you may have specific needs for your project and that's where these tips may come in handy.
Keeping the bundles small when using import { faCoffee } relies on tree-shaking. If you are not using a tool that supports tree shaking you may end up bundling more icons than you intend.
If the tree shaking isn't automatically working for you, here is an alternative import syntaxes:
import { library } from "@fortawesome/fontawesome-svg-core";
import { faCoffee } from "@fortawesome/free-solid-svg-icons/faCoffee";
import { faSpinner } from "@fortawesome/pro-light-svg-icons/faSpinner";
library.add(faCoffee, faSpinner);
Note that the icon name is added again at the end of each line. How does this work? We have individual icon files like node_modules/@fortawesome/free-solid-svg-icons/faCoffee.js that contain just that specific icon.
If you're using a lot of icons all in one style, you can import the entire style - but use with caution as it can be thousands of icons.
import { fas } from "@fortawesome/free-solid-svg-icons";
library.add(fas);
This will add the entire set of free solid style icons to your library. Be careful with this approach as it may be convenient in the beginning but your bundle size will be large. We highly recommend that you take advantage of subsetting through tree shaking.
You can explicitly define an icon through a computed property:
<template>
<div id="app">
<font-awesome-icon :icon="appIcon" />
</div>
</template>
<script>
import { faChessQueen } from "@fortawesome/free-solid-svg-icons";
export default {
name: "App",
computed: {
appIcon() {
return faChessQueen;
},
},
};
</script>
With Vue, you can tell your component to resolve another component explicitly.
<template>
<div>
<font-awesome-icon :icon="myIcon" />
</div>
</template>
<script>
// Import FontAwesomeIcon here rather than in the `main.js` file
// You will also want to make sure that `.component('font-awesome-icon', FontAwesomeIcon)`
// has NOT been added to `createApp(App)` in the `main.js` file
import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
import { faMug } from "@fortawesome/pro-solid-svg-icons";
export default {
name: "MyComponent",
data() {
return {
myIcon: faMug,
};
},
components: {
FontAwesomeIcon,
},
};
</script>
Explicitly selecting icons offers the advantage of only bundling the icons that you use in your final bundled file. This allows us to subset Font Awesome's thousands of icons to just the small number that are used in an average app or project.
Are you hungry for more knowledge? You can deep dive into our Font Awesome SVG Core and Javascript API docs.