Amaze UI

Collapse


折叠效果组件,用于制作下滑菜单或手风琴效果。

基础用法

折叠面板标题01

折叠面板内容显示区域01

折叠面板标题02

折叠面板内容显示区域02

折叠面板标题03

折叠面板内容显示区域03
Copy
<div class="am-panel-group" id="accordion">
  <div class="am-panel am-panel-default">
    <div class="am-panel-hd" data-am-collapse="{parent: '#accordion', target: '#do-not-say-1'}">
      <h4 class="am-panel-title" >
        折叠面板标题01
      </h4>
      <span class="am-icon-caret-left"></span>
    </div>
    <div id="do-not-say-1" class="am-panel-collapse am-collapse">
      <div class="am-panel-bd">
        折叠面板内容显示区域01
      </div>
    </div>
  </div>
  <div class="am-panel am-panel-default">
    <div class="am-panel-hd" data-am-collapse="{parent: '#accordion', target: '#do-not-say-2'}">
      <h4 class="am-panel-title" >
        折叠面板标题02
      </h4>
      <span class="am-icon-caret-left"></span>
    </div>
    <div id="do-not-say-2" class="am-panel-collapse am-collapse">
      <div class="am-panel-bd">
       折叠面板内容显示区域02
      </div>
    </div>
  </div>
  <div class="am-panel am-panel-default">
    <div class="am-panel-hd" data-am-collapse="{parent: '#accordion', target: '#do-not-say-3'}">
      <h4 class="am-panel-title">
        折叠面板标题03
      </h4>
      <span class="am-icon-caret-left"></span>
    </div>
    <div id="do-not-say-3" class="am-panel-collapse am-collapse">
      <div class="am-panel-bd">
       折叠面板内容显示区域03
      </div>
    </div>
  </div>
</div>

结合 Panel 组件实现手风琴效果。需结合以下辅助 class 使用:

  • 要隐藏的内容添加 .am-collapse
  • 默认显示的内容添加 .am-collapse.am-in

添加以上 class 以后,通过 Data API 来调用:

<h4 data-am-collapse="{parent: '#accordion', target: '#do-not-say-1'}"></h4>

其中:

  • parent 为容器 ID
  • target 为要伸缩的容器 ID

如果触发元素为 <a> 元素,可以把 target 设置在 href 属性里。

<a data-am-collapse="{parent: '#accordion'}" href="#do-not-say-1">...</a>

在线运行

折叠菜单

使用时注意目标元素外面应该有一个容器,以便动画执行时计算高度。

Copy
<button class="am-btn am-btn-primary" data-am-collapse="{target: '#collapse-nav'}">Menu <i class="am-icon-bars"></i></button>
<nav>
  <ul id="collapse-nav" class="am-nav am-collapse">
    <li><a href="">开始使用</a></li>
    <li><a href="">CSS 介绍</a></li>
    <li class="am-active"><a href="">JS 介绍</a></li>
    <li><a href="">功能定制</a></li>
  </ul>
</nav>

折叠列表

Copy
<ul class="am-list admin-sidebar-list" id="collapase-nav-1">
  <li  class="am-panel">
    <a data-am-collapse="{parent: '#collapase-nav-1'}" href="#/"><i class="am-icon-home am-margin-left-sm"></i> 首页</a>
  </li>

  <li class="am-panel">
    <a data-am-collapse="{parent: '#collapase-nav-1', target: '#user-nav'}">
        <i class="am-icon-users am-margin-left-sm"></i> 人员管理 <i class="am-icon-angle-right am-fr am-margin-right"></i>
    </a>
    <ul class="am-list am-collapse admin-sidebar-sub" id="user-nav">
        <li><a href="#/userAdd"><i class="am-icon-user am-margin-left-sm"></i> 添加人员 </a></li>
        <li><a href="#/userList/0"><i class="am-icon-user am-margin-left-sm"></i> 人员列表 </a></li>
    </ul>
  </li>

  <li class="am-panel">
    <a data-am-collapse="{parent: '#collapase-nav-1', target: '#company-nav'}">
        <i class="am-icon-table am-margin-left-sm"></i> 单位(部门)管理 <i class="am-icon-angle-right am-fr am-margin-right"></i>
    </a>
    <ul class="am-list am-collapse admin-sidebar-sub" id="company-nav">
        <li><a href="#/companyAdd"><span class="am-icon-table am-margin-left-sm"></span> 添加单位(部门) </a></li>
        <li><a href="#/companyList/0"><span class="am-icon-table am-margin-left-sm"></span> 单位(部门)列表 </a></li>
    </ul>
  </li>

  <li class="am-panel">
    <a data-am-collapse="{parent: '#collapase-nav-1', target: '#role-nav'}">
        <i class="am-icon-table am-margin-left-sm"></i> 角色管理 <i class="am-icon-angle-right am-fr am-margin-right"></i>
    </a>
    <ul class="am-list am-collapse admin-sidebar-sub" id="role-nav">
        <li><a href="#/roleAdd"><span class="am-icon-table am-margin-left-sm"></span> 添加角色 </a></li>
        <li><a href="#/roleList/0"><span class="am-icon-table am-margin-left-sm"></span> 角色列表 </a></li>
    </ul>
  </li>
</ul>

触发方式

通过 Data API

在元素上添加 data-am-collapse 并设置 target 的值为折叠元素 ID:

<button data-am-collapse="{target: '#my-collapse'}"></button>

通过 JS

使用方法:

$('#myCollapse').collapse()

方法

  • $().collapse(options) - 绑定元素展开/折叠操作
$('#myCollapse').collapse({
  toggle: false
})
  • $().collapse('toggle') - 切换面板状态
  • $().collapse('open') - 展开面板
  • $().collapse('close') - 关闭面板

选项

参数类型默认描述
parent选择符false如果设置了 parent 参数,且该容器下有多个可折叠的面板时,展开一个面板会关闭其它展开的面板。换言之,如果想让多个面板可以都处于展开状态,那不设置这个参数即可。
toggle布尔值true交替执行展开/关闭操作

自定义事件

自定义事件在折叠的元素上触发,以上面的折叠菜单为例,#collapse-nav 触发自定义事件:

$('#collapse-nav').on('open.collapse.amui', function() {
  console.log('折叠菜单打开!');
}).on('close.collapse.amui', function() {
  console.log('折叠菜单关闭!');
});
事件描述
open.collapse.amuiopen 方法被调用时立即触发
opened.collapse.amui元素完全展开后触发
close.collapse.amuiclose 方法被调用后立即触发
closed.collapse.amui元素折叠完成后触发

注意事项

不要在折叠内容的容器上设置垂直的 margin/padding/border 样式。

jQuery 计算元素高度的方式的问题,暂时只能通过上面的方式规避。