@burhanahmeed/vue-modal-2

A simple and lightweight Vue modal component for Vue 2.x.

Documentation

Docs: https://initbase.github.io/vue-modal-2/

Demo

demo codesandbox

Install

yarn add @burhanahmeed/vue-modal-2

or

npm install @burhanahmeed/vue-modal-2

Usage

Vue-modal-2 usage for Vue 2.x

import Vue from "vue";
import App from "./App.vue";

import Modal from "@burhanahmeed/vue-modal-2";

Vue.use(Modal);

Vue.config.productionTip = false;

new Vue({
  render: (h) => h(App)
}).$mount("#app");

Usage in vue. If you didn't specify options.componentName, by default it will be <vue-modal-2></vue-modal-2>

<template>
  <vue-modal-2 name="modal-1" @on-close="close">
    Hello From Inside Modal Component
  </vue-modal-2>
</template>

API usage

methods: {
  open () {
    this.$vm2.open('modal-1')
  },
  close () {
    this.$vm2.close('modal-1')
  }
}

vue-modal-2 also accept options in .use() function as second argument.

options

options.componentName

• type: String
• default: vue-modal-2

Vue.use(Modal. {
  componentName: 'MyModal'
});

<template>
  <my-modal name="modal-1" @on-close="close">
    Hello From Inside Modal Component
  </my-modal>
</template>

Props

vue-modal-2 accept some props

name

unique name of the modal (required).

• type: String
• required: true
• default: modal-1

@on-close or v-bind:on-close

props function using to close the modal (required).

• type: function
• required: true

see example above.

headerOptions

options props for vue-modal-2 header

• type: Object
• default: {}

headerOptions key:

footerOptions

options props for vue-modal-2 footer

• type: Object
• default: {}

footerOptions key:

noFooter

used to remove footer

• type: Boolean
• default: false

  noHeader

  Used to remove header

• type: Boolean
• default: false

  wrapperBg

  Background color of modal wrapper (backdrop) (default is dark)

• type: String
• default: rgba(0, 0, 0, 0.5)

  darkMode

  Used to switch color mode

• type: Boolean
• default: false

  lightBg

  background color of modal dialog when mode is light

• type: String
• default: white

  darkBg

  background color of modal dialog when mode is dark

• type: String
• default: #06090f

  fontDark

  text color of modal when mode is dark

• type: String
• default: white

  fontLight

  text color of modal when mode is light

• type: String
• default: black

  modalSize

  size of modal dialog

• type: String
• value: md | lg | xl | full-w | full-hw | sidebar-l | sidebar-r

API

open(args)

accept modal name as args

close(args)

accept modal name as args

Contribution

Feel free to open an issue or pull request. Open an issue if you want discussing something.

Changelogs

More logs

1.1.6

• Add more modalSize options -> [sidebar-r, sidebar-l]
• Add little A11y

1.1.5

• Add props modalSize with value [md, lg, xl, full-w, full-hw]
• fix reponsiveness problems
• fix body overflow not automatically being scrollable

License

MIT © burhanahmeed and Initbase