V3 has reached EOL, Upgrade to PrimeVue 4

OverlayPanel

OverlayPanel, also known as Popover, is a container component that can overlay other components on page.

Import #


import OverlayPanel from 'primevue/overlaypanel';

Basic #

OverlayPanel is accessed via its ref and visibility is controlled using toggle, show and hide functions with an event of the target.


<Button type="button" icon="pi pi-image" label="Image" @click="toggle" />

<OverlayPanel ref="op">
    <div class="flex flex-column gap-3 w-25rem">
        <div>
            <span class="font-medium text-900 block mb-2">Share this document</span>
            <InputGroup>
                <InputText value="https://primevue.org/12323ff26t2g243g423g234gg52hy25XADXAG3" readonly class="w-25rem"></InputText>
                <InputGroupAddon>
                    <i class="pi pi-copy"></i>
                </InputGroupAddon>
            </InputGroup>
        </div>
        <div>
            <span class="font-medium text-900 block mb-2">Invite Member</span>
            <InputGroup>
                <Chips disabled></Chips>
                <Button label="Invite" icon="pi pi-users"></Button>
            </InputGroup>
        </div>
        <div>
            <span class="font-medium text-900 block mb-2">Team Members</span>
            <ul class="list-none p-0 m-0 flex flex-column gap-3">
                <li v-for="member in members" :key="member.name" class="flex align-items-center gap-2">
                    <img :src="`https://primefaces.org/cdn/primevue/images/avatar/${member.image}`" style="width: 32px" />
                    <div>
                        <span class="font-medium">{{ member.name }}</span>
                        <div class="text-sm text-color-secondary">{{ member.email }}</div>
                    </div>
                    <div class="flex align-items-center gap-2 text-color-secondary ml-auto text-sm">
                        <span>{{ member.role }}</span>
                        <i class="pi pi-angle-down"></i>
                    </div>
                </li>
            </ul>
        </div>
    </div>
</OverlayPanel>

DataTable #

An example that displays a DataTable inside a popup to select an item.

Bamboo Watch$65

Accessories


<Toast />
<Button type="button" icon="pi pi-search" :label="selectedProduct ? selectedProduct.name : 'Select a Product'" @click="toggle" aria-haspopup="true" aria-controls="overlay_panel" />

<div v-if="selectedProduct" class="p-5 surface-card border-round">
    <div class="relative">
        <img :src="`/images/product/${selectedProduct.image}`" :alt="selectedProduct.name" class="w-4rem shadow-1" class="w-full sm:w-20rem" />
    </div>
    <div class="flex align-items-center justify-content-between mt-3 mb-2">
        <span class="text-900 font-semibold text-xl">{{ selectedProduct.name }}</span>
        <span class="text-900 text-xl ml-3">{{ '$' + selectedProduct.price }}</span>
    </div>
    <span class="text-600">{{ selectedProduct.category }}</span>
</div>

<OverlayPanel ref="op" appendTo="body">
    <DataTable v-model:selection="selectedProduct" :value="products" selectionMode="single" :paginator="true" :rows="5" @row-select="onProductSelect">
        <Column field="name" header="Name" sortable style="width: 50%"></Column>
        <Column header="Image" style="width: 20%">
            <template #body="slotProps">
                <img :src="`/images/product/${selectedProduct.image}`" :alt="slotProps.data.image" class="w-4rem shadow-1" />
            </template>
        </Column>
        <Column field="price" header="Price" sortable style="width: 30%">
            <template #body="slotProps">
                $ {{ slotProps.data.price }}
            </template>
        </Column>
    </DataTable>
</OverlayPanel>

Accessibility #

Screen Reader

OverlayPanel component uses dialog 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.

OverlayPanel adds aria-expanded state attribute and aria-controls to the trigger so that the relation between the trigger and the popup is defined.

OverlayPanel 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.

Key	Function
tab	Moves focus to the next the focusable element within the popup.
shift + tab	Moves focus to the previous the focusable element within the popup.
escape	Closes the popup and moves focus to the trigger.

Close Button Keyboard Support

Key	Function
enter	Closes the popup and moves focus to the trigger.
space	Closes the popup and moves focus to the trigger.

name	type	default	description
dismissable	boolean	true	Enables to hide the overlay when outside is clicked.
showCloseIcon	boolean	false	When enabled, displays a close icon at top right corner.
appendTo	HTMLElement \| HintedString<"body" \| "self"	body	A valid query selector or an HTMLElement to specify where the overlay gets attached.
baseZIndex	number	0	Base zIndex value to use in layering.
autoZIndex	boolean	true	Whether to automatically manage layering.
breakpoints	OverlayPanelBreakpoints	null	Object literal to define widths per screen size.
closeIcon	string	null	Icon to display in the overlaypanel close button.
pt	PassThrough<OverlayPanelPassThroughOptions	null	Used to pass attributes to DOM elements inside the component.
ptOptions	PassThroughOptions	null	Used to configure passthrough(pt) options of the component.
unstyled	boolean	false	When enabled, it removes component related styles in the core.
closeOnEscape	boolean	true	Specifies if pressing escape key should hide the dialog.

name	parameters	returnType	description
show		void	Callback to invoke when the overlay is shown.
hide		void	Callback to invoke when the overlay is hidden.

name	parameters	returnType	description
default		VNode<RendererNode, RendererElement, Object>[]	Custom content template.
closeicon		VNode<RendererNode, RendererElement, Object>[]	Custom close icon template.
container	scope: { onClose: () ⇒ void, // Close overlay panel function. onKeydown: (event: Event) ⇒ void, // Close button keydown function. closeCallback: () ⇒ void, // Close overlay panel function. keydownCallback: (event: Event) ⇒ void, // Close button keydown function. }	VNode<RendererNode, RendererElement, Object>[]	Custom container slot.

name	parameters	returnType	description
alignOverlay		void	Aligns overlay panel based on the current position of the container.
toggle	event: Event	void	Toggles the visibility of the overlay.
show	event: Event	void	Shows the overlay.
hide		void	Hides the overlay.

name	type	default	description
instance	any	null	Defines instance.
props	OverlayPanelProps	null	Defines valid properties.
state	OverlayPanelState	null	Defines current inline state.
attrs	any	null	Defines valid attributes.
parent	any	null	Defines parent options.
global	undefined \| object	null	Defines passthrough(pt) options in global config.

OverlayPanel

Import #

Basic #

DataTable #

Accessibility #

Screen Reader

OverlayPanel Keyboard Support

Close Button Keyboard Support

OverlayPanel API

OverlayPanel #

Props #

Emits #

Slots #

Methods #

Interfaces #

OverlayPanelPassThroughMethodOptions #

OverlayPanelPassThroughOptions #

OverlayPanelPassThroughAttributes #

OverlayPanelState #

OverlayPanelBreakpoints #

Types #

OverlayPanelPassThroughOptionType #

OverlayPanelPassThroughTransitionType #

name	type	default	description
root	OverlayPanelPassThroughOptionType	null	Used to pass attributes to the root's DOM element.
content	OverlayPanelPassThroughOptionType	null	Used to pass attributes to the content's DOM element.
closeButton	OverlayPanelPassThroughOptionType	null	Used to pass attributes to the close button's DOM element.
closeIcon	OverlayPanelPassThroughOptionType	null	Used to pass attributes to the close icon's DOM element.
hooks	ComponentHooks	null	Used to manage all lifecycle hooks.
transition	OverlayPanelPassThroughTransitionType	null	Used to control Vue Transition API.