Skip to content

Dialogs

A simple style useful dialog component collection for Vue3

GitHub Repo stars GitHub forks

Repository status

CircleCI code coverage npm version license JavaScript Style Guide

Detailed changes for each release are documented in Changelog

If you are using vue 2.x version, please use v-dialogs 2.x version instead

Installation

Install v-dialogs component in to your project

sh
npm i v-dialogs
sh
yarn add v-dialogs
sh
pnpm add v-dialogs

Application scenario

  • Alert Interactive dialog boxes, for notifications that require explicit feedback from the user
  • Modal Modal container dialog, It is displayed at the center of the screen
  • Drawer Another modal container dialog, It is displayed at the edge of the screen, and it is the better choice for quickly viewing details
  • Message Silent message notification, displayed in the vertical center area of ​​the screen
  • Toast Silent message notification, displayed in the corner of the screen
  • Mask A screen mask that blocks user actions

Built-in language

Language built into the component

LanguageLanguage code
Chinesecn
Englishen
Portuguesept
Japanesejp
Turkishtr

Globally instance

v-dialogs also provides a globally instance to open dialogs, you can use it in any component

The default instance name is $dlg

js
import { createApp } from 'vue'
import dialogs from 'v-dialogs'
import App from 'App.vue'

createApp(App).use(dialogs).mount('#app')

The global instance are only supported as a feature and are not recommended for use

Option API

js
export default {
  mounted () {
    this.$dlg.message('Saved successfully!')
  }
}

Composition API

js
import { getCurrentInstance } from 'vue'

// const $dlg = getCurrentInstance().appContext.config.globalProperties.$dlg
const $dlg = getCurrentInstance().proxy.$dlg

$dlg.message('Saved successfully!')

Modules

Released under the MIT License.