Collapse 折叠面板

引入

通过以下方式来全局注册组件,更多注册方式请参考。

基础用法

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

  1. <van-collapse v-model="activeNames">
  2. <van-collapse-item title="标题1" name="1">
  3. 代码是写出来给人看的,附带能在机器上运行。
  4. </van-collapse-item>
  5. <van-collapse-item title="标题2" name="2">
  6. 技术无非就是那些开发它的人的共同灵魂。
  7. </van-collapse-item>
  8. <van-collapse-item title="标题3" name="3">
  9. 在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。
  10. </van-collapse-item>
  11. </van-collapse>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const activeNames = ref(['1']);
  5. return { activeNames };
  6. },
  7. };

手风琴

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

  1. <van-collapse v-model="activeName" accordion>
  2. <van-collapse-item title="标题1" name="1">
  3. 代码是写出来给人看的,附带能在机器上运行。
  4. </van-collapse-item>
  5. 技术无非就是那些开发它的人的共同灵魂。
  6. </van-collapse-item>
  7. <van-collapse-item title="标题3" name="3">
  8. 在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。
  9. </van-collapse-item>
  10. </van-collapse>

禁用状态

  1. <van-collapse v-model="activeNames">
  2. <van-collapse-item title="标题1" name="1">
  3. 代码是写出来给人看的,附带能在机器上运行。
  4. </van-collapse-item>
  5. <van-collapse-item title="标题2" name="2" disabled>
  6. 技术无非就是那些开发它的人的共同灵魂。
  7. </van-collapse-item>
  8. <van-collapse-item title="标题3" name="3" disabled>
  9. 在代码阅读过程中人们说脏话的频率是衡量代码质量的唯一标准。
  10. </van-collapse-item>

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

  1. <van-collapse v-model="activeNames">
  2. <van-collapse-item name="1">
  3. <template #title>
  4. <div>标题1 <van-icon name="question-o" /></div>
  5. </template>
  6. 代码是写出来给人看的,附带能在机器上运行。
  7. </van-collapse-item>
  8. <van-collapse-item title="标题2" name="2" icon="shop-o">
  9. 技术无非就是那些开发它的人的共同灵魂。
  10. </van-collapse-item>
  11. </van-collapse>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const activeNames = ref(['1']);
  5. return { activeNames };
  6. },
  7. };

全部展开与全部切换

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

  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const activeNames = ref(['1']);
  5. const collapse = ref(null);
  6. const openAll = () => {
  7. collapse.value.toggleAll(true);
  8. }
  9. const toggleAll = () => {
  10. collapse.value.toggleAll();
  11. },
  12. return {
  13. activeNames,
  14. openAll,
  15. toggleAll,
  16. collapse,
  17. };
  18. },
  19. };

Collapse Props

Collapse Events

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

CollapseItem Props

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

toggleAll 方法示例

  1. import { ref } from 'vue';
  2. import type { CollapseInstance } from 'vant';
  3. const collapseRef = ref<CollapseInstance>();
  4. // 全部切换
  5. collapseRef.value?.toggleAll();
  6. // 全部展开
  7. collapseRef.value?.toggleAll(true);
  8. // 全部收起
  9. collapseRef.value?.toggleAll(false);
  10. // 全部全部切换,并跳过禁用的复选框
  11. collapseRef.value?.toggleAll({
  12. skipDisabled: true,
  13. });
  14. // 全部选中,并跳过禁用的复选框
  15. collapseRef.value?.toggleAll({
  16. expanded: true,
  17. skipDisabled: true,
  18. });

CollapseItem 方法

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

类型定义

组件导出以下类型定义:

  1. import type {
  2. CollapseProps,
  3. CollapseItemProps,
  4. CollapseItemInstance,
  5. CollapseToggleAllOptions,
  6. } from 'vant';

CollapseItemInstance 是组件实例的类型,用法如下:

CollapseItem Slots

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