0.0.5 • Published 11 months ago

vue-smooth-modal v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Vue 3 Smooth Modal

Vue 3 Smooth Modal is~ a modal window package designed for Vue 3 that provides exceptionally smooth transitions for showing and hiding modals. Its focus is on delivering a seamless user experience, with fluid animations and effortless integration into any Vue 3 project. This package simplifies the process of managing modals, ensuring both visual appeal and high performance

Demo

ezgif-4-266f7aa836

Installation

npm i vue-smooth-modal

Vue 3

Add dependencies to your main.js:

import { createApp } from 'vue'

import "vue-smooth-modal/dist/style.css"
import SmoothModal from "vue-smooth-modal"
// ...
app.use(SmoothModal)

Nuxt 3

Create ./plugins/vue-smooth-modal.js

import "vue-smooth-modal/dist/style.css"
import SmoothModal from "vue-smooth-modal"

export default defineNuxtPlugin((nuxtApp) => {
    nuxtApp.vueApp.use(SmoothModal)
})

Usage

<script setup>
    import { ref } from 'vue'

    const show = ref(false)
    const reModal = ref(null)
    // reModal.value.close()

    const onClose = () => console.log("close")
</script>

<template>
    <SmoothModal v-model="show" ref="reModal" :use-skeleton="true" @close="onClose" class="custom-background">
        <p>
            This is an example of displaying text in a modal window
        </p>
    </SmoothModal>

    <a href="#" @click.prevent="show = true">Toggle</a>
</template>

<style>
    .custom-background {
        --tvbird-modal-overlay: rgb(239 192 222 / 25%);
    }
</style>

Props

AttributeTypeDefaultDescription
durationNumber700show and hide duration
easingStringease-in-outeasing
showCloseBooleantrueDisplay the modal close icon
closeOnEscBooleantrueClose the modal by pressing the Esc key
closeOnOverlayBooleantrueClose the modal by clicking on the overlay
isImageBooleanfalseImage inside. Image preloading with an SVG preloader
useSkeletonBooleanfalseUse a CSS template

Emits

EventDescription
closeTriggered when the modal window is closed

Slots

slot namedescription
closeCustom close button
preloaderCustom preloader
0.0.5

11 months ago

0.0.4

11 months ago

0.0.3

11 months ago

0.0.2

11 months ago

0.0.1

11 months ago