BlockUI can either block other components or the whole page.

import { BlockUIModule } from 'primeng/blockui';

The element to block should be placed as a child of BlockUI and blocked property is required to control the state.


Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

<p-button pRipple label="Block" (click)="blockedPanel = true" />
<p-button pRipple label="Unblock" (click)="blockedPanel = false" />
<p-blockUI [target]="pnl" [blocked]="blockedPanel">
    <i class="pi pi-lock" style="font-size: 3rem"></i>
<p-panel #pnl header="Header" styleClass="mt-4">
    <p class="m-0">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit...

If the target element is not specified, BlockUI blocks the document by default.

<p-blockUI [blocked]="blockedDocument" />

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

p-blockuiMask element.
p-blockui-documentMask element in full screen mode.

Screen Reader

BlockUI manages aria-busy state attribute when the UI gets blocked and unblocked. Any valid attribute is passed to the root element so additional attributes like role and aria-live can be used to define live regions.

Keyboard Support

Component does not include any interactive elements.