確認對話框

ConfirmDialog 使用與確認 API 整合的對話框 UI。

匯入 #


import ConfirmDialog from 'primevue/confirmdialog';

服務 #

ConfirmDialog 通過需要作為應用程式外掛安裝的 ConfirmationService 進行控制。


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

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

該服務可通過組合 API 的 useConfirm 函數或使用選項 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	關閉對話框。