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

Collapse

The Collapse plugin is used to fold or expand content blocks.

The plugin itself does not come with any style; you need to write your own style or use it with other components.

Usage

(If the component is dynamically generated, you need to call mdui.mutation() to initialize it.)
Call via JavaScript

HTML Structure

This is the most basic HTML structure:

<div class="mdui-collapse">
  <div class="mdui-collapse-item">
    <div class="mdui-collapse-item-header"></div>
    <div class="mdui-collapse-item-body"></div>
  </div>
</div>

Adding the class .mdui-collapse-item-open makes the content block expanded by default:

<div class="mdui-collapse">
  <div class="mdui-collapse-item mdui-collapse-item-open">
    <div class="mdui-collapse-item-header"></div>
    <div class="mdui-collapse-item-body"></div>
  </div>
</div>

Elements containing the class .mdui-collapse-item-arrow will flip 180 degrees when the content block is expanded:

<div class="mdui-collapse">
  <div class="mdui-collapse-item">
    <div class="mdui-collapse-item-header">
      <div class="mdui-collapse-item-arrow"></div>
    </div>
    <div class="mdui-collapse-item-body"></div>
  </div>
</div>

Usage

Call via Attributes

No JavaScript code is required using this method. Simply add the mdui-collapse="options" attribute to the <div class="mdui-collapse"></div> element to activate the plugin.

If the component is dynamically generated, you need to call mdui.mutation() to initialize them.

Example

<div class="mdui-collapse" mdui-collapse>

  <div class="mdui-collapse-item">
    <div class="mdui-collapse-item-header">
      <p><a href="javascript:;">item1</a></p>
    </div>
    <div class="mdui-collapse-item-body">
      <p>item1 content</p>
      <p>item1 content</p>
      <p>item1 content</p>

      <!-- Nested elements -->
      <div class="mdui-collapse" mdui-collapse>
        <div class="mdui-collapse-item">
          <div class="mdui-collapse-item-header">
            <p><a href="javascript:;">subitem1</a></p>
          </div>
          <div class="mdui-collapse-item-body">
            <p>subitem1 content</p>
            <p>subitem1 content</p>
            <p>subitem1 content</p>
          </div>
        </div>
      </div>

    </div>
  </div>

  <div class="mdui-collapse-item">
    <div class="mdui-collapse-item-header">
      <p><a href="javascript:;">item2</a></p>
    </div>
    <div class="mdui-collapse-item-body">
      <p>item2 content</p>
      <p>item2 content</p>
      <p>item2 content</p>
    </div>
  </div>

  <div class="mdui-collapse-item">
    <div class="mdui-collapse-item-header">
      <p><a href="javascript:;">item3</a></p>
    </div>
    <div class="mdui-collapse-item-body">
      <p>item3 content</p>
      <p>item3 content</p>
      <p>item3 content</p>
    </div>
  </div>

</div>

You can add some attributes to elements within the Collapse to bind events, which can also be used when calling with JavaScript.

Attribute	Description
`mdui-collapse-item-close`	Clicking this element will trigger the `close.mdui.collapse` event and close the panel where the element is located.

Call via JavaScript

Instantiate the plugin:

// selector is the CSS selector of the element or a DOM element.
// options is the parameter of the plugin, see the parameter list below.
var inst = new mdui.Collapse(selector, options);

demo

Param

Param Name	Type	Default	Description
`accordion`	`boolean`	`false`	Whether to enable the accordion effect. When `true`, at most one content block can be open; opening one content block will close other content blocks. When `false`, multiple content blocks can be opened at the same time.

Method

Method Name	Description
`open(item)`	Open a content block. `item`: Index number of the content block, DOM element, or CSS selector.
`close(item)`	Close a content block. `item`: Index number of the content block, DOM element, or CSS selector.
`toggle(item)`	Toggle content block state. `item`: Index number of the content block, DOM element, or CSS selector.
`openAll()`	Open all content blocks. This method is only effective when `accordion` is `false`.
`closeAll()`	Close all content blocks.

Event

Event Name	Description	Target	Params
`open.mdui.collapse`	The event will be triggered when the content block starts its open animation.	`<div class="mdui-collapse-item"></div>`	`event._detail.inst`: Instance
`opened.mdui.collapse`	The event will be triggered when the content block finishes its open animation.
`close.mdui.collapse`	The event will be triggered when the content block starts its close animation.
`closed.mdui.collapse`	The event will be triggered when the content block finishes its close animation.

More examples

Sub-list

Example

<ul class="mdui-list" mdui-collapse="{accordion: true}">

  <li class="mdui-list-item mdui-ripple">
    <i class="mdui-list-item-icon mdui-icon material-icons">home</i>
    <div class="mdui-list-item-content">Home</div>
  </li>

  <li class="mdui-list-item mdui-ripple">
    <i class="mdui-list-item-icon mdui-icon material-icons">dashboard</i>
    <div class="mdui-list-item-content">Dashboard</div>
  </li>

  <li class="mdui-collapse-item mdui-collapse-item-open">
    <div class="mdui-collapse-item-header mdui-list-item mdui-ripple">
      <i class="mdui-list-item-icon mdui-icon material-icons">people</i>
      <div class="mdui-list-item-content">Audience</div>
      <i class="mdui-collapse-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <ul class="mdui-collapse-item-body mdui-list mdui-list-dense">
      <li class="mdui-list-item mdui-ripple">Overview</li>
      <li class="mdui-list-item mdui-ripple">Language</li>
      <li class="mdui-list-item mdui-ripple">Location</li>
      <li class="mdui-list-item mdui-ripple">New vs Returning</li>
    </ul>
  </li>

  <li class="mdui-collapse-item">
    <div class="mdui-collapse-item-header mdui-list-item mdui-ripple">
      <i class="mdui-list-item-icon mdui-icon material-icons">device_hub</i>
      <div class="mdui-list-item-content">Acquisition</div>
      <i class="mdui-collapse-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <ul class="mdui-collapse-item-body mdui-list mdui-list-dense">
      <li class="mdui-list-item mdui-ripple">Overview</li>
      <li class="mdui-list-item mdui-ripple">All Traffic</li>
      <li class="mdui-list-item mdui-ripple">Direct Traffic</li>
      <li class="mdui-list-item mdui-ripple">Search Overview</li>
    </ul>
  </li>

  <li class="mdui-collapse-item">
    <div class="mdui-collapse-item-header mdui-list-item mdui-ripple">
      <i class="mdui-list-item-icon mdui-icon material-icons">touch_app</i>
      <div class="mdui-list-item-content">Behavior</div>
      <i class="mdui-collapse-item-arrow mdui-icon material-icons">keyboard_arrow_down</i>
    </div>
    <ul class="mdui-collapse-item-body mdui-list mdui-list-dense">
      <li class="mdui-list-item mdui-ripple">Overview</li>
      <li class="mdui-list-item mdui-ripple">All Pages</li>
      <li class="mdui-list-item mdui-ripple">Landing Pages</li>
      <li class="mdui-list-item mdui-ripple">Exit Pages</li>
    </ul>
  </li>

  <li class="mdui-list-item mdui-ripple">
    <i class="mdui-list-item-icon mdui-icon material-icons">shopping_cart</i>
    <div class="mdui-list-item-content">Ecommerce</div>
  </li>

</ul>

Progress Bar

Headroom