Panel

Panel is a container component with an optional content toggle feature.

Import #


import { PanelModule } from 'primeng/panel';

Basic #

A simple Panel is created with a header property along with the content as children.

Header

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-panel header="Header">
    <p>
        Lorem ipsum dolor sit amet...
    </p>
</p-panel>

Toggleable #

Content of the panel can be expanded and collapsed using toggleable option, default state is defined with collapsed option. By default, toggle icon is used to toggle the contents whereas setting toggler to "header" enables clicking anywhere in the header to trigger a toggle.

Header


<p-panel header="Header" [toggleable]="true">
    <p>
        Lorem ipsum dolor sit amet...
    </p>
</p-panel>

Template #

Header and Footers sections can be customized using header and footer templates.

Amy Elsner

Updated 2 hours ago


<p-panel [toggleable]="true">
    <ng-template pTemplate="header">
        <div class="flex align-items-center gap-2">
            <p-avatar 
                image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" 
                size="large" 
                shape="circle" />
            <span class="font-bold">
                Amy Elsner
            </span>
        </div>
    </ng-template>
    <ng-template pTemplate="footer">
        <div class="flex flex-wrap align-items-center justify-content-between gap-3">
            <div class="flex align-items-center gap-2">
                <p-button icon="pi pi-user" rounded="true" text="true" />
                <p-button icon="pi pi-bookmark" severity="secondary" rounded="true" text="true" />
            </div>
            <span class="p-text-secondary">
                Updated 2 hours ago
            </span>
        </div>
    </ng-template>
    <ng-template pTemplate="icons">
        <button class="p-panel-header-icon p-link mr-2" (click)="menu.toggle($event)">
            <span class="pi pi-cog"></span>
        </button>
        <p-menu #menu id="config_menu" [model]="items" [popup]="true" />
    </ng-template>
    <p class="m-0">
        Lorem ipsum dolor sit amet...
    </p>
</p-panel>

Style #

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

Name	Element
p-panel	Container element.
p-panel-header	Header section.
p-panel-title	Title text of panel.
p-panel-header-icon	Toggle icon.
p-panel-content	Content of panel.

Accessibility #

Screen Reader

Toggleable panels use a content toggle button at the header that has aria-controls to define the id of the content section along with aria-expanded for the visibility state. The value to read the button defaults to the value of the header property and can be customized by defining an aria-label or aria-labelledby via the toggleButtonProps property.

The content uses region, defines an id that matches the aria-controls of the content toggle button and aria-labelledby referring to the id of the header.

Content Toggle Button Keyboard Support

Key	Function
tab	Moves focus to the next the focusable element in the page tab sequence.
shift + tab	Moves focus to the previous the focusable element in the page tab sequence.
enter	Toggles the visibility of the content.
space	Toggles the visibility of the content.

Panel API

API defines helper props, events and others for the PrimeNG Panel module.

Panel #

Panel is a container with the optional content toggle feature.

Properties #

Defines the input properties of the component.

name	type	default	description
toggleable	boolean	false	Defines if content of panel can be expanded and collapsed.
header	string	null	Header text of the panel.
collapsed	boolean	false	Defines the initial state of panel content, supports one or two-way binding as well.
style	Object	null	Inline style of the component.
styleClass	string	null	Style class of the component.
iconPos	"center" \| "end" \| "start"	end	Position of the icons.
expandIcon	string	null	Expand icon of the toggle button.
collapseIcon	string	null	Collapse icon of the toggle button.
showHeader	boolean	true	Specifies if header of panel cannot be displayed.
toggler	"header" \| "icon"	icon	Specifies the toggler element to toggle the panel content.
transitionOptions	string	400ms cubic-bezier(0.86, 0, 0.07, 1)	Transition options of the animation.

Emitters #

Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.

name	parameters	description
collapsedChange	value : boolean	Emitted when the collapsed changes.
onBeforeToggle	event : PanelBeforeToggleEvent	Callback to invoke before panel toggle.
onAfterToggle	event : PanelAfterToggleEvent	Callback to invoke after panel toggle.

Templates #

Defines the templates used by the component.

name	parameters	description
header		Custom header template.
content		Custom content template.
footer		Custom footer template.
headericons	context : { $implicit: boolean, // Collapsed state as a boolean }	Custom icons template of the panel toggler.
icons		Custom icons template of the panel header.

Events #

Defines the custom events used by the component's emitters.

PanelBeforeToggleEvent #

Custom panel toggle event, emits before panel toggle.

name	type	description
originalEvent	Event	Browser event.
collapsed	boolean	Collapsed state of the panel.

PanelAfterToggleEvent #

Custom panel toggle event, emits after panel toggle.

name	type	description
originalEvent	Event	Browser event.
collapsed	boolean	Collapsed state of the panel.