确认对话框

ConfirmDialog 使用与确认 API 集成的 Dialog UI。

导入 #


import ConfirmDialog from 'primevue/confirmdialog';

服务 #

ConfirmDialog 通过需要安装为应用程序插件的ConfirmationService进行控制。


import {createApp} from 'vue';
import ConfirmationService from 'primevue/confirmationservice';

const app = createApp(App);
app.use(ConfirmationService);

该服务可通过 Composition API 的 useConfirm 函数或 Options API 的应用程序的 $confirm 属性使用。


import { useConfirm } from "primevue/useconfirm";

const confirm = useConfirm();

基本 #

通过调用 $confirm 实例的 require 方法并传递选项以自定义对话框来显示 ConfirmDialog。target 属性是强制性的，用于将弹出窗口与其引用器对齐。


<ConfirmDialog></ConfirmDialog>
<Button @click="confirm1()" label="Save" outlined></Button>
<Button @click="confirm2()" label="Delete" severity="danger" outlined></Button>

位置 #

确认选项的 position 属性指定对话框的位置。


<ConfirmDialog group="positioned"></ConfirmDialog>
<div class="flex flex-wrap justify-center gap-2 mb-4">
    <Button @click="confirmPosition('left')" icon="pi pi-arrow-right" label="Left" severity="secondary" style="min-width: 10rem"></Button>
    <Button @click="confirmPosition('right')" icon="pi pi-arrow-left" label="Right" severity="secondary" style="min-width: 10rem"></Button>
</div>
<div class="flex flex-wrap justify-center gap-2 mb-4">
    <Button @click="confirmPosition('topleft')" icon="pi pi-arrow-down-right" label="TopLeft" severity="secondary" style="min-width: 10rem"></Button>
    <Button @click="confirmPosition('top')" icon="pi pi-arrow-down" label="Top" severity="secondary" style="min-width: 10rem"></Button>
    <Button @click="confirmPosition('topright')" icon="pi pi-arrow-down-left" label="TopRight" severity="secondary" style="min-width: 10rem"></Button>
</div>
<div class="flex flex-wrap justify-center gap-2">
    <Button @click="confirmPosition('bottomleft')" icon="pi pi-arrow-up-right" label="BottomLeft" severity="secondary" style="min-width: 10rem"></Button>
    <Button @click="confirmPosition('bottom')" icon="pi pi-arrow-up" label="Bottom" severity="secondary" style="min-width: 10rem"></Button>
    <Button @click="confirmPosition('bottomright')" icon="pi pi-arrow-up-left" label="BottomRight" severity="secondary" style="min-width: 10rem"></Button>
</div>

模板 #

模板允许自定义消息内容。


<ConfirmDialog group="templating">
    <template #message="slotProps">
        <div class="flex flex-col items-center w-full gap-4 border-b border-surface-200 dark:border-surface-700">
            <i :class="slotProps.message.icon" class="!text-6xl text-primary-500"></i>
            <p>{{ slotProps.message.message }}</p>
        </div>
    </template>
</ConfirmDialog>
<Button @click="showTemplate()" label="Save"></Button>

无头 #

通过定义一个 container 插槽来启用无头模式，该插槽允许您实现整个确认 UI，而不是默认元素。


<ConfirmDialog group="headless">
    <template #container="{ message, acceptCallback, rejectCallback }">
        <div class="flex flex-col items-center p-8 bg-surface-0 dark:bg-surface-900 rounded">
            <div class="rounded-full bg-primary text-primary-contrast inline-flex justify-center items-center h-24 w-24 -mt-20">
                <i class="pi pi-question text-5xl"></i>
            </div>
            <span class="font-bold text-2xl block mb-2 mt-6">{{ message.header }}</span>
            <p class="mb-0">{{ message.message }}</p>
            <div class="flex items-center gap-2 mt-6">
                <Button label="Save" @click="acceptCallback" class="w-32"></Button>
                <Button label="Cancel" outlined @click="rejectCallback" class="w-32"></Button>
            </div>
        </div>
    </template>
</ConfirmDialog>
<Button @click="requireConfirmation()" label="Save"></Button>

可访问性 #

屏幕阅读器

ConfirmDialog 组件使用 alertdialog 角色以及引用标题元素的 aria-labelledby，但是任何属性都将传递给根元素，因此您可以使用 aria-labelledby 来覆盖此默认行为。此外，由于焦点保持在弹出窗口内，因此添加了 aria-modal。

当使用 $confirm 实例的 require 方法并将触发器作为参数传递时，ConfirmDialog 会向触发器添加 aria-expanded 状态属性和 aria-controls，以便定义触发器和对话框之间的关系。


<ConfirmDialog id="confirm" />

<Button @click="openDialog()" label="Confirm" :aria-expanded="visible" :aria-controls="visible ? 'confirm' : null"></Button>


<script setup>
const confirm = useConfirm();
const isVisible = ref(false);

const openDialog = () => {
    confirm.require({
        message: 'Are you sure you want to proceed?',
        header: 'Confirmation',
        onShow: () => {
            isVisible.value = true;
        },
        onHide: () => {
            isVisible.value = false;
        }
    });
};
</script>

覆盖键盘支持

按键	功能
tab	将焦点移动到对话框中下一个可聚焦的元素。
shift + tab	将焦点移动到对话框中上一个可聚焦的元素。
escape	关闭对话框。

按钮键盘支持

按键	功能
enter	关闭对话框。
space	关闭对话框。