使用自动导入的 useOverlay 可组合项以编程方式控制 Modal 和 Slideover 组件。
<script setup lang="ts">
import { LazyModalExample } from '#components'
const overlay = useOverlay()
const modal = overlay.create(LazyModalExample)
async function openModal() {
modal.open()
}
</script>
useOverlay 可组合项是使用 createSharedComposable 创建的，确保在整个应用程序中共享相同的叠加层状态。overlay.open()。然而，为了使其工作，叠加层组件必须发出一个 close 事件。有关详细信息，请参见下面的示例。useOverlay()
useOverlay 可组合项提供了全局管理叠加层的方法。每个创建的叠加层都返回一个带有自己方法的实例。
create(component: T, options: OverlayOptions): OverlayInstance
创建一个叠加层，并返回一个工厂实例。
false。false。open(id: symbol, props?: ComponentProps<T>): OpenedOverlay<T>
通过其 id 打开一个叠加层。
close(id: symbol, value?: any): void
通过其 id 关闭一个叠加层。
patch(id: symbol, props: ComponentProps<T>): void
通过其 id 更新一个叠加层。
unmount(id: symbol): void
通过其 id 从 DOM 中移除一个叠加层。
isOpen(id: symbol): boolean
使用其 id 检查一个叠加层是否打开。
overlays: Overlay[]
所有已创建的叠加层的内存列表。
open(props?: ComponentProps<T>): Promise<OpenedOverlay<T>>
打开叠加层。
<script setup lang="ts">
import { LazyModalExample } from '#components'
const overlay = useOverlay()
const modal = overlay.create(LazyModalExample)
function openModal() {
modal.open({
title: 'Welcome'
})
}
</script>
close(value?: any): void
关闭叠加层。
patch(props: ComponentProps<T>): void
更新叠加层的 props。
<script setup lang="ts">
import { LazyModalExample } from '#components'
const overlay = useOverlay()
const modal = overlay.create(LazyModalExample, {
title: 'Welcome'
})
function openModal() {
modal.open()
}
function updateModalTitle() {
modal.patch({ title: 'Updated Title' })
}
</script>
这是一个如何使用 useOverlay 可组合项的完整示例
<script setup lang="ts">
import { ModalA, ModalB, SlideoverA } from '#components'
const overlay = useOverlay()
// Create with default props
const modalA = overlay.create(ModalA, { 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 modalBInstance = modalB.open()
const input = await modalBInstance
// Pass the result from modalB to the slideover, and open it
slideoverA.open({ input })
}
</script>
<template>
<button @click="openModalA">Open Modal</button>
</template>
在此示例中，我们使用 useOverlay 可组合项来控制多个模态框和侧滑框。
当以编程方式打开叠加层（例如模态框、侧滑框等）时，叠加层组件只能访问包含 UApp 的组件（通常是 app.vue 或布局组件）注入的值。这是因为叠加层由 UApp 组件安装在页面上下文之外。
因此，不支持在页面或父组件中直接使用 provide()。要将提供的值传递给叠加层，推荐的方法是使用 props 代替。
<script setup lang="ts">
import { LazyModalExample } from '#components'
const providedValue = inject('valueProvidedInPage')
const modal = overlay.create(LazyModalExample, {
props: {
providedValue,
otherData: someValue
}
})
</script>