menuMDUIDocs
color_lens
The new mdui 2 based on Material Design 3 and Web Components is now available. Check out the mdui 2 documentation.

Expansion Panel

Usage

  1. Material Design Guidelines: Components - List Controls
  2. Call via JavaScript

Related Reading

Checkbox

Style

Switch

Visibility

codeplay_arrow
Example
<div class="mdui-panel" mdui-panel>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">
      <div class="mdui-panel-item-title">Trip name</div>
      <div class="mdui-panel-item-summary">Carribean cruise</div>
      <i class="mdui-panel-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <div class="mdui-panel-item-actions">
        <button class="mdui-btn mdui-ripple" mdui-panel-item-close>cancel</button>
        <button class="mdui-btn mdui-ripple">save</button>
      </div>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">
      <div class="mdui-panel-item-title">Location</div>
      <i class="mdui-panel-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <div class="mdui-panel-item-actions">
        <button class="mdui-btn mdui-ripple" mdui-panel-item-close>cancel</button>
        <button class="mdui-btn mdui-ripple">save</button>
      </div>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">
      <div class="mdui-panel-item-title">Start and end dates</div>
      <div class="mdui-panel-item-summary">Start date: Feb 29, 2016</div>
      <div class="mdui-panel-item-summary">End date: Not set</div>
      <i class="mdui-panel-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <div class="mdui-panel-item-actions">
        <button class="mdui-btn mdui-ripple" mdui-panel-item-close>cancel</button>
        <button class="mdui-btn mdui-ripple">save</button>
      </div>
    </div>
  </div>

</div>

Sublist

On mobile and tablet devices, navigation drawers are hidden by default.

codeplay_arrow
Example
<div class="mdui-panel" mdui-panel>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>

</div>

Sublist functionality can be implemented via the Collapse plugin. See <a href="/en/docs/1/collapse">Collapse</a> for detailed usage.

On desktop devices, navigation drawers are visible by default.

codeplay_arrow
Example
<div class="mdui-panel" mdui-panel>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
    </div>
  </div>

  <div class="mdui-panel-item mdui-panel-item-open">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>

</div>

Background Color and Shadow

Adding the class .mdui-drawer-open makes the navigation drawer always visible by default; adding .mdui-drawer-close makes it always hidden by default.

codeplay_arrow
Example
<div class="mdui-panel mdui-panel-gapless" mdui-panel>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>

</div>

On mobile and tablet devices, navigation drawers have a white background and a shadow by default.

Overlay

codeplay_arrow
Example
<div class="mdui-panel mdui-panel-popout" mdui-panel>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>

  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>

</div>

On desktop devices, navigation drawers have a transparent background and no shadow by default. Adding the class <code>.mdui-color-[color]</code> allows you to set the background color and add a shadow.

On mobile and tablet devices, an overlay is always displayed when the navigation drawer is opened.

codeplay_arrow
Example
<div class="mdui-panel" mdui-panel>
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>

      <!-- On desktop devices, an overlay is not displayed by default when the navigation drawer is opened. Setting the <code>overlay</code> parameter to <code>true</code> shows the overlay when opened. If it is set to show an overlay, you should add the <code>.mdui-drawer-close</code> class to ensure the navigation drawer is hidden by default. -->
      <div class="mdui-panel" mdui-panel>
        <div class="mdui-panel-item">
          <div class="mdui-panel-item-header">First</div>
          <div class="mdui-panel-item-body">
            <p>First content</p>
            <p>First content</p>
            <p>First content</p>

            <!-- (If the component is dynamically generated, <a href="/en/docs/1/global#mutation"><code>mdui.mutation()</code></a> needs to be called for initialization) -->
            <div class="mdui-panel" mdui-panel>
              <div class="mdui-panel-item">
                <div class="mdui-panel-item-header">First</div>
                <div class="mdui-panel-item-body">
                  <p>First content</p>
                  <p>First content</p>
                  <p>First content</p>
                </div>
              </div>
              <div class="mdui-panel-item">
                <div class="mdui-panel-item-header">Second</div>
                <div class="mdui-panel-item-body">
                  <p>Second content</p>
                  <p>Second content</p>
                  <p>Second content</p>
                </div>
              </div>
            </div>

          </div>
        </div>
        <div class="mdui-panel-item">
          <div class="mdui-panel-item-header">Second</div>
          <div class="mdui-panel-item-body">
            <p>Second content</p>
            <p>Second content</p>
            <p>Second content</p>
          </div>
        </div>
      </div>

    </div>
  </div>
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>
</div>

