Quasar components have their own icons. Rather than forcing you into using one icon library in particular (so that they can display correctly), Quasar lets you choose which icons it should use for its components. This is called a Quasar Icon Set
.
You can install multiple icon libraries, but you must choose only one to use on Quasar’s components.
Quasar currently supports: Material Icons , Font Awesome, Ionicons, MDI, Eva Icons, Themify Icons, Line Awesome and Bootstrap Icons.
It is also possible to use your own icons (as custom svgs or as images in any format) with any Quasar component, see the QIcon page for more info on this.
TIP
Related pages: Installing Icon Libraries and QIcon component.
Configuring the default Icon Set
There are two types of Quasar Icon Sets: webfont-based and svg-based.
Unless configured otherwise, Quasar uses Material Icons webfont as the icon set for its components. You can however tell Quasar to use some other Icon Set, but if it’s a webfont-based one then be sure to include its icon library in your website/app (see Installing Icon Libraries).
Hardcoded
If the default Quasar Icon Set is not dynamically determined (does not depends on cookies for example), then you can:
Quasar CLI Way
We edit /quasar.conf.js
again:
framework: {
// webfont-based example
iconSet: 'mdi-v6'
}
framework: {
// svg-based example
iconSet: 'svg-mdi-v6'
}
For all available options, visit the GitHub repository.
Full example of including MDI & Fontawesome and telling Quasar to use Fontawesome for its components.
extras: [
'mdi-v6',
'fontawesome-v6'
],
framework: {
iconSet: 'fontawesome-v6'
}
This will enable you to use both MDI & Fontawesome webfonts in your app, and all Quasar components will display Fontawesome icons.
UMD Way
Include the Quasar Icon Set tag for your Quasar version and also tell Quasar to use it. Example:
<!-- include this after Quasar JS tag -->
<script src="https://cdn.jsdelivr.net/npm/quasar@1/dist/icon-set/fontawesome-v6.umd.prod.js"></script>
<script>
Quasar.iconSet.set(Quasar.iconSet.fontawesomeV6)
</script>
Check what tags you need to include in your HTML files on UMD / Standalone page.
Vue CLI Way
We edit your main.js
:
import iconSet from 'quasar/icon-set/fontawesome-v6'
// ...
import { Quasar } from 'quasar'
// ...
Vue.use(Quasar, {
// ...,
iconSet: iconSet
})
Dynamical (non-SSR)
Quasar CLI: If your desired Quasar Icon Set must be dynamically selected (example: depends on a cookie), then you need to create a boot file: $ quasar new boot quasar-icon-set [--format ts]
. This will create /src/boot/quasar-icon-set.js
file. Edit it to:
// for when you don't specify quasar.conf.js > framework: 'all'
import { Quasar } from 'quasar'
// OTHERWISE:
import Quasar from 'quasar'
export default async () => {
const iconSetName = 'mdi-v6' // ... some logic to determine it (use Cookies Plugin?)
try {
await import(
/* webpackInclude: /(mdi-v6|fontawesome-v6)\.js$/ */
'quasar/icon-set/' + iconSetName
)
.then(setDefinition => {
Quasar.iconSet.set(setDefinition.default)
})
}
catch (err) {
// Requested Quasar Icon Set does not exist,
// let's not break the app, so catching error
}
}
Then register this boot file into /quasar.conf.js
:
boot: [
'quasar-icon-set'
]
Always constrain a dynamic import
Notice the use of the Webpack magic comment - webpackInclude
. Otherwise all the available icon set files will be bundled, resulting in an increase in the compilation time and the bundle size. See Caveat for dynamic imports
Dynamical (SSR) v1.11+
When dealing with SSR, we can’t use singleton objects because that would pollute sessions. As a result, as opposed to the dynamical example above (read it first!), you must also specify the ssrContext
from your boot file:
// for when you don't specify quasar.conf.js > framework: 'all'
import { Quasar } from 'quasar'
// OTHERWISE:
import Quasar from 'quasar'
// ! NOTICE ssrContext param:
export default async ({ ssrContext }) => {
const iconSetName = 'mdi-v6' // ... some logic to determine it (use Cookies Plugin?)
try {
await import(
/* webpackInclude: /(mdi-v6|fontawesome-v6)\.js$/ */
'quasar/icon-set/' + iconSetName
)
.then(setDefinition => {
// ! NOTICE ssrContext param:
Quasar.iconSet.set(setDefinition.default, ssrContext)
})
}
catch (err) {
// Requested Quasar Icon Set does not exist,
// let's not break the app, so catching error
}
}
Change Quasar Icon Set at Runtime
Changing Icon Set Dynamically
Quasar Icon Set is reactive, so all components will update properly if you change the $q.iconSet object. Here is an example:
import mdiIconSet from 'quasar/icon-set/mdi-v6.js'
methods: {
changeIconSetToMdiIconSet () {
this.$q.iconSet.set(mdiIconSet)
}
}
Changing a Specific Icon Dynamically
If you want to change a specific icon to another, you can. Here is an example:
methods: {
changeQEditorHeaderIcon () {
this.$q.iconSet.editor.header1 = 'fas fa-font'
}
}