quasar-ui-component-lib
v0.1.1046
Published
My awesome component
Downloads
16
Readme
Component MyComponent
Compatible with Quasar UI v2 and Vue 3.
Component MyComponent
Short description of the component
Usage
Quasar CLI project
Install the App Extension.
OR:
Create and register a boot file:
import Vue from 'vue'
import Plugin from 'quasar-ui-component-lib'
import 'quasar-ui-component-lib/dist/index.css'
Vue.use(Plugin)
OR:
<style src="quasar-ui-component-lib/dist/index.css"></style>
<script>
import { Component as MyComponent } from 'quasar-ui-component-lib'
export default {
components: {
MyComponent
}
}
</script>
Vue CLI project
import Vue from 'vue'
import Plugin from 'quasar-ui-component-lib'
import 'quasar-ui-component-lib/dist/index.css'
Vue.use(Plugin)
OR:
<style src="quasar-ui-component-lib/dist/index.css"></style>
<script>
import { Component as MyComponent } from 'quasar-ui-component-lib'
export default {
components: {
MyComponent
}
}
</script>
UMD variant
Exports window.component-lib
.
Add the following tag(s) after the Quasar ones:
<head>
<!-- AFTER the Quasar stylesheet tags: -->
<link href="https://cdn.jsdelivr.net/npm/quasar-ui-component-lib/dist/index.min.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- at end of body, AFTER Quasar script(s): -->
<script src="https://cdn.jsdelivr.net/npm/quasar-ui-component-lib/dist/index.umd.min.js"></script>
</body>
If you need the RTL variant of the CSS, then go for the following (instead of the above stylesheet link):
<link href="https://cdn.jsdelivr.net/npm/quasar-ui-component-lib/dist/index.rtl.min.css" rel="stylesheet" type="text/css">
Setup
$ yarn
Developing
# start dev in SPA mode
$ yarn dev
# start dev in UMD mode
$ yarn dev:umd
# start dev in SSR mode
$ yarn dev:ssr
# start dev in Cordova iOS mode
$ yarn dev:ios
# start dev in Cordova Android mode
$ yarn dev:android
# start dev in Electron mode
$ yarn dev:electron
Building package
$ yarn build
Adding Testing Components
in the ui/dev/src/pages
you can add Vue files to test your component/directive. When using yarn dev
to build the UI, any pages in that location will automatically be picked up by dynamic routing and added to the test page.
Adding Assets
If you have a component that has assets, like language or icon-sets, you will need to provide these for UMD. In the ui/build/script.javascript.js
file, you will find a couple of commented out commands that call addAssets
. Uncomment what you need and add your assets to have them be built and put into the ui/dist
folder.
Donate
If you appreciate the work that went into this, please consider donating to Quasar.
License
MIT (c) [email protected]