behawesometw / vue-hawesome-modal

A Vue promisify modal component plugin based on Vuetify with Vuex.

vue-hawesome-modal

A Vue promisify modal component plugin based on Vuetify with Vuex.
Provides dialog, notification and loader for building a modern website.
Using Promise API refactor modal component to provide fluent experience.
⚡ Live Demo

Installation

NPM

$ npm install vue-hawesome-modal

Install vue-hawesome-modal via Vue.use():

// main.js or somewhere you initialize your app

// import
import store from "../path/to/your/vuex/store.js"
import Vue from "vue"
import vueHawesomeModal from "vue-hawesome-modal"
import "vue-hawesome-modal/dist/vue-hawesome-modal.css"

// initialize global settings
var options = {
    store,
    themeColor: "hex or semantic color",
    dialogSetting: { ... },
    notifySetting: { ... },
    loaderSetting: { ... }
}

// install
Vue.use(vueHawesomeModal, options)

Use component at root (the most top-level) component like:

<template>
  <v-app>
    <h-dialog />
    <h-notify />
    <h-loader />
    ...
  </v-app>
</template>

For Nuxt.js

Define plugin for vue-hawesome-modal

// plugins/vue-hawesome-modal.js
import Vue from "vue"
import vueHawesomeModal from "vue-hawesome-modal"
import "vue-hawesome-modal/dist/vue-hawesome-modal.css"

export default ({ store }) => {
    var options = { 
        store, 
        themeColor: "hex or semantic color",
        dialogSetting: { ... },
        notifySetting: { ... },
        loaderSetting: { ... }
      }
    Vue.use(vueHawesomeModal, options)
}

Add vue-hawesome-modal inside the plugins key of your nuxt.config.js

// nuxt.config.js
{
  plugins: [{ src: '@/plugins/vue-hawesome-modal.js', mode: 'client' }]
}

<template>
  <v-app>
    <client-only>
      <h-dialog />
      <h-notify />
      <h-loader />
    </client-only>
    ...
  </v-app>
</template>

Usage

After Installing the plugin, dialog, notify and loader will available at $h on the Vue prototype.

---

Dialog

⚡ Live Demo

API

Name	Parameter	Return Type	Description
talk	val: string func: (builder: DialogConfigBuilder) => void	Promise	setup and open dialog
hangUp		void	close dialog

Global Settings

// import
import store from "../path/to/your/vuex/store.js"
import Vue from "vue"
import vueHawesomeModal from "vue-hawesome-modal"
import "vue-hawesome-modal/dist/vue-hawesome-modal.css"

// initialize global settings
var options = { 
  store,
  dialogSetting: {
    // vue-hawesome-modal/lib/dialog/dialogConfigAttribute
    title: "訊息", 
    confirmBtnTxt: "確認", 
    cancelBtnTxt: "取消"
  }
}

// install
Vue.use(vueHawesomeModal, options)

Basic Usage

// `this` points to the Vue instance
this.$h.dialog
  .talk("Lorem ipsum dolor sit amet.")
  .then(() => {
    // trigger after user clicks the confirm button
  })
  .catch(() => {
    // trigger after user clicks the cancel button
  })
  .finally(this.$h.dialog.hangUp);

Working With Builder

// `this` points to the Vue instance
this.$h.dialog
  .talk("嗨～大家今天過得好嗎？", builder => {
    builder 
      .set("width", 500)
      .set("themeColor", "info")
      .set("isShowCancelBtn", false)
  })
  .then(() => {
    // trigger after user clicks the confirm button
  })
  .catch(() => {
    // trigger after user clicks the cancel button
  })
  .finally(this.$h.dialog.hangUp);

---

Notify

⚡ Live Demo

API

Name	Parameter	Return Type	Description
info	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push info notification
success	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push success notification
warning	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push warning notification
error	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push error notification
promise	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push notification without auto dismiss
push	notiText: string func: (builder: NotifyConfigBuilder) => void	Promise	push notification
resolveAllNotify		void	resolve all notification
clearAllNotify		void	clear all notification ( p.s. not trigger then callback function)

Global Settings

// import
import store from "../path/to/your/vuex/store.js"
import Vue from "vue"
import vueHawesomeModal from "vue-hawesome-modal"
import "vue-hawesome-modal/dist/vue-hawesome-modal.css"

// initialize global settings
var options = { 
  store, 
  notifySetting: { 
    // vue-hawesome-modal/lib/notify/notifyConfigAttribute
    position: "bottomLeft", 
    timeout: 5 
  } 
}

// install
Vue.use(vueHawesomeModal, options)

Basic Usage

// `this` points to the Vue instance
this.$h.notify
  .info("Lorem, ipsum dolor.")
  .then(() => {
    // trigger after user clicks the confirm icon
    console.log("resolved");
  });

Working With Builder

// `this` points to the Vue instance
this.$h.notify
  .push(
    "Lorem, ipsum dolor.",
    builder => {
      builder
        .setType("success")
        .setTimeout(5)
    })
  .then(() => {
    // trigger after user clicks the confirm icon
    console.log("resolved");
  });

---

Loader

⚡ Live Demo

API

Name	Parameter	Return Type	Description
on	loaderText: string	void	open loader
off		void	close loader
close		void	force close loader
wait (sync)	handler: function, duration: number, loaderText: string	Promise	open loader, execute handler, wait duration, close loader, trigger then callback

Global Settings

// import
import store from "../path/to/your/vuex/store.js"
import Vue from "vue"
import vueHawesomeModal from "vue-hawesome-modal"
import "vue-hawesome-modal/dist/vue-hawesome-modal.css"

// initialize global settings
var options = { 
  store, 
  loaderSetting: { 
    type: "linear"
  } 
}

// install
Vue.use(vueHawesomeModal, options)

Basic Usage

// `this` points to the Vue instance
this.$h.loader.on();
setTimeout(() => {
  this.$h.loader.off();
}, 2000);

// `this` points to the Vue instance
this.$h.loader.on("系統處理中，請稍後…");
setTimeout(() => {
  this.$h.loader.off();
}, 2000);


this.$h.loader
  .wait(() => {
    // some code here
  }, 2000)
  .then(() => {
    console.log("done");
  });

---

Tutorial

⚡ Live Demo

Working With Promise API

// `this` points to the Vue instance
this.$h.notify
  .promise("hello!!")
  .then(() => this.$h.dialog.talk("ready to start a tutorial?"))
  .then(() =>
    this.$h.dialog.talk(
      "we can use `Promise API` chaining a series of tasks.",
      builder => {
        builder
          .set("width", 500)
          .set("themeColor", "purple")
          .set("isShowCancelBtn", false)
          .set("confirmBtnTxt", "simulate async");
      }
    )
  )
  .then(
    () =>
      new Promise(resolve => {
        this.$h.loader.on();
        setTimeout(() => {
          this.$h.loader.off();
          resolve({ result: true, msg: "hope you enjoy!" });
        }, 2000);
      })
  )
  .then(rs => {
    if (rs.result) {
      this.$h.notify.success(rs.msg);
    }
  })
  .catch(() => {
    this.$h.notify.warning("ok. maybe next time.");
  })
  .finally(this.$h.dialog.hangUp);