If you want to embed Quasar into your existing website project, integrating it in a progressive manner, then go for the UMD/Standalone (Unified Module Definition) version.
Installation
UMD is all about adding Quasar style and javascript tags. Please select what you will be using and check out the output below it.
<!DOCTYPE html>
<html>
<!--
WARNING! Make sure that you match all Quasar related
tags to the same version! (Below it's "@2.17.5")
-->
<head>
<link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900|Material+Icons" rel="stylesheet" type="text/css">
<link href="https://cdn.jsdelivr.net/npm/quasar@2.17.5/dist/quasar.prod.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- example of injection point where you write your app template -->
<div id="q-app"></div>
<!-- Add the following at the end of your body tag -->
<script src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.prod.js"></script>
<script src="https://cdn.jsdelivr.net/npm/quasar@2.17.5/dist/quasar.umd.prod.js"></script>
<script>
/*
Example kicking off the UI. Obviously, adapt this to your specific needs.
Assumes you have a <div id="q-app"></div> in your <body> above
*/
const app = Vue.createApp({
setup () {
return {}
}
})
app.use(Quasar)
app.mount('#q-app')
</script>
</body>
</html>
WARNING
- Please notice the
<!DOCTYPE html>at the beginning of the document. Do not forget to add it, or else some browsers (notably Safari) will use some compatibility mode that breaks flex. - If you are using an RTL Quasar language pack (eg. Hebrew) then toggle the “RTL CSS support” above too!
- Do NOT use self-closing tags, like
<q-icon ... />. Instead, go with<q-icon ...></q-icon>. - It might be wise to pin all the packages that you use to specific versions that you’ve already tested in development. Regressions can occur, like in Vue 3.2.32 and this can break your pages. Example of pinning Vue to a specific version (point the script tag to): https://cdn.jsdelivr.net/npm/vue@3.2.31/dist/vue.global.prod.js
TIP
All components, directives and Quasar plugins are ready to be used out of the box. There is no need for additional code to install them. Just make sure that you will NOT be using self-closing tags.
JsFiddle / Codepen
You can fork and use these links for reporting issues on GitHub too:
| Supplier | URL |
|---|---|
| jsFiddle | https://jsfiddle.quasar.dev |
| Codepen | https://codepen.quasar.dev |
These links (obviously) use the Quasar UMD version.
Quasar Global Object
When you embed Quasar UMD into a webpage you’ll get a Quasar global Object injected:
Quasar = {
version, // Quasar version
...components,
...directives,
...plugins, // Quasar plugins
...utils, // Quasar utils
// if you want to change current icon set or Quasar Language pack
// (must include CDN links so they are available first!)
lang,
iconSet
}Some usage examples:
Quasar.QBtn
Quasar.getCssVar('primary')
Quasar.debounce(fn, 200)
Quasar.Notify.create('Hi and welcome!')
Quasar.utils.is.deepEqual(objA, objB)Quasar Config Object
There are some configuration options for Quasar & Quasar plugins:
app.use(Quasar, {
config: {
brand: {
primary: '#e46262',
// ... or all other brand colors
},
notify: {...}, // default set of options for Notify Quasar plugin
loading: {...}, // default set of options for Loading Quasar plugin
loadingBar: { ... }, // settings for LoadingBar Quasar plugin
// ..and many more
}
})Usage
So, after you figured out the CDN links that you need to embed into your webpages, now it’s time to use Quasar.
By using the UMD version, you’ll have all of the components, directives and Quasar plugins already installed for you. You just need to start using them.
Do not use self-closing tags with the UMD version: You will notice that you won’t be able to use the self-closing tag form of any of the components. You must close all components tags.
<!-- Incorrect usage: In docs, but for Quasar CLI usage -->
<q-btn label="My Button" />
<!-- ^^^ can't use it like this on UMD -->
<!-- Correct usage: Instead, include a self-closing tag too: -->
<q-btn label="My Button"></q-btn>Examples
<!-- components -->
<q-btn label="My Button"></q-btn>
<!-- directives -->
<div v-ripple>...</div>// Quasar plugins
Quasar.BottomSheet.create({...})
// Quasar utils
Quasar.openURL('https://quasar.dev')Changing Quasar Icon Set
Assuming you have already included the CDN link to your favorite Quasar Icon Set (unless you’re using Material Icons which is used by default), you can then tell Quasar to use it:
Quasar.IconSet.set(Quasar.IconSet.fontawesomeV6)The list of available Quasar Icon Sets can be found on GitHub.
Changing Quasar Language Pack
Assuming you have already included the CDN link to your desired Quasar I18n Language (unless you want “en-US” language pack which is used by default), you can then tell Quasar to use it:
// example setting German language,
// using ISO 2 letter code:
Quasar.Lang.set(Quasar.Lang.de)
// example setting Portuguese (Brazil) language:
Quasar.Lang.set(Quasar.Lang.ptBR)The list of available languages can be found on GitHub. If your desired language pack is not available yet, you can help by providing a PR. We welcome any languages!