vue2-modal

A vue based modal plugin with modal component being defined globally.

Install

$ npm i @johnnywang/vue2-modal
// or
$ yarn add @johnnywang/vue2-modal

What plugin does?

This plugin will register a global component named modal, which would automatically use the plugin features.

Then you can use useModal globally to import the modal instance.

Or just use this.$modal in any components.

Usage

Register

Fisrt to install in your main.js

import Vue from 'vue';
import VueModal from '@johnnywang/vue2-modal';
import App from './App.vue';
import ErrorModal from './components/ErrorModal.vue';

// here we've to wrap all the modals going to be used in the modal.
// The global `modal` component will use `component` tag inside to change
// the modal based on your setting.
const components = {
  ErrorModal,
};

Vue.use(VueModal, {
  components,
});

template use

modal component has an loading slot, which you can used to customize your loading layout for modal.

<template>
  <div id="app">
    <div class="main">
      <router-view />
    </div>
    <modal :loading="loading" :firstup="true">
      <template #loading>
        Loading Modal...
      </template>
    </modal>
  </div>
</template>

<script>
export default {
  name: 'App',
  data() {
    return {
      // if there's some api calling when landing on page
      // default loading state should be set to "true"
      loading: true,
    }
  },
  mounted() {
    setTimeout(() => {
      this.loading = false;
    }, 2000);
  },
};
</script>

About props

There are only 5 props here.

loading

• type: Boolean
• default: true
• description: whether open loading statement

firstup

• type: Boolean
• default: true
• description: Whether modal components should use uppercase for first letter

modalClass

• type: Object
• default: {}
• description: Customize modal-inner classname for UI purpose(eg: changing bg img...)

wrapperTransition

• type: String
• default: fade
• description: transition name to set outside wrapper

innerTransition

• type: String
• default: ''
• description: transition name to set outside inner

Use in components

export default {
  mounted() {
    // will render & open ErrorModal in modal component
    this.$modal.update('ErrorModal', {
      msg: 'Something Error!'
    });

    // will close modal after 2 seconds
    setTimeout(() => {
      this.$modal.close();
    }, 2000);
  },
};

Outside components

import { useModal } from '@johnnywang/vue2-modal';

const modal = useModal();
// ...

About modal object

There are 2 methods, 2 properties in modal object.

name

• type: String
• default: undefined
• description: This is modal's name which directly based to your component name

after calling close method, name will become undefined which auto close the modal.

data

• type: Object
• default: {}
• description: Modal data, you can define whatever inside the data to bring to your modal component

after calling close method, data will become {}.

update

• type: Function
• description: Update the modal content

close

• type: Function
• description: Close the modal

Emits

Then the grey overlay is clicked, it'll emit an event called close