panels

About Panel

A panel is docked to the left/right side of a viewport and is in the document flow of the canvas or main content.

Use this component when:

1. The canvas content extends beyond the boundaries of the viewport, while panning and zooming is supported
2. It is not important to see canvas content while completing the task in a Panel
3. The task performed in a Panel is momentary

Toggling visibility of a Panel will re-flow the main content.

The panel should take up 100% of the height of its parent container. In most cases, that would be the viewport or main stage of your application.

Base

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-left slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Panel Header">Panel Header</h2>

Header

The header is docked to the top of its panel. When the content of the panel body becomes overflowed, the body will provide scrolling while the header remains visible in place.

The header of a left/right docked panel has left-aligned text by default and one icon that dismisses the panel. The header title should truncate when it becomes too long for the panel width by using the slds-truncate class on the title.

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-left slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Panel Header">Panel Header</h2>

Centered Text

To center the header title, add the class slds-panel__header_align-center to the <div> with class slds-panel__header.

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-left slds-is-open" aria-hidden="false">
  <div class="slds-panel__header slds-panel__header_align-center">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Panel Header">Panel Header</h2>

Custom Header

If a panel header requires additional elements outside of a title and close button, The panel header needs to have the class slds-panel__header_custom added to slds-panel__header. This notifies the component that it has a custom layout in the header.

<div class="slds-panel__header slds-panel__header_custom">...</div>

The <h2> which contains the title of the panel requires the class slds-panel__header-title.

Invoked via Toggle

Accessibility Requirement

When toggling the visibility, author must manage user focus by placing the user inside the panel when it opens and returning them to the trigger when it closes.

Positioning

The slds-panel_docked element can be positioned on the left or right side of a viewport by adding the class slds-panel_docked-left or slds-panel_docked-right.

Left side

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-left slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Panel Header">Panel Header</h2>

Right side

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-right slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Panel Header">Panel Header</h2>

Drilled-In State

Design Note

If the panel has been drilled into, then the panel displays an arrow facing to the left to indicate the direction the user drilled in from.

Accessibility Requirement

When the user drills in, the author must manage user focus by keeping the user inside the panel when it drills in and returning them to the drill-in trigger when it the user presses the back arrow.

Positioning

Left side

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-left slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <button class="slds-button slds-button_icon slds-button_icon-small slds-panel__back" title="Collapse Panel Header">

Right side

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-right slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <button class="slds-button slds-button_icon slds-button_icon-small slds-panel__back" title="Collapse Panel Header">

Sizing

The panel width can be modified by applying a sizing class to the slds-panel element.

The panels come in 5 different sizes:

Panel Visibility

Open as a drawer

A panel causes reflow by being in the flow of the layout rather than overlaid on top of the content. To achieve this, simply toggle the class slds-is-open to the slds-panel_docked element.

Panels for Filtering

Filtering lists or reports can be done by using a Filtering expressions inside of a Panel. Check out the Filtering expression component for different states and accessibility requirements.

Accessibility Requirement

Make sure to use assistive text to improve the clarity of what you might be editing, for example, add Edit filter: to the button element inside each filterable object.

<div class="slds-panel slds-size_medium slds-panel_docked slds-panel_docked-right slds-is-open" aria-hidden="false">
  <div class="slds-panel__header">
    <h2 class="slds-panel__header-title slds-text-heading_small slds-truncate" title="Filter">Filter</h2>