Open In App

Angular PrimeNG Overlay Complete Reference

Last Updated : 23 Jul, 2025
Comments
Improve
Suggest changes
Like Article
Like
Report

Angular PrimeNG Overlay facilitates the rendering of the content/ confirmation windows, which is shared with multiple actions for the same component. The overlay can also be created dynamically for the dialogs to display the content, & can also displayed from the edges of the screen by making the Sidebar panel, in order to show the informative data by using the Tooltip directive.

The complete list of Overlay Components is listed below with their brief description:

ConfirmDialog Component

ConfirmDialog component is used to make a dialog box containing a confirm button to confirm the element.

Components

Descriptions

ConfirmDialog BasicThe ConfirmDialog component is used to make a dialog box containing a confirm button to confirm the element.
ConfirmDialog PositionThe ConfirmDialog component is used to make a dialog box containing a confirm button to confirm the element.
ConfirmDialog ResponsiveBreakpoints should have an object literal as their value, with keys representing the largest screen sizes and values representing the widths of each screen.
ConfirmDialog EventsThis is used for Callback to invoke when the dialog is hidden.
ConfirmDialog ConfirmationServiceThe ConfirmationService can be implemented to display the dialog box for the confirmation object options, or hide the dialog box without invoking accept or reject the callbacks.
ConfirmDialog CustomizationThis can be used to customize the confirmdialog by using customization Properties.
ConfirmDialog Animation ConfigurationIt is used to set the transition options of the show and hide animation.
ConfirmDialog PropertiesAngular PrimeNG ConfirmDialog Properties are message, key, icon, header, etc.
ConfirmDialog TemplatesThe templates are used to put some content on some pre-structured containers.
ConfirmDialog StylingIt can be defined using the p-confirmDialog tag and using the confirm method on an instance of ConfirmationService is necessary to display it.

ConfirmPopup Component:

The ConfirmPopup Component is used as a confirmation overlay and is shown relative to the target.

Components

Descriptions

ConfirmPopup ConfirmationServiceThe ConfirmPopup Component is used as a confirmation overlay and is shown relative to the target.
ConfirmPopup Animation ConfigurationIt is used to set the transition options of the show animation.
ConfirmPopup PropertiesThe ConfirmPopup Component is used to display a confirmation overlay next to the target
ConfirmPopup StylingThe ConfirmPopup Component is displayed as a confirmation overlay.

Dialog Component

The Dialog Component is used to make a component containing some content to display in an overlay window.

Components

Descriptions

Dialog BasicDialog component is used to make a component containing some content to display in an overlay window.
Dialog ModalDialog component is used to make a component containing some content to display in an overlay window.
Dialog MaximizableUsing the [maximizable]=”true”, we can maximize the dialog to the full screen.
Dialog PositionThe position property, with the default value of center, controls where the dialogue appears.
Dialog DimensionsUsing the [style] property, we can specify the dimensions of the dialog.
Dialog Responsivewith keys representing the largest screen sizes and values representing the widths of the dialog.
Dialog Header and FooterIt is the title text of the dialog. It is of string data type, the default value is null.
Dialog PositioningIt is used to set the position of the dialog. It is of string data type, the default value is center.
Dialog Overlays InsideAs dialog displays content in an overlay window, now suppose the content in the dialog is a dropdown.
Dialog Initial FocusWhen the dialogue is shown, an element with autofocus receives focus.
Dialog Animation ConfigurationIt is used to set the transition options of the animation. It is of string data type, the default value is 150ms cubic-bezier(0, 0, 0.2, 1).
Dialog PropertiesAngular PrimeNG Dialog Properties are baseZIndex, autoZIndex, minX, minY, focusOnShow, focusTrap, maximizable, etc.
Dialog EventsAngular PrimeNG Dialog Events are onShow, onside, onResizeInit, onResizeEnd, onDragEnd, onMaximize.
Dialog TemplatesThe templates are used to put some content on some pre-structured containers.
Dialog StylingThis class is for applying custom styling to the container element.

Dynamic Dialog Component:

There are various components provided by the Angular PrimeNG in the Dynamic Dialog Component, There are various components provided by the Angular PrimeNG in the Dynamic Dialog Component,

Components

Descriptions

Properties for DynamicDialogThere are various property options provided by Angular PrimeNG that can be utilized for the customization of the Dynamic Dialog Component.
Dynamic Dialog EventsAngular PrimeNG provides different events, like, resizing, dragging, destroying, or closing the Dialog Component, etc,
Dynamic Dialog StylingThis component helps to make the interactive Dialog by implementing the different stylings provided by Angular PrimeNG.

OverlayPanel Component

The OverlayPanel Component acts as the container component that renders the overlay with the targeted position.

Components

Descriptions

Dynamic OverlayPanel Show and HideThe show method requires two parameters, the first of which is the mandatory event.
Dynamic OverlayPanel Dismissable and CloseIconIf dismissible is set to true, clicking outside the panel closes it.
Dynamic OverlayPanel Animation ConfigurationThe Dynamic OverlayPanel Animation Configuration allows configuring the default animation with which the popup appears.
Dynamic OverlayPanel PropertiesThe properties allow us to customize the component easily which extends the functionality of the component.
Dynamic OverlayPanel EventsThis is used for Callback to invoke when an overlay becomes visible.
Dynamic OverlayPanel TemplatesThe templates in OverlayPanel are used to put some content on some pre-structured containers and we don’t need to modify much to suit different needs.
Dynamic OverlayPanel StylingStyling is used to override some default styles to match the theme of the site that we are working on.

Sidebar Component

The Sidebar Component is used to make an element that overlays at the edges of the screen.

Components

Descriptions

Sidebar PositionSidebar Position is used to define the location of the sidebar as left, right, top, and bottom. The default location is left.
Sidebar SizeSidebar size can be used to adjust the size of the sidebar using the fixed values or by using the already defined values as p-sidebar–sm, p-sidebar-md, and p-sidebar-lg.
Sidebar Animation ConfigurationIt is used to set the style class of the component. It is of string data type & the default value is null.
Sidebar Full ScreenSidebar fullScreen=”true” may be utilized to make the sidebar take up the entire screen.
Sidebar PropertiesIt specifies the visibility of the dialog. It is of the boolean data type, the default value is false.
Sidebar EventsIt is a callback that is fired when a dialog is shown.
Sidebar TemplatesIt is a pattern that is used as a user guide to create something.
Sidebar Stylingstyling properties, such as positioning the sidebar, closing or adjusting the size of the sidebar, etc.

Tooltip Component

The Tooltip Component is used to make an element that provides advisory information for a component.

Components

Descriptions
Tooltip PositionsIt is the position of the tooltip. It is of string data type & the default value is right.
Tooltip Focus and BlurTooltip Focus and Blur are used to display a tooltip around the target element when the focus event is triggered and it disappears when the blur event is triggered.
Tooltip ButtonTooltip Button is used to make a tooltip around a button that provides advisory information about it.
Tooltip EventsIt represents the text in the Tooltip. It is of string type & its default value is null.
Tooltip DelayAngular PrimeNG Tooltip Delay is used to show or hide tooltips quickly by default,
Tooltip Scrolling ContainersThe Tooltip Scrolling Containers can be used to add a tooltip to another element with relative positioning rather than the document body,
Tooltip PropertiesIt defines the position of the tooltip. It is of string data type & the default value is right.
Tooltip StylingThe Tooltip component is used to make an element that provides advisory information for a component

Similar Reads