Skip to content

Collapse SSR 折叠面板

基础用法

手风琴效果

自定义标题内容

自定义内容

全部展开与全部切换

API

Collapse Props

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

Collapse Events

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

CollapseSsrItem 数据结构

参数说明类型默认值
name唯一标识符,默认为索引值number | stringindex
icon标题栏左侧图标名称或图片链接,等同于 Icon 组件的 name 属性string-
title标题栏左侧内容number | string-
value标题栏右侧内容number | string-
label标题栏描述信息number | string-
border是否显示内边框booleantrue
isLink是否展示标题栏右侧箭头并开启点击反馈booleantrue
disabled是否禁用面板booleanfalse
readonly是否为只读状态,只读状态下无法操作面板booleanfalse
lazyRender是否在首次展开时才渲染面板内容booleantrue
titleClass左侧标题额外类名string-
valueClass右侧内容额外类名string-
labelClass描述信息额外类名string-
clickable是否开启点击反馈booleannull
content默认情况下要在面板中显示的内容string | string[] | object | object[]''

Collapse 方法

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

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

toggleAll 方法示例

js
import { ref } from 'vue'

const collapseRef = ref()

// 全部切换
collapseRef.value?.toggleAll()
// 全部展开
collapseRef.value?.toggleAll(true)
// 全部收起
collapseRef.value?.toggleAll(false)

// 全部全部切换,并跳过禁用的复选框
collapseRef.value?.toggleAll({
  skipDisabled: true
})
// 全部选中,并跳过禁用的复选框
collapseRef.value?.toggleAll({
  expanded: true,
  skipDisabled: true
})

类型定义

组件导出以下类型定义:

ts
import type { CollapseSsrProps, CollapseSsrItem } from 'ryxon'

CollapseItem Slots

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

Released under the MIT License.