jenesius-vue-modal

Jenesius Vue Modal

Jenesius vue modal is simple library for Vue 3 only .

• Site
• Documentation

Installation

npm i jenesius-vue-modal

---

For add modals in your project you need to put the modal's container in the App component:

App.vue

<template>
    <widget-container-modal />
</template>
<script>
    import {container} from "jenesius-vue-modal";
    
    export default {
        components: {WidgetContainerModal: container},
        name: "App"
    }
</script>

OpenModal

Methods openModal and pushModal used to display modal windows.

• openModal - close all previous modals and then display provided component.
• pushModal - display provided component

    import {openModal} from "jenesius-vue-modal";
    import SomeVueComponent from "SomeVueComponent.vue";

    openModal(SomeVueComponent, props);

• props will provide in your component, example

Methods return promise, in this case promise is resolved - modalObject

    const modal = await openModal(SomeVueComponent); // {id, close, onclose, closed}

Methods

• openModal - close all modals and then open provided modal.
• pushModal - add one more provided modal.
• closeModal- close all modals.
• popModal - close last opened modal.

Lifecycle Hooks

There are three ways to track the closing of a modal:

---

Versions is higher than 1.2.0 NOT support 'next'. Now All hooks use only returned value(Boolean) for navigation hooks. If function return false or throwing an Error modal window will not be closed.

---

• onclose

const modal = await openModal(Modal);
modal.onclose = () => {
    console.log("Close");
    return false; //Modal will not be closed
}

• default component

    export default {
        props: {},
        data: () => ({isValidate: false}),
        beforeModalClose(){
            console.log("Close");
            
            if (!isValidate) return false; //modal will not be closed while isValidate === false
            
        }
    }

• Composition style

    export default{
        setup() {
            onBeforeModalClose(() => {
                console.log("Close");
            });
        }
    }

Async/Await

Hooks also can be asynchronous functions:

    async beforeModalClose(){
        await doSome();
        return false; // This modal can not be closed!
    }

or

    beforeModalClose(){
        return Promise(resolve => {
            setTimeout(() => resolve(true), 2000); //Modal will closed after 2 second
        })
    }

Integration with VueRouter

For integrate modals into VueRouter you need to initialize your application:

• Provide router to the useModalRouter:

import {createWebHistory, createRouter} from "vue-router";
import {useModalRouter} from "jenesius-vue-modal";

const router = createRouter({
    history: createWebHistory(), 
    routes: [...],
});

useModalRouter.init(router);

• Wrap your component in a route handler:

import Modal from "Modal.vue"

const routes = [
    {
        path: "/any-route",
        component: useModalRouter(Modal)
    }
]

Now, when route will be /any-route the Modal window will open. For more information see Docs.

Style and Animation [1.3.1+]

Please refer to the documentation to change the styles or animations of modals.

Example VueModalComponent

WidgeTestModal.vue

    <template>
        <p>{{title}}</p>
    </template>
    <script>
        export default {
            props: {
                title: String
            }
        }
    </script>

To show this component

    import {openModal} from "jenesius-vue-modal"
    import WidgeTestModal from "WidgeTestModal.vue";

    openModal(WidgeTestModal, {
        title: "Hello World!"
    });

---

Do you like this module? Put a star on GitHub