Panel

<ui5-panel>

The ui5-panel component is a container which has a header and a content area and is used for grouping and displaying information. It can be collapsed to save space on the screen.

Guidelines:

• Nesting two or more panels is not recommended.
• Do not stack too many panels on one page.

Structure

The panel's header area consists of a title bar with a header text or custom header.

The header is clickable and can be used to toggle between the expanded and collapsed state. It includes an icon which rotates depending on the state.

The custom header can be set through the header slot and it may contain arbitraray content, such as: title, buttons or any other HTML elements.

The content area can contain an arbitrary set of controls.

Note: The custom header is not clickable out of the box, but in this case the icon is interactive and allows to show/hide the content area.

Responsive Behavior

• If the width of the panel is set to 100% (default), the panel and its children are resized responsively, depending on its parent container.
• If the panel has a fixed height, it will take up the space even if the panel is collapsed.
• When the panel is expandable (the fixed property is set to false), an arrow icon (pointing to the right) appears in front of the header.
• When the animation is activated, expand/collapse uses a smooth animation to open or close the content area.
• When the panel expands/collapses, the arrow icon rotates 90 degrees clockwise/counter-clockwise.

Keyboard Handling

Fast Navigation

This component provides a build in fast navigation group which can be used via [F6] / [Shift] + [F6] / [Ctrl] + [Alt/Option] / [Down] or [Ctrl] + [Alt/Option] + [Up]. In order to use this functionality, you need to import the following module: import "@ui5/webcomponents-base/dist/features/F6Navigation.js"

ES6 Module Import

import "@ui5/webcomponents/dist/Panel.js";

Basic Sample

Properties

headerText

Description	This property is used to set the header text of the component. The text is visible in both expanded and collapsed states. Note: This property is overridden by the header slot.
Type	string | undefined
Default	undefined

fixed

Description	Determines whether the component is in a fixed state that is not expandable/collapsible by user interaction.
Type	boolean
Default	false

collapsed

Description	Indicates whether the component is collapsed and only the header is displayed.
Type	boolean
Default	false

noAnimation

Description	Indicates whether the transition between the expanded and the collapsed state of the component is animated. By default the animation is enabled.
Type	boolean
Default	false
Since	1.0.0-rc.16

accessibleRole

Description	Sets the accessible ARIA role of the component. Depending on the usage, you can change the role from the default Form to Region or Complementary.
Type	"Complementary" | "Form" | "Region"
Default	"Form"

headerLevel

Description	Defines the "aria-level" of component heading, set by the headerText.
Type	"H1" | "H2" | "H3" | "H4" | "H5" | "H6"
Default	"H2"

accessibleName

Description	Defines the accessible ARIA name of the component.
Type	string | undefined
Default	undefined
Since	1.0.0-rc.15

stickyHeader

Description	Indicates whether the Panel header is sticky or not. If stickyHeader is set to true, then whenever you scroll the content or the application, the header of the panel will be always visible and a solid color will be used for its design.
Type	boolean
Default	false
Since	1.16.0-rc.1

Slots

default

Description	Defines the content of the component. The content is visible only when the component is expanded.
Type	Array<Node>

header

Description	Defines the component header area. Note: When a header is provided, the headerText property is ignored.
Type	Array<HTMLElement>

Events

toggle

Description	Fired when the component is expanded/collapsed by user interaction.
Type	CustomEvent
Bubbles	Yes
Cancelable	No

Methods

No methods available for this component.

CSS Parts

Name	Description
header	Used to style the wrapper of the header.
content	Used to style the wrapper of the content.

More Samples

Fixed Panel

The fixed panel can't be collapsed when expanded, and can't be expanded if collapsed.

Sticky Header

The header remains visible upon scrolling the Panel's content.

Custom Header

You can replace the built-in header using the header slot.