@quasar/quasar-ui-qoverlay NPM

QOverlay

QOverlay is a Quasar component. It allows you to have fullscreen or component overlays and put a component on top of the overlay.

Examples and Documentation

Can be found here

Usage

Quasar CLI project

Install the App Extension.

OR:

Create and register a boot file:

import Vue from 'vue'
import Plugin from '@quasar/quasar-ui-qoverlay'
import '@quasar/quasar-ui-qoverlay/dist/index.css'

Vue.use(Plugin)

OR:

<style src="@quasar/quasar-ui-qoverlay/dist/index.css"></style>

<script>
import { QOverlay } from '@quasar/quasar-ui-qoverlay'

export default {
  components: {
    QOverlay
  }
}
</script>

Vue CLI project

import Vue from 'vue'
import Plugin from '@quasar/quasar-ui-qoverlay'
import '@quasar/quasar-ui-qoverlay/dist/index.css'

Vue.use(Plugin)

OR:

<style src="@quasar/quasar-ui-qoverlay/dist/index.css"></style>

<script>
import { QOverlay } from '@quasar/quasar-ui-qoverlay'

export default {
  components: {
    QOverlay
  }
}
</script>

UMD variant

Exports window.QOverlay.

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

<head>
  <!-- AFTER the Quasar stylesheet tags: -->
  <link href="https://cdn.jsdelivr.net/npm/@quasar/quasar-ui-qoverlay/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/quasar-ui-qoverlay/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/quasar-ui-qoverlay/dist/index.rtl.min.css" rel="stylesheet" type="text/css">

UMD example on Codepen

Building the Projects

Setup

In both the ui and ui/dev folders:

$ yarn

Developing

In the ui folder

# 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