ConfirmPopup

ConfirmPopup displays a confirmation overlay displayed relatively to its target.

Import #


import { ConfirmPopupModule } from 'primeng/confirmpopup';

Basic #

ConfirmPopup is defined using p-confirmPopup tag and an instance of ConfirmationService is required to display it bycalling confirm method.


<p-toast />
<p-confirmPopup />
<p-button 
    (click)="confirm1($event)" 
    label="Save" 
    [outlined]="true" />
<p-button 
    (click)="confirm2($event)" 
    label="Delete" 
    severity="danger" 
    [outlined]="true" />

Template #

Content section can be customized using content template.


<p-toast />
    <p-confirmPopup>
        <ng-template pTemplate="content" let-message>
            <div class="flex flex-column align-items-center w-full gap-3 border-bottom-1 surface-border p-3 mb-3">
                <i [class]="message.icon" class="text-6xl text-primary-500"></i>
                <p>{{ message.message }}</p>
            </div>
        </ng-template>
    </p-confirmPopup>
<p-button (onClick)="confirm($event)" label="Save" />

Headless #

Headless mode allows you to customize the entire user interface instead of the default elements.


<p-toast />
    <p-confirmPopup #confirmPopupRef>
        <ng-template pTemplate="headless" let-message let-test>
            <div class="border-round p-3">
                <span>{{ message.message }}</span>
                <div class="flex align-items-center gap-2 mt-3">
                    <p-button (onClick)="accept()" label="Save" size="small" />
                    <p-button (onClick)="reject()" label="Cancel" [outlined]="true" size="small" />
                </div>
            </div>
        </ng-template>
    </p-confirmPopup>
<p-button (onClick)="confirm($event)" label="Save" />

Style #

Following is the list of structural style classes, for theming classes visit theming page.

NameElement
p-confirm-popupContainer element
p-confirm-popup-contentContent element.
p-confirm-popup-iconMessage icon.
p-confirm-popup-messageMessage text.
p-confirm-popup-footerFooter element for buttons.

Accessibility #

Screen Reader

ConfirmPopup component uses alertdialog role and since any attribute is passed to the root element you may define attributes like aria-label or aria-labelledby to describe the popup contents. In addition aria-modal is added since focus is kept within the popup.

It is recommended to use a trigger component that can be accessed with keyboard such as a button, if not adding tabIndex would be necessary. ConfirmPopup adds aria-expanded state attribute and aria-controls to the trigger so that the relation between the trigger and the popup is defined.

Overlay Keyboard Support

When the popup gets opened, the first focusable element receives the focus and this can be customized by adding autofocus to an element within the popup.

KeyFunction
tabMoves focus to the next the focusable element within the popup.
shift + tabMoves focus to the previous the focusable element within the popup.
escapeCloses the popup and moves focus to the trigger.

Buttons Keyboard Support

KeyFunction
enterTriggers the action, closes the popup and moves focus to the trigger.
spaceTriggers the action, closes the popup and moves focus to the trigger.
PrimeNG 17.18.12 by PrimeTek