Step by step

Two ways to open a modal

  • Set v-model to true

    <template>
  <div>
    <vue-final-modal v-model="showModal">
      Modal Content Here
    </vue-final-modal>
    <button @click="showModal = true">Open Modal</button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

  • Open modal with the API

    v-model is necessary when you open a modal with $vfm.show(name) API. 
    <template>
  <vue-final-modal v-model="showModal" name="example">
      Modal Content Here
  </vue-final-modal>
  <button @click="openModalExample">Open Modal</button>
</template>

    <script>
export default {
  data: () => ({
      showModal: false
  }),
  methods: {
    openModalExample() {
      this.$vfm.show('example')
    }
  }
}
</script>

Custom the modal style

  • Hello, vue-final-modal

    <template>
  <div>
    <vue-final-modal v-model="showModal">
      <span class="modal__title">Hello, vue-final-modal</span>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
.modal__title {
  font-size: 1.5rem;
  font-weight: 700;
}
</style>

  • Add background-color, border-radius

    <template>
  <div>
    <vue-final-modal v-model="showModal" content-class="modal-content">
      <span class="modal__title">Hello, vue-final-modal</span>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-content {
  display: inline-block;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  font-size: 1.5rem;
  font-weight: 700;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Centered modal

    <template>
  <div>
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <span class="modal__title">Hello, vue-final-modal</span>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  display: flex;
  flex-direction: column;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  font-size: 1.5rem;
  font-weight: 700;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Add content

    <template>
  <div>
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <span class="modal__title">Hello, vue-final-modal</span>
      <div class="modal__content">
        <p>Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.</p>
      </div>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  display: flex;
  flex-direction: column;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  font-size: 1.5rem;
  font-weight: 700;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Add close button

    <template>
  <div>
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <button class="modal__close" @click="showModal = false">
        <mdi-close></mdi-close>
      </button>
      <span class="modal__title">Hello, vue-final-modal</span>
      <div class="modal__content">
        <p>Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.</p>
      </div>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  position: relative;
  display: flex;
  flex-direction: column;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  margin: 0 2rem 0 0;
  font-size: 1.5rem;
  font-weight: 700;
}
.modal__close {
  position: absolute;
  top: 0.5rem;
  right: 0.5rem;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Scrollable

    <template>
  <div>
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <button class="modal__close" @click="showModal = false">
        <mdi-close></mdi-close>
      </button>
      <span class="modal__title">Hello, vue-final-modal</span>
      <div class="modal__content">
        <p v-for="i in 100" :key="i">
          Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.
        </p>
      </div>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  position: relative;
  display: flex;
  flex-direction: column;
  max-height: 90%;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  margin: 0 2rem 0 0;
  font-size: 1.5rem;
  font-weight: 700;
}
.modal__content {
  flex-grow: 1;
  overflow-y: auto;
}
.modal__close {
  position: absolute;
  top: 0.5rem;
  right: 0.5rem;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Add confirm and cancel buttons

    <template>
  <div>
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <button class="modal__close" @click="showModal = false">
        <mdi-close></mdi-close>
      </button>
      <span class="modal__title">Hello, vue-final-modal</span>
      <div class="modal__content">
        <p v-for="i in 100" :key="i">
          Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.
        </p>
      </div>
      <div class="modal__action">
        <v-button @click="showModal = false">confirm</v-button>
        <v-button @click="showModal = false">cancel</v-button>
      </div>
    </vue-final-modal>
    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false
  })
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  position: relative;
  display: flex;
  flex-direction: column;
  max-height: 90%;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  margin: 0 2rem 0 0;
  font-size: 1.5rem;
  font-weight: 700;
}
.modal__content {
  flex-grow: 1;
  overflow-y: auto;
}
.modal__action {
  display: flex;
  justify-content: center;
  align-items: center;
  flex-shrink: 0;
  padding: 1rem 0 0;
}
.modal__close {
  position: absolute;
  top: 0.5rem;
  right: 0.5rem;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Stackable

    <template>
  <div>
    <!-- First modal -->
    <vue-final-modal v-model="showModal" classes="modal-container" content-class="modal-content">
      <button class="modal__close" @click="showModal = false">
        <mdi-close></mdi-close>
      </button>
      <span class="modal__title">Hello, vue-final-modal</span>
      <div class="modal__content">
        <p v-for="i in 5" :key="i">
          Vue Final Modal is a renderless, stackable, detachable and lightweight modal component.
        </p>
      </div>
      <div class="modal__action">
        <v-button highlight @click="showConfirmModal = true">confirm</v-button>
        <v-button @click="showModal = false">cancel</v-button>
      </div>
    </vue-final-modal>

    <!-- Second modal -->
    <vue-final-modal v-model="showConfirmModal" classes="modal-container" content-class="modal-content">
      <button class="modal__close" @click="showConfirmModal = false">
        <mdi-close></mdi-close>
      </button>
      <span class="modal__title">Confirm</span>
      <div class="modal__content">Confirm to submit.</div>
      <div class="modal__action">
        <v-button @click="confirm">confirm</v-button>
        <v-button @click="showConfirmModal = false">cancel</v-button>
      </div>
    </vue-final-modal>

    <v-button @click="showModal = true">Open modal</v-button>
  </div>
</template>

    <script>
export default {
  data: () => ({
    showModal: false,
    showConfirmModal: false
  }),
  methods: {
    confirm() {
      this.showConfirmModal = false
      this.showModal = false
    }
  }
}
</script>

    <style scoped>
::v-deep .modal-container {
  display: flex;
  justify-content: center;
  align-items: center;
}
::v-deep .modal-content {
  position: relative;
  display: flex;
  flex-direction: column;
  max-height: 90%;
  margin: 0 1rem;
  padding: 1rem;
  border: 1px solid #e2e8f0;
  border-radius: 0.25rem;
  background: #fff;
}
.modal__title {
  margin: 0 2rem 0.5rem 0;
  font-size: 1.5rem;
  font-weight: 700;
}
.modal__content {
  flex-grow: 1;
  overflow-y: auto;
}
.modal__action {
  display: flex;
  justify-content: center;
  align-items: center;
  flex-shrink: 0;
  padding: 1rem 0 0;
}
.modal__close {
  position: absolute;
  top: 0.5rem;
  right: 0.5rem;
}
</style>

<style scoped>
.dark-mode div::v-deep .modal-content {
  border-color: #2d3748;
  background-color: #1a202c;
}
</style>

  • Accessibility

    <template>
  <vue-final-modal ... focus-trap>
    ...modal content
  </vue-final-modal>
</template>
Edit this page on GitHub Updated at Fri, Feb 3, 2023
Live Demo Tailwind usage