Vue Modal - Flowbite

Use the modal component to show interactive dialogs and notifications to your website users available in multiple sizes, colors, and styles

---

TIP

Original reference: https://flowbite.com/docs/components/modal/

The modal component can be used as an interactive dialog on top of the main content area of the website to show notifications and gather information using form elements from your website users.

Get started with multiple sizes, colors, and styles built with the utility classes from Tailwind CSS and the components from Flowbite.

Default modal

<template>
  <fwb-button @click="showModal">
    Open modal
  </fwb-button>

  <fwb-modal v-if="isShowModal" @close="closeModal">
    <template #header>
      <div class="flex items-center text-lg">
        Terms of Service
      </div>
    </template>
    <template #body>
      <p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
        With less than a month to go before the European Union enacts new consumer privacy laws for its citizens, companies around the world are updating their terms of service agreements to comply.
      </p>
      <p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
        The European Union’s General Data Protection Regulation (G.D.P.R.) goes into effect on May 25 and is meant to ensure a common set of data rights in the European Union. It requires organizations to notify users as soon as possible of high-risk data breaches that could personally affect them.
      </p>
    </template>
    <template #footer>
      <div class="flex justify-between">
        <fwb-button @click="closeModal" color="alternative">
          Decline
        </fwb-button>
        <fwb-button @click="closeModal" color="green">
          I accept
        </fwb-button>
      </div>
    </template>
  </fwb-modal>
</template>

<script lang="ts" setup>
import { ref } from 'vue'
import { FwbButton, FwbModal } from 'flowbite-vue'

const isShowModal = ref(false)

function closeModal () {
  isShowModal.value = false
}
function showModal () {
  isShowModal.value = true
}
</script>

Size

You can use four different modal sizing options starting from small to extra large, but keep in mind that the width of these modals will remain the same when browsing on smaller devices.

xs, sm, md, lg, xl, 2xl, 3xl, 4xl, 5xl, 6xl, 7xl

The default value is: 2xl

<template>
  <fwb-modal size="xs" />
  <fwb-modal size="md" />
  <fwb-modal size="xl" />
  <fwb-modal size="5xl" />
</template>

<script setup>
import { FwbModal } from 'flowbite-vue'
</script>

Position

The position prop allows you to control the placement of the modal on the screen, taking into account RTL (Right-to-Left) mode. You can choose from the following options:

top-start, top-center, top-end, center-start, center, center-end, bottom-start, bottom-center, bottom-end

The default value is: center

<template>
  <fwb-modal position="top-start" />
  <fwb-modal position="top-center" />
  <fwb-modal position="top-end" />
  <fwb-modal position="center-start" />
  <fwb-modal position="center" />
  <fwb-modal position="center-end" />
  <fwb-modal position="bottom-start" />
  <fwb-modal position="bottom-center" />
  <fwb-modal position="bottom-end" />
</template>

<script setup>
import { FwbModal } from 'flowbite-vue'
</script>

Escapable

The escapable property is true by default to improve user experience and accessibility.

This means that you may close the modal by

• Using the close button on the modal
• Clicking outside of the modal
• Pressing the escape key

In some situations, your user may be required to interact with the modal content. If this is the case, you can set the not-escapable property to true. The developer can then choose when they want to close the modal.

<template>
  <fwb-modal />
  <fwb-modal not-escapable />
</template>

<script setup>
import { FwbModal } from 'flowbite-vue'
</script>

Persistent

Clicking outside of the element or pressing esc key will not send close event.

<template>
  <fwb-modal persistent />
</template>

<script setup>
import { FwbModal } from 'flowbite-vue'
</script>

Focus Trap

You can enable focus trapping by setting the focus-trap prop to true. This keeps the focus within the modal, preventing users from tabbing to elements outside of it, which improves accessibility.

<template>
  <fwb-modal />
  <fwb-modal focus-trap />
</template>

<script setup>
import { FwbModal } from 'flowbite-vue'
</script>

API

Props:

Name	Values	Default
size	xs, sm, md,lg, xl, 2xl, 3xl, 4xl, 5xl, 6xl, 7xl	2xl
position	top-start, top-center, top-end, center-start, center, center-end, bottom-start, bottom-center, bottom-end	center
notEscapable	true, false	false
persistent	true, false	false
focusTrap	true, false	false

Events:

Name	Type
close	Clicked on the close button, pressed Esc, or clicked outside the modal content
click:outside	Clicked outside the modal content