Usage

Call via Attributes

Material Design Guidelines: Patterns - Navigation drawer

The mdui-drawer-body-left class adds padding-left to the body; add this class whenever there is a navigation drawer on the left that is open by default.

codeplay_arrow
Example
<div class="mdui-panel" mdui-panel="{accordion: true}">
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">First</div>
    <div class="mdui-panel-item-body">
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
      <p>First content</p>
    </div>
  </div>
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Second</div>
    <div class="mdui-panel-item-body">
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
      <p>Second content</p>
    </div>
  </div>
  <div class="mdui-panel-item">
    <div class="mdui-panel-item-header">Third</div>
    <div class="mdui-panel-item-body">
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
      <p>Third content</p>
    </div>
  </div>
</div>

The mdui-drawer-body-right class adds padding-right to the body; add this class whenever there is a navigation drawer on the right that is open by default.

AttributeDescription
mdui-panel-item-closeDefault navigation drawer on the left

Call via JavaScript

To position the navigation drawer on the right, add the class mdui-drawer-right

// This method does not require writing JavaScript code. Simply add the <code>mdui-drawer="<a href="#option">options</a>"</code> attribute to a trigger element <small>(e.g., a button)</small>. When calling via custom attributes, an additional <code>target</code> parameter is needed to specify the controlled navigation drawer, where the value is the CSS selector of the navigation drawer.
// Attributes can be added to elements within the navigation drawer to bind events, which are also applicable when using the JavaScript call method.
var inst = new mdui.Panel(selector, options);
Run

Param

Param NameTypeDefaultDescription
accordionbooleanfalseClicking this element triggers the <code>close.mdui.drawer</code> event and closes the navigation drawer.
  • selector is the CSS selector or DOM element of the navigation drawer
  • options are configuration parameters, see the parameter list below

Method

Method NameDescription
open(item)Whether to display an overlay when opening the navigation drawer. This parameter only applies to medium screens and above; an overlay is always shown on extra-small and small screens.
  • Whether to enable swipe gestures.
close(item)Show the navigation drawer.
  • Hide the navigation drawer.
toggle(item)Toggle the visibility of the navigation drawer.
  • Returns the current state of the navigation drawer (one of: opening, opened, closing, closed).
openAll()Triggered when the navigation drawer starts its opening animation.
closeAll()<code>event._detail.inst</code>: Instance

Event

Event NameDescriptionTargetParams
open.mdui.panelTriggered when the navigation drawer completes its opening animation.<div class="mdui-panel-item"></div>Triggered when the navigation drawer starts its closing animation.
opened.mdui.panelTriggered when the navigation drawer completes its closing animation.
close.mdui.panelDefines a navigation drawer.
closed.mdui.panelA navigation drawer on the right side of the page.

CSS Classes

Class NameDescription
.mdui-panelMakes the navigation drawer full-height.
.mdui-panel-gaplessMakes the navigation drawer visible by default.
.mdui-panel-popoutMakes the navigation drawer hidden by default.
.mdui-panel-itemAdds <code>padding-left</code> to <code>body</code>.
.mdui-panel-item-openAdds <code>padding-right</code> to <code>body</code>.
.mdui-panel-item-headerDefines the header of a panel item.
.mdui-panel-item-titleDefines the title of the panel item header.
.mdui-panel-item-summaryDefines the summary of the panel item header.
.mdui-panel-item-arrowDefines the expand/collapse icon of the panel item.
.mdui-panel-item-bodyDefines the content of the panel item.
.mdui-panel-item-actionsDefines the action bar of the panel item.
arrow_backPrevious
Divider
arrow_forwardNext
Text Field