Collapse 折叠面板

使用折叠面板收纳与展示内容。

基础用法

可同时展开多个面板。

Consistent with real life: in line with the process and logic of real life, and comply with languages and habits that the users are used to;

Consistent within interface: all elements should be consistent, such as: design style, icons and texts, position of elements, etc.

vue

<template>
  <div class="demo-collapse">
    <u-collapse v-model="activeNames" @change="handleChange">
      <u-collapse-item title="Consistency" name="1">
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Controllability" name="4">
        <div>
          Decision making: giving advice about operations is acceptable, but do
          not make decisions for the users;
        </div>
        <div>
          Controlled consequences: users should be granted the freedom to
          operate, including canceling, aborting or terminating current
          operation.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

import type { CollapseModelValue } from 'uniboot-ui'

const activeNames = ref(['1'])
const handleChange = (val: CollapseModelValue) => {
  console.log(val)
}
</script>

手风琴模式

手风琴模式下同一时间只能展开一个面板。

使用 accordion 属性启用手风琴模式。

Consistent with real life: in line with the process and logic of real life, and comply with languages and habits that the users are used to;

Consistent within interface: all elements should be consistent, such as: design style, icons and texts, position of elements, etc.

vue

<template>
  <div class="demo-collapse">
    <u-collapse v-model="activeName" accordion>
      <u-collapse-item title="Consistency" name="1">
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Controllability" name="4">
        <div>
          Decision making: giving advices about operations is acceptable, but do
          not make decisions for the users;
        </div>
        <div>
          Controlled consequences: users should be granted the freedom to
          operate, including canceling, aborting or terminating current
          operation.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const activeName = ref('1')
</script>

自定义标题

除 title 属性外，可通过具名插槽自定义标题，便于加入图标等内容。

TIP

title 插槽提供 isActive，表示当前折叠项是否展开。

vue

<template>
  <div class="demo-collapse">
    <u-collapse accordion>
      <u-collapse-item name="1">
        <template #title="{ isActive }">
          <div :class="['title-wrapper', { 'is-active': isActive }]">
            Consistency
            <u-icon class="header-icon">
              <info-filled />
            </u-icon>
          </div>
        </template>
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Controllability" name="4">
        <div>
          Decision making: giving advices about operations is acceptable, but do
          not make decisions for the users;
        </div>
        <div>
          Controlled consequences: users should be granted the freedom to
          operate, including canceling, aborting or terminating current
          operation.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script setup lang="ts">
import { InfoFilled } from '@uniboot/icons-vue'
</script>

<style scoped>
.title-wrapper {
  display: flex;
  align-items: center;
  gap: 4px;
}

.title-wrapper.is-active {
  color: var(--u-color-primary);
}
</style>

自定义图标

除 icon 属性外，可通过具名插槽自定义面板图标。

Consistent with real life: in line with the process and logic of real life, and comply with languages and habits that the users are used to;

Consistent within interface: all elements should be consistent, such as: design style, icons and texts, position of elements, etc.

vue

<template>
  <div class="demo-collapse">
    <u-collapse v-model="activeNames" @change="handleChange">
      <u-collapse-item title="Consistency" name="1" :icon="CaretRight">
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <template #icon="{ isActive }">
          <span class="icon-ele">
            {{ isActive ? 'Expanded' : 'Collapsed' }}
          </span>
        </template>
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Controllability" name="4">
        <div>
          Decision making: giving advices about operations is acceptable, but do
          not make decisions for the users;
        </div>
        <div>
          Controlled consequences: users should be granted the freedom to
          operate, including canceling, aborting or terminating current
          operation.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'
import { CaretRight } from '@uniboot/icons-vue'

import type { CollapseModelValue } from 'uniboot-ui'

const activeNames = ref(['1'])
const handleChange = (val: CollapseModelValue) => {
  console.log(val)
}
</script>

<style scoped>
.icon-ele {
  margin: 0 8px 0 auto;
  color: #2f54eb;
}
</style>

自定义图标位置

使用 expand-icon-position 自定义展开图标位置。

expand icon position:

left

vue

<template>
  <div class="demo-collapse-position">
    <div class="flex items-center mb-4">
      <span class="mr-4">expand icon position: </span>
      <u-switch
        v-model="position"
        inactive-value="left"
        active-value="right"
        inactive-text="left"
        active-text="right"
        style="--u-switch-off-color: #88b8fe"
      />
    </div>

    <u-collapse :expand-icon-position="position">
      <u-collapse-item title="Consistency" name="1">
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

import type { CollapseIconPositionType } from 'uniboot-ui'

const position = ref<CollapseIconPositionType>('left')
</script>

阻止折叠

设置 before-collapse：若返回 false，或返回的 Promise 被拒绝，则阻止折叠状态变化。

before collapse return:

true

Consistent with real life: in line with the process and logic of real life, and comply with languages and habits that the users are used to;

Consistent within interface: all elements should be consistent, such as: design style, icons and texts, position of elements, etc.

vue

<template>
  <div v-loading="loading" class="demo-collapse">
    <div class="flex items-center mb-4">
      <span class="mr-4">before collapse return: </span>
      <u-switch
        v-model="before"
        :inactive-value="false"
        :active-value="true"
        inactive-text="false"
        active-text="true"
      />
    </div>

    <u-collapse v-model="activeNames" :before-collapse="beforeCollapse">
      <u-collapse-item title="Consistency" name="1">
        <div>
          Consistent with real life: in line with the process and logic of real
          life, and comply with languages and habits that the users are used to;
        </div>
        <div>
          Consistent within interface: all elements should be consistent, such
          as: design style, icons and texts, position of elements, etc.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Feedback" name="2">
        <div>
          Operation feedback: enable the users to clearly perceive their
          operations by style updates and interactive effects;
        </div>
        <div>
          Visual feedback: reflect current state by updating or rearranging
          elements of the page.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Efficiency" name="3">
        <div>
          Simplify the process: keep operating process simple and intuitive;
        </div>
        <div>
          Definite and clear: enunciate your intentions clearly so that the
          users can quickly understand and make decisions;
        </div>
        <div>
          Easy to identify: the interface should be straightforward, which helps
          the users to identify and frees them from memorizing and recalling.
        </div>
      </u-collapse-item>
      <u-collapse-item title="Controllability" name="4">
        <div>
          Decision making: giving advices about operations is acceptable, but do
          not make decisions for the users;
        </div>
        <div>
          Controlled consequences: users should be granted the freedom to
          operate, including canceling, aborting or terminating current
          operation.
        </div>
      </u-collapse-item>
    </u-collapse>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const before = ref(true)
const activeNames = ref(['1'])
const loading = ref(false)

const beforeCollapse = (): Promise<boolean> => {
  loading.value = true
  return new Promise((resolve) => {
    setTimeout(() => {
      loading.value = false
      return resolve(before.value)
    }, 1000)
  })
}
</script>

折叠面板 API

折叠面板属性

名称	说明	类型	默认值
model-value / v-model	当前激活面板；手风琴模式下为 `string`，否则为 `array`	`string` / `array`	[]
accordion	是否手风琴模式	`boolean`	false
expand-icon-position	展开图标位置	`enum`	right
before-collapse	折叠状态变化前的钩子；返回 `false` 或 `Promise` 被拒绝时阻止折叠	`Function`	—

折叠面板事件

事件名	说明	类型
change	激活面板变化时触发；手风琴模式参数为 `string`，否则为 `array`	`Function`

折叠面板插槽

名称	说明	子标签
default	自定义默认内容	折叠面板子项

折叠面板暴露

名称	说明	类型
activeNames	当前激活面板名称	`object`
setActiveNames	设置激活面板名称	`Function`

折叠面板项 API

折叠面板项属性

名称	说明	类型	默认值
name	唯一标识	`string` / `number`	—
title	面板标题	`string`	''
icon	面板图标	`string` / `Component`	ArrowRight
disabled	是否禁用该项	`boolean`	false

折叠面板项插槽

名称	说明
default	折叠项默认内容
title	标题内容；作用域类型 `^[object]``
icon	图标内容；作用域类型 `^[object]``

折叠面板项暴露

名称	说明	类型
isActive	当前项是否处于展开态	`object`

Carousel 走马灯

Descriptions 描述列表

Collapse 折叠面板 ​

基础用法 ​

手风琴模式 ​

自定义标题 ​

自定义图标 ​

自定义图标位置 ​

阻止折叠 ​

折叠面板 API ​

折叠面板 属性 ​

折叠面板 事件 ​

折叠面板 插槽 ​

折叠面板 暴露 ​

折叠面板项 API ​

折叠面板项 属性 ​

折叠面板项 插槽 ​

折叠面板项 暴露 ​

Collapse 折叠面板

基础用法

手风琴模式

自定义标题

自定义图标

自定义图标位置

阻止折叠

折叠面板 API

折叠面板属性

折叠面板事件

折叠面板插槽

折叠面板暴露

折叠面板项 API

折叠面板项属性

折叠面板项插槽

折叠面板项暴露