useOverlay

Usage

Use the auto-imported useOverlay composable to programmatically control Modal and Slideover components.

<script setup lang="ts">
import { LazyModalExample } from '#components'

const overlay = useOverlay()

const modal = overlay.create(LazyModalExample)

async function openModal() {
  modal.open()
}
</script>

• The useOverlay composable is created using createSharedComposable, ensuring that the same overlay state is shared across your entire application.

API

useOverlay()

The useOverlay composable provides methods to manage overlays globally. Each created overlay returns an instance with its own methods.

create()

create(component: T, options: OverlayOptions): OverlayInstance

Create an overlay, and return a factory instance.

Parameters

:: ::

open()

open(id: symbol, props?: ComponentProps<T>): OpenedOverlay<T>

Open an overlay by its id.

Parameters

close()

close(id: symbol, value?: any): void

Close an overlay by its id.

Parameters

closeAll()

closeAll(): void

Close all open overlays.

patch()

patch(id: symbol, props: Partial<ComponentProps<T>>): void

Update an overlay by its id.

Parameters

unmount()

unmount(id: symbol): void

Remove an overlay from the DOM by its id.

Parameters

isOpen()

isOpen(id: symbol): boolean

Check if an overlay is open using its id.

Parameters

overlays

overlays: Overlay[]

In-memory list of all overlays that were created.

Instance API

open()

open(props?: ComponentProps<T>): OpenedOverlay<T>

Open the overlay. Returns an OpenedOverlay which is a Promise that resolves with the value emitted by the close event.

Parameters

<script setup lang="ts">
import { LazyModalExample } from '#components'

const overlay = useOverlay()

const modal = overlay.create(LazyModalExample)

function openModal() {
  modal.open({
    title: 'Welcome'
  })
}
</script>

close()

close(value?: any): void

Close the overlay.

Parameters

patch()

patch(props: Partial<ComponentProps<T>>): void

Update the props of the overlay.

Parameters

<script setup lang="ts">
import { LazyModalExample } from '#components'

const overlay = useOverlay()

const modal = overlay.create(LazyModalExample, {
  props: { title: 'Welcome' }
})

function openModal() {
  modal.open()
}

function updateModalTitle() {
  modal.patch({ title: 'Updated Title' })
}
</script>

Examples

With multiple overlays

This example demonstrates how to manage multiple overlays and pass data between them:

<script setup lang="ts">
import { ModalA, ModalB, SlideoverA } from '#components'

const overlay = useOverlay()

// Create with default props
const modalA = overlay.create(ModalA, { props: { title: 'Welcome' } })
const modalB = overlay.create(ModalB)
const slideoverA = overlay.create(SlideoverA)

const openModalA = () => {
  // Open modalA, but override the title prop
  modalA.open({ title: 'Hello' })
}

const openModalB = async () => {
  // Open modalB, and wait for its result
  const input = await modalB.open()

  // Pass the result from modalB to the slideover, and open it
  slideoverA.open({ input })
}
</script>

<template>
  <UButton label="Open Modal" @click="openModalA" />
</template>

Confirm dialog

This example demonstrates how to create a reusable confirm dialog pattern using a custom useConfirmDialog composable that wraps useOverlay. This approach enables opinionated dialogs tailored to specific business requirements and design preferences.

1. Create a ConfirmDialog component that emits a boolean value when closed:

<script lang="ts" setup>
interface ConfirmDialogProps {
  title?: string
  description?: string
}

defineProps<ConfirmDialogProps>()

const emits = defineEmits<{
  close: [value: boolean]
}>()
</script>

<template>
  <UModal
    :title="title"
    :description="description"
    :dismissible="false"
    :ui="{ footer: 'justify-end' }"
  >
    <template #footer>
      <UButton label="Cancel" color="neutral" variant="outline" @click="emits('close', false)" />
      <UButton label="Confirm" color="neutral" @click="emits('close', true)" />
    </template>
  </UModal>
</template>

2. Create a useConfirmDialog composable that returns a Promise:

import { ConfirmDialog } from '#components'

export interface ConfirmDialogOptions {
  title: string
  description?: string
}

export const useConfirmDialog = () => {
  const overlay = useOverlay()

  return (options: ConfirmDialogOptions): Promise<boolean> => {
    const modal = overlay.create(ConfirmDialog, {
      destroyOnClose: true,
      props: options
    })

    return modal.open()
  }
}

3. Use the composable in your components:

<script setup lang="ts">
const confirm = useConfirmDialog()

const handleDelete = async () => {
  const confirmed = await confirm({
    title: 'Delete item',
    description: 'Are you sure you want to delete this item?'
  })

  if (confirmed) {
    console.log('Item deleted')
  }
}
</script>

<template>
  <UButton label="Delete item" @click="handleDelete" />
</template>

Caveats

Provide / Inject

When opening overlays programmatically (e.g. modals, slideovers, etc), the overlay component can only access injected values from the component containing UApp (typically app.vue or layout components). This is because overlays are mounted outside of the page context by the UApp component.

As such, using provide() in pages or parent components isn't supported directly. To pass provided values to overlays, the recommended approach is to use props instead:

<script setup lang="ts">
import { LazyModalExample } from '#components'

const overlay = useOverlay()

const providedValue = inject('valueProvidedInPage')

const modal = overlay.create(LazyModalExample, {
  props: {
    providedValue
  }
})
</script>