ContextQMD
Back to Quasar

Component and Directive v-

create-quasar/templates/ui-kit/quasar-v2/BASE/ui/README.md

1.16.14.0 KB
Original Source

<% if (features.component) { %>Component <%= componentName %><% if (features.directive) { %> and <% } } %><% if (features.directive) { %>Directive v-<%= directiveName %><% } %>

[![npm](https://img.shields.io/npm/v/quasar-ui-<%= name %>.svg?label=quasar-ui-<%= name %>)](https://www.npmjs.com/package/quasar-ui-<%= name %>) [![npm](https://img.shields.io/npm/dt/quasar-ui-<%= name %>.svg)](https://www.npmjs.com/package/quasar-ui-<%= name %>)

Compatible with Quasar UI v2 and Vue 3.

<% if (features.component) { %>

Component <%= componentName %>

Short description of the component <% } %>

<% if (features.directive) { %>

Directive v-<%= directiveName %>

Short description of the directive <% } %>

Usage

Quasar CLI project

<% if (features.ae) { %>

Install the App Extension.

OR:

<% } %> Create and register a boot file:

js
import Vue from 'vue'
import Plugin from 'quasar-ui-<%= name %>'
import 'quasar-ui-<%= name %>/dist/index.css'

Vue.use(Plugin)

OR:

html
<style src="quasar-ui-<%= name %>/dist/index.css"></style>

<script>
import { <% if (features.component) { %>Component as <%= componentName %><% if (features.directive) { %>, <% } %><% } %><% if (features.directive) { %>Directive<% } %> } from 'quasar-ui-<%= name %>'

export default {
  <% if (features.component) { %>
  components: {
    <%= componentName %>
  }<% if (features.directive) { %>,<% } %>
  <% } %>
  <% if (features.directive) { %>
  directives: {
    Directive
  }
  <% } %>
}
</script>

Vue CLI project

js
import Vue from 'vue'
import Plugin from 'quasar-ui-<%= name %>'
import 'quasar-ui-<%= name %>/dist/index.css'

Vue.use(Plugin)

OR:

html
<style src="quasar-ui-<%= name %>/dist/index.css"></style>

<script>
import { <% if (features.component) { %>Component as <%= componentName %><% if (features.directive) { %>, <% } %><% } %><% if (features.directive) { %>Directive<% } %> } from 'quasar-ui-<%= name %>'

export default {
  <% if (features.component) { %>
  components: {
    <%= componentName %>
  }<% if (features.directive) { %>,<% } %>
  <% } %>
  <% if (features.directive) { %>
  directives: {
    Directive
  }
  <% } %>
}
</script>

UMD variant

Exports window.<%= umdExportName %>.

Add the following tag(s) after the Quasar ones:

html
<head>
  <!-- AFTER the Quasar stylesheet tags: -->
  <link href="https://cdn.jsdelivr.net/npm/quasar-ui-<%= name %>/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-<%= name %>/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):

html
<link href="https://cdn.jsdelivr.net/npm/quasar-ui-<%= name %>/dist/index.rtl.min.css" rel="stylesheet" type="text/css">

Setup

bash
$ yarn

Developing

bash
# 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

bash
$ 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

<%= license %> (c) <%= author %>