Vant3 中文入门教程 Vant3 Collapse 折叠面板

2024-02-25 开发教程 Vant3 中文入门教程 匿名 5

介绍

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

实例演示

引入

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

import { createApp } from 'vue';
import { Collapse, CollapseItem } from 'vant';
const app = createApp();
app.use(Collapse);
app.use(CollapseItem);

代码演示

基础用法

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

<van-collapse v-model="activeNames">
<van-collapse-item title="标题1" name="1">内容</van-collapse-item>
<van-collapse-item title="标题2" name="2">内容</van-collapse-item>
<van-collapse-item title="标题3" name="3">内容</van-collapse-item>
</van-collapse>
import { ref } from 'vue';
export default {
setup() {
const activeNames = ref(['1']);
return { activeNames };
},
};

手风琴

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

<van-collapse v-model="activeName" accordion>
<van-collapse-item title="标题1" name="1">内容</van-collapse-item>
<van-collapse-item title="标题2" name="2">内容</van-collapse-item>
<van-collapse-item title="标题3" name="3">内容</van-collapse-item>
</van-collapse>
import { ref } from 'vue';
export default {
setup() {
const activeName = ref('1');
return { activeName };
},
};

禁用状态

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

<van-collapse v-model="activeNames">
<van-collapse-item title="标题1" name="1">内容</van-collapse-item>
<van-collapse-item title="标题2" name="2" disabled>内容</van-collapse-item>
<van-collapse-item title="标题3" name="3" disabled>内容</van-collapse-item>
</van-collapse>

自定义标题内容

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

<van-collapse v-model="activeNames">
<van-collapse-item name="1">
<template #title>
<div>标题1 <van-icon name="question-o" /></div>
</template>
内容
</van-collapse-item>
<van-collapse-item title="标题2" name="2" icon="shop-o">
内容
</van-collapse-item>
</van-collapse>
import { ref } from 'vue';
export default {
setup() {
const activeNames = ref(['1']);
return { activeNames };
},
};

API

Collapse Props

参数说明类型默认值
v-model当前展开面板的 name

手风琴模式:number | string

非手风琴模式:(number | string)[]

-
accordion是否开启手风琴模式

boolean

false

border是否显示外边框

boolean

true

Collapse Events

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

CollapseItem Props

参数说明类型默认值
name唯一标识符,默认为索引值

number | string

index

icon标题栏左侧图标名称或图片链接

string

-
size

标题栏大小,可选值为 large

string

-
title标题栏左侧内容

number | string

-
value标题栏右侧内容

number | string

-
label标题栏描述信息

number | string

-
border是否显示内边框

boolean

true

is-link是否展示标题栏右侧箭头并开启点击反馈

boolean

true

disabled是否禁用面板

boolean

false

readonly v3.0.12

是否为只读状态,只读状态下无法操作面板

boolean

false

title-class左侧标题额外类名

string

-
value-class右侧内容额外类名

string

-
label-class描述信息额外类名

string

-

CollapseItem 方法

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

方法名说明参数返回值
toggle切换面试展开状态,传 true为展开,false为收起,不传参为切换

expand?: boolean

-

类型定义

通过 CollapseItemInstance 获取 CollapseItem 实例的类型定义。

import { ref } from 'vue';
import type { CollapseItemInstance } from 'vant';
const collapseItemRef = ref<CollapseItemInstance>();
collapseItemRef.value?.toggle();

CollapseItem Slots

名称说明
default面板内容
title自定义标题栏左侧内容
value自定义标题栏右侧内容

label v3.1.1

自定义标题栏描述信息
icon自定义标题栏左侧图标
right-icon自定义标题栏右侧图标

样式变量

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

名称默认值描述
--van-collapse-item-transition-duration

var(--van-animation-duration-base)

-
--van-collapse-item-content-padding

var(--van-padding-sm) var(--van-padding-md)

-
--van-collapse-item-content-font-size

var(--van-font-size-md)

-
--van-collapse-item-content-line-height

1.5

-
--van-collapse-item-content-text-color

var(--van-gray-6)

-
--van-collapse-item-content-background-color

var(--van-white)

-
--van-collapse-item-title-disabled-color

var(--van-gray-5)

-