Collapse 折叠面板

介绍

将一组内容放置在多个折叠面板中,点击面板的标题可以展开或收缩其内容。

代码演示

基础用法

通过 v-model 控制展开的面板列表,activeNames 为数组格式。

<z-collapse v-model="active1">
  <z-collapse-item title="标题1">
    zebra-swiper是基于uniapp开发的一款移动端轮播组件。
  </z-collapse-item>
  <z-collapse-item title="标题2">
    zebraSwiper 组件主要由 z-swiper,z-swiper-item 组成。
    其中,z-swiper-item 组件只可放置在 z-swiper 组件中。
  </z-collapse-item>
  <z-collapse-item title="标题3">
    在使用组件时,可以通过props像组件传递参数,从而实现不同的配置。
    通常,配置都将通过options对象传递给组件。所以配置项都应该写进options中。
    同时,也可以通过$refs的方式调用组件的方法。
  </z-collapse-item>
</z-collapse>
const active1 = ref([0])

手风琴

通过 accordion 可以设置为手风琴模式,最多展开一个面板,此时 activeName 为字符串格式。

<z-collapse v-model="active2" accordion>
  <z-collapse-item title="标题1">
    zebra-swiper是基于uniapp开发的一款移动端轮播组件。
  </z-collapse-item>
  <z-collapse-item title="标题2">
    zebraSwiper 组件主要由 z-swiper,z-swiper-item 组成。
    其中,z-swiper-item 组件只可放置在 z-swiper 组件中。
  </z-collapse-item>
  <z-collapse-item title="标题3">
    在使用组件时,可以通过props像组件传递参数,从而实现不同的配置。
    通常,配置都将通过options对象传递给组件。所以配置项都应该写进options中。
    同时,也可以通过$refs的方式调用组件的方法。
  </z-collapse-item>
</z-collapse>
const active2 = ref(0)

禁用状态

通过 disabled 属性来禁用单个面板。

<z-collapse v-model="active3">
  <z-collapse-item title="标题1">
    zebra-swiper是基于uniapp开发的一款移动端轮播组件。
  </z-collapse-item>
  <z-collapse-item title="标题2" disabled>
    zebraSwiper 组件主要由 z-swiper,z-swiper-item 组成。
    其中,z-swiper-item 组件只可放置在 z-swiper 组件中。
  </z-collapse-item>
  <z-collapse-item title="标题3" disabled>
    在使用组件时,可以通过props像组件传递参数,从而实现不同的配置。
    通常,配置都将通过options对象传递给组件。所以配置项都应该写进options中。
    同时,也可以通过$refs的方式调用组件的方法。
  </z-collapse-item>
</z-collapse>

自定义标题内容

通过 title 插槽可以自定义标题栏的内容。

<z-collapse v-model="active4">
  <z-collapse-item>
    <template #title> 标题1<z-icon name="tag" /> </template>
    zebra-swiper是基于uniapp开发的一款移动端轮播组件。
  </z-collapse-item>
  <z-collapse-item title="标题2" value="内容" icon="question-circle">
    zebraSwiper 组件主要由 z-swiper,z-swiper-item 组成。
    其中,z-swiper-item 组件只可放置在 z-swiper 组件中。
  </z-collapse-item>
</z-collapse>

全部展开与全部切换

通过 Collapse 实例上的 toggleAll 方法可以实现全部展开与全部切换。

<z-collapse v-model="active5" ref="collapse">
  <z-collapse-item title="标题1" name="1">
    zebra-swiper是基于uniapp开发的一款移动端轮播组件。
  </z-collapse-item>
  <z-collapse-item title="标题2" name="2">
    zebraSwiper 组件主要由 z-swiper,z-swiper-item 组成。
    其中,z-swiper-item 组件只可放置在 z-swiper 组件中。
  </z-collapse-item>
  <z-collapse-item title="标题3" name="3">
    在使用组件时,可以通过props像组件传递参数,从而实现不同的配置。
    通常,配置都将通过options对象传递给组件。所以配置项都应该写进options中。
    同时,也可以通过$refs的方式调用组件的方法。
  </z-collapse-item>
</z-collapse>
<view class="demo-collapse-buttons">
  <z-button type="primary" @click="openAll"> 全部展开 </z-button>
  <z-button
    type="primary"
    :custom-style="{ 'margin-left': '30rpx' }"
    @click="toggleAll"
  >
    全部切换
  </z-button>
</view>
import { ref } from 'vue';
const active5 = ref(['1'])
const collapse = ref()

const openAll = () => {
  collapse.value?.toggleAll?.(true)
}
const toggleAll = () => {
  collapse.value?.toggleAll?.()
}
.demo-collapse {
  &-buttons {
    margin-top: var(--z-padding-md);
  }
}

Tips: 手风琴模式下无法使用 toggleAll 方法。

API

Collapse Props

参数说明类型默认值
v-model当前展开面板的 name手风琴模式:number | string
非手风琴模式:(number | string)
-
accordion是否开启手风琴模式booleanfalse
border是否显示外边框booleantrue

Collapse Events

事件名说明回调参数
change切换面板时触发activeNames: 类型与 v-model 绑定的值一致

CollapseItem Props

参数说明类型默认值
name唯一标识符,默认为索引值number | stringindex
icon标题栏左侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-
size标题栏大小,可选值为 largestring-
title标题栏左侧内容number | string-
value标题栏右侧内容number | string-
label标题栏描述信息number | string-
border是否显示内边框booleantrue
is-link是否展示标题栏右侧箭头并开启点击反馈booleantrue
disabled是否禁用面板booleanfalse
readonly是否为只读状态,只读状态下无法操作面板booleanfalse
title-class左侧标题额外类名string-
value-class右侧内容额外类名string-
label-class描述信息额外类名string-

Collapse 方法

通过 ref 可以获取到 CollapseItem 实例并调用实例方法。

方法名说明参数返回值
toggleAll切换所有面板展开状态,传 true 为全部展开,false 为全部收起,不传参为全部切换options?: boolean | object-

CollapseItem 方法

通过 ref 可以获取到 CollapseItem 实例并调用实例方法。

方法名说明参数返回值
toggle切换面板展开状态,传 true 为展开,false 为收起,不传参为切换expand?: boolean-

CollapseItem Slots

名称说明
default面板内容
title自定义标题栏左侧内容
value自定义标题栏右侧内容
label自定义标题栏描述信息
icon自定义标题栏左侧图标
right-icon自定义标题栏右侧图标

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--z-collapse-item-durationvar(--z-duration-base)-
--z-collapse-item-content-paddingvar(--z-padding-sm) var(--z-padding-md)-
--z-collapse-item-content-font-sizevar(--z-font-size-md)-
--z-collapse-item-content-line-height1.5-
--z-collapse-item-content-text-colorvar(--z-text-color-2)-
--z-collapse-item-content-backgroundvar(--z-background-2)-
--z-collapse-item-title-disabled-colorvar(--z-text-color-3)-