vue-element-dialog

Provides an imperative call to the el-dialog component in element-ui based on [email protected].

Install

npm i vue-element-dialog element-ui
# or pnpm
pnpm add vue-element-dialog element-ui

Usage

Register

import Vue from 'vue' // [email protected]
import ElementUI from 'element-ui'
import VueElementDialog from 'vue-element-dialog'
import 'element-ui/lib/theme-chalk/index.css'

Vue.use(ElementUI)
Vue.use(VueElementDialog, { center: true })

Invoking

App.vue:

<template>
  <div id="app">
    <el-button type="primary" @click="onOpen">onOpen</el-button>
  </div>
</template>

<script>
import YourComponent from 'path/to/YourComponent.vue'

export default {
  name: 'App',

  methods: {
    onOpen() {
      this.$dialog(
        // Your component will be shown in the default slot of the el-dialog component.
        YourComponent,
        // props and events configuration for the el-dialog component
        {
          // props
          visible: true,
          title: 'Your Title',
          // events
          opened() {
            console.log('has opened...')
          }
        }
      )
        .then((value) => {
          console.log(value)  // Follow or Like
        })
    }
  }
}
</script>

YourComponent.vue:

<template>
  <el-main>
    <h1>Hi</h1>
    <div>
      <el-button type="primary" @click="onLike">Like</el-button>
      <el-button type="primary" @click="onFollow">Follow</el-button>
    </div>
  </el-main>
</template>

<script>
export default {
  name: 'YourComponent',

  props: {
    msg: String
  },
  methods: {
    onLike() {
      this.$emit('close', 'Like')
    },
    onFollow() {
      this.$emit('close', 'Follow')
    }
  }
}
</script>

Options

Supports all of the props, events and slots defined on the el-dialog component.

slots

There are three ways of defining slots to be chosen from.

1. Directly passes your component, which will be shown in the default slot. e.g.

this.$dialog(MainComponent)

2. Provides an object where each key-value pair represents a slot supported by el-dialog. e.g.

this.$dialog({
  default: MainComponent,
  title: TitleComponent,
  footer: FooterComponent
})

3. Similar to the second way, it supports the components that have the props`` option and need the props` data. e.g.

this.$dialog({
  default: {
    component: MainComponent,
    propsData: {
      msg: 'Follow and Like it.'
    }
  }
})

props and events

The second parameter is used to configure all of the props and events supported by el-dialog. e.g.

this.$dialog(YourComponent, {
  // props
  visible: true,
  title: 'your title',
  // events
  opened() {
    console.log('has opened...')
  }
})

Injected Event

This plugin will inject a called close event into your component passed to the el-dialog. You can call it to close the current opened dialog and pass some values. The eventual state of the promise returned by calling this.$dialog will become resolved when calling the close event, so you will be able to access the values passed to the close event.

Note that due to the limitations of the resolve method, the type of the resolved value will vary depending on the number of arguments you pass to this $emit('close', ...). The value is undefined if you don't pass anything. The value is the argument itself if you pass one. The value is an array of arguments if you pass more than one. e.g.

this.$emit('close') // the value is `undefined`
this.$emit('close', { foo: 1 }) // the value is `{ foo: 1 }`
this.$emit('close', 'Follow', { number: 99 }) // the value is `['Follow', { number: 99 }]`

License

MIT