Vue3折叠面板(Collapse)

75 篇文章 4 订阅
72 篇文章 3 订阅

可自定义设置以下属性:

  • 折叠面板数据(collapseData),可使用 slot 替换指定 key 的 header、content、arrow、extra、lang,类型:Array<{key?: string | number, header?: string | slot, content?: string | slot, disabled?: boolean, showArrow?: boolean, extra?: string | slot}>,默认 []

  • 当前激活 tab 面板的 key(v-model:activeKey),类型:number[] | number | string[] | string | null,默认 null

  • 是否禁用(disabled),优先级低于 Collapse 的 disabled,类型:boolean,默认 false

  • 带边框风格的折叠面板(bordered),类型:boolean,默认 true

  • 是否可复制面板内容(copyable),类型:boolean,默认 false

  • 面板右上角固定内容(lang),例如标识 language,类型:string | slot,默认 undefined

  • 设置面板容器的样式(itemStyle),类型:CSSProperties,默认 {}

  • 设置面板标题的样式(headerStyle),类型:CSSProperties,默认 {}

  • 设置面板内容的样式(contentStyle),类型:CSSProperties,默认 {}

  • 自定义箭头切换图标(arrow),类型:slot,默认 undefined

  • 是否展示箭头(showArrow),优先级低于 Collapse 的 showArrow,类型:boolean,默认 true

  • 箭头位置(arrowPlacement),类型:'left' | 'right',默认 'left'

  • 设置面板箭头的样式(arrowStyle),类型:CSSProperties,默认 {}

  • 面板标题右侧的额外内容(extra),类型:string | slot,默认 undefined

  • 使折叠面板透明且无边框(ghost),类型:boolean,默认 false

效果如下图:在线预览

 

 

①创建折叠面板组件Collapse.vue: 

 其中引入使用了以下组件和工具函数:

<script setup lang="ts">
import { ref } from 'vue'
import type { CSSProperties, Slot } from 'vue'
import Button from '../button'
import { rafTimeout } from '../utils'
interface Collapse {
  key?: string | number // 对应 activeKey,如果没有传入 key 属性,则默认使用数据索引 (0,1,2...) 绑定
  header?: string // 面板标题 string | slot
  content?: string // 面板内容 string | slot
  disabled?: boolean // 是否禁用展开,默认 false
  showArrow?: boolean // 是否展示箭头,默认 true
  extra?: string // 面板标题右侧的额外内容 string | slot
}
interface Props {
  collapseData?: Collapse[] // 折叠面板数据,可使用 slot 替换指定 key 的 header、content、arrow、extra、lang
  activeKey?: number[] | number | string[] | string | null // (v-model) 当前激活 tab 面板的 key
  disabled?: boolean // 是否禁用,优先级低于 Collapse 的 disabled
  collapseStyle?: CSSProperties // 设置面板的样式
  bordered?: boolean // 带边框风格的折叠面板
  copyable?: boolean // 是否可复制面板内容
  lang?: string // 面板右上角固定内容,例如标识 language string | slot
  itemStyle?: CSSProperties // 设置面板容器的样式
  headerStyle?: CSSProperties // 设置面板标题的样式
  contentStyle?: CSSProperties // 设置面板内容的样式
  arrow?: Slot // 自定义箭头切换图标 slot
  showArrow?: boolean // 是否展示箭头,优先级低于 Collapse 的 showArrow
  arrowPlacement?: 'left' | 'right' // 箭头位置
  arrowStyle?: CSSProperties // 设置面板箭头的样式
  extra?: string // 面板标题右侧的额外内容 string | slot
  ghost?: boolean // 使折叠面板透明且无边框
}
const props = withDefaults(defineProps<Props>(), {
  collapseData: () => [],
  activeKey: null,
  disabled: false,
  collapseStyle: () => ({}),
  bordered: true,
  copyable: false,
  lang: undefined,
  itemStyle: () => ({}),
  headerStyle: () => ({}),
  contentStyle: () => ({}),
  arrow: undefined,
  showArrow: true,
  arrowPlacement: 'left',
  arrowStyle: () => ({}),
  extra: undefined,
  ghost: false
})
const contentRef = ref()
const clickIndex = ref<number>(0)
function onEnter(el: Element) {
  ;(el as HTMLElement).style.height =
    contentRef.value[clickIndex.value].offsetHeight + (props.bordered && !props.ghost ? 1 : 0) + 'px'
  ;(el as HTMLElement).style.opacity = '1'
}
function onAfterEnter(el: Element) {
  ;(el as HTMLElement).style.removeProperty('height')
  ;(el as HTMLElement).style.removeProperty('opacity')
}
function onLeave(el: Element) {
  ;(el as HTMLElement).style.height =
    contentRef.value[clickIndex.value].offsetHeight + (props.bordered && !props.ghost ? 1 : 0) + 'px'
  ;(el as HTMLElement).style.opacity = '1'
}
function onAfterLeave(el: Element) {
  ;(el as HTMLElement).style.removeProperty('height')
  ;(el as HTMLElement).style.removeProperty('opacity')
}
const emits = defineEmits(['update:activeKey', 'change'])
function emitValue(value: any) {
  emits('update:activeKey', value)
  emits('change', value)
}
function onClick(key: number | string, index: number) {
  clickIndex.value = index
  if (activeCheck(key)) {
    if (Array.isArray(props.activeKey)) {
      const res = (props.activeKey as any[]).filter((actKey: number | string) => actKey !== key)
      emitValue(res)
    } else {
      emitValue(null)
    }
  } else {
    if (Array.isArray(props.activeKey)) {
      emitValue([...props.activeKey, key])
    } else {
      emitValue(key)
    }
  }
}
function onKeyboard(e: KeyboardEvent, key: number | string, index: number) {
  if (e.key === 'Enter') {
    onClick(key, index)
  }
}
function activeCheck(key: number | string): boolean {
  if (Array.isArray(props.activeKey)) {
    return (props.activeKey as any[]).includes(key)
  } else {
    return props.activeKey === key
  }
}
const copyTxt = ref('Copy')
function onCopy(index: number) {
  navigator.clipboard.writeText(contentRef.value[index].innerText || '').then(
    () => {
      /* clipboard successfully set */
      copyTxt.value = 'Copied'
      rafTimeout(() => {
        copyTxt.value = 'Copy'
      }, 3000)
    },
    (err) => {
      /* clipboard write failed */
      copyTxt.value = err
    }
  )
}
</script>
<template>
  <div
    class="m-collapse"
    :class="{
      'collapse-borderless': !bordered,
      'collapse-arrow-right': arrowPlacement === 'right',
      'collapse-ghost': ghost
    }"
    :style="collapseStyle"
  >
    <div
      class="m-collapse-item"
      :class="{ 'collapse-item-disabled': data.disabled === undefined ? disabled : data.disabled }"
      :style="itemStyle"
      v-for="(data, index) in collapseData"
      :key="index"
    >
      <div
        tabindex="0"
        class="m-collapse-header"
        :class="{ 'collapse-header-no-arrow': data.showArrow !== undefined ? !data.showArrow : !showArrow }"
        :style="headerStyle"
        @click="
          (data.disabled === undefined ? disabled : data.disabled) ? () => false : onClick(data.key || index, index)
        "
        @keydown="onKeyboard($event, data.key || index, index)"
      >
        <div
          v-if="data.showArrow !== undefined ? data.showArrow : showArrow"
          class="collapse-arrow"
          :style="arrowStyle"
        >
          <slot name="arrow" :key="data.key || index" :active="activeCheck(data.key || index)">
            <svg
              class="arrow-svg"
              :class="{ 'arrow-rotate': activeCheck(data.key || index) }"
              focusable="false"
              data-icon="right"
              width="1em"
              height="1em"
              fill="currentColor"
              aria-hidden="true"
              viewBox="64 64 896 896"
            >
              <path
                d="M765.7 486.8L314.9 134.7A7.97 7.97 0 00302 141v77.3c0 4.9 2.3 9.6 6.1 12.6l360 281.1-360 281.1c-3.9 3-6.1 7.7-6.1 12.6V883c0 6.7 7.7 10.4 12.9 6.3l450.8-352.1a31.96 31.96 0 000-50.4z"
              ></path>
            </svg>
          </slot>
        </div>
        <div class="collapse-header">
          <slot name="header" :header="data.header" :key="data.key || index" :active="activeCheck(data.key || index)">
            {{ data.header || '--' }}
          </slot>
        </div>
        <div class="collapse-extra">
          <slot name="extra" :extra="data.extra" :key="data.key || index" :active="activeCheck(data.key || index)">
            {{ data.extra || extra }}
          </slot>
        </div>
      </div>
      <Transition
        name="collapse"
        @enter="onEnter"
        @after-enter="onAfterEnter"
        @leave="onLeave"
        @after-leave="onAfterLeave"
      >
        <div
          v-show="activeCheck(data.key || index)"
          class="m-collapse-content"
          :class="{ 'collapse-copyable': copyable }"
        >
          <div class="collapse-lang">
            <slot name="lang" :lang="lang" :key="data.key || index" :active="activeCheck(data.key || index)">
              {{ lang }}
            </slot>
          </div>
          <Button class="collapse-copy" size="small" type="primary" @click="onCopy(index)">{{ copyTxt }}</Button>
          <div ref="contentRef" class="collapse-content" :style="contentStyle">
            <slot
              name="content"
              :content="data.content"
              :key="data.key || index"
              :active="activeCheck(data.key || index)"
            >
              {{ data.content }}
            </slot>
          </div>
        </div>
      </Transition>
    </div>
  </div>
</template>
<style lang="less" scoped>
.collapse-enter-active,
.collapse-leave-active {
  overflow: hidden;
  transition:
    height 0.2s cubic-bezier(0.645, 0.045, 0.355, 1),
    opacity 0.2s cubic-bezier(0.645, 0.045, 0.355, 1);
}
.collapse-enter-from,
.collapse-leave-to {
  height: 0 !important;
  opacity: 0 !important;
}
.m-collapse {
  font-size: 14px;
  color: rgba(0, 0, 0, 0.88);
  line-height: 1.5714285714285714;
  background-color: rgba(0, 0, 0, 0.02);
  border: 1px solid #d9d9d9;
  border-bottom: 0;
  border-radius: 8px;
  .m-collapse-item {
    border-bottom: 1px solid #d9d9d9;
    &:last-child {
      border-radius: 0 0 8px 8px;
      .m-collapse-header,
      .m-collapse-content {
        border-radius: 0 0 8px 8px;
      }
    }
    .m-collapse-header {
      position: relative;
      display: flex;
      flex-wrap: nowrap;
      align-items: flex-start;
      padding: 12px 16px;
      color: rgba(0, 0, 0, 0.88);
      line-height: 1.5714285714285714;
      cursor: pointer;
      transition: all 0.3s;
      &:focus {
        outline: none;
      }
      .collapse-arrow {
        font-size: 12px;
        height: 22px;
        display: flex;
        align-items: center;
        padding-right: 12px;
        .arrow-rotate {
          transform: rotate(90deg);
        }
        :deep(svg) {
          fill: currentColor;
          transition: transform 0.3s;
        }
      }
      .collapse-header {
        // 元素会根据自身的宽度与高度来确定尺寸,但是会伸长并吸收 flex 容器中额外的自由空间,也会缩短自身来适应 flex 容器
        flex: auto; // 相当于 flex: 1 1 auto
        margin-right: auto;
        display: inline-block;
      }
      .collapse-extra {
        display: flex;
        align-items: center;
        :deep(svg) {
          fill: currentColor;
        }
      }
    }
    .collapse-header-no-arrow {
      padding-left: 12px;
    }
    .m-collapse-content {
      position: relative;
      color: rgba(0, 0, 0, 0.88);
      background-color: #ffffff;
      border-top: 1px solid #d9d9d9;
      .collapse-lang {
        position: absolute;
        right: 10px;
        top: 6px;
        font-size: 14px;
        color: rgba(0, 0, 0, 0.38);
        opacity: 1;
        transition: opacity 0.3s;
      }
      .collapse-copy {
        position: absolute;
        right: 8px;
        top: 8px;
        opacity: 0;
        pointer-events: none;
        transition: opacity 0.3s;
      }
      .collapse-content {
        padding: 16px;
        white-space: pre-wrap;
      }
    }
    .collapse-copyable {
      &:hover {
        .collapse-lang {
          opacity: 0;
          pointer-events: none;
        }
        .collapse-copy {
          opacity: 1;
          pointer-events: auto;
        }
      }
    }
  }
  .collapse-item-disabled {
    .m-collapse-header {
      color: rgba(0, 0, 0, 0.25);
      cursor: not-allowed;
    }
  }
}
.collapse-borderless {
  background-color: rgba(0, 0, 0, 0.02);
  border: 0;
  .m-collapse-item {
    &:last-child {
      border-bottom: 0;
      .m-collapse-header {
        border-radius: 0;
      }
    }
    .m-collapse-content {
      background-color: transparent;
      border-top: 0;
    }
  }
}
.collapse-arrow-right {
  .m-collapse-item .m-collapse-header .collapse-arrow {
    order: 1; // order 属性定义项目的排列顺序。数值越小,排列越靠前,默认为 0
    padding-right: 0;
    padding-left: 12px;
  }
}
.collapse-ghost {
  background-color: transparent;
  border: 0;
  .m-collapse-item {
    border-bottom: 0;
    .m-collapse-content {
      background-color: transparent;
      border: 0;
    }
  }
}
</style>

②在要使用的页面引入:

其中引入使用了以下组件:

<script setup lang="ts">
import Collapse from './Collapse.vue'
import { ref, watchEffect } from 'vue'
import { DoubleRightOutlined, RightCircleFilled, StarOutlined, StarFilled } from '@ant-design/icons-vue'
const collapseData = ref([
  {
    key: '1',
    header: 'This is panel header 1',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  },
  {
    key: '2',
    header: 'This is panel header 2',
    content: `A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world. A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.`
  },
  {
    key: '3',
    header: 'This is panel header 3',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  }
])
const disabledCollapseData = ref([
  {
    key: '1',
    header: 'This is panel header 1',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  },
  {
    key: '2',
    header: 'This is panel header 2',
    content: `A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world. A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.`
  },
  {
    key: '3',
    disabled: true,
    header: 'This is panel header 3',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  }
])
const nestCollapseData = ref([
  {
    key: '1',
    header: 'This is panel header 1',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  }
])
const extraCollapseData = ref([
  {
    key: '1',
    header: 'This is panel header 1',
    extra: 'Extra',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  },
  {
    key: '2',
    header: 'This is panel header 2',
    extra: 'Extra',
    content: `A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world. A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.`
  },
  {
    key: '3',
    header: 'This is panel header 3',
    extra: 'Extra',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  }
])
const arrowCollapseData = ref([
  {
    key: '1',
    header: 'This is panel header 1',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  },
  {
    key: '2',
    showArrow: false,
    header: 'This is panel header 2',
    content: `A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world. A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.`
  },
  {
    key: '3',
    header: 'This is panel header 3',
    content:
      'A dog is a type of domesticated animal. Known for its loyalty and faithfulness,it can be found as a welcome guest in many households across the world.'
  }
])
const activeKey = ref(['1'])
const nestActiveKey = ref(['1'])
const positionOptions = ref([
  {
    label: 'left',
    value: 'left'
  },
  {
    label: 'right',
    value: 'right'
  }
])
const arrowPlacement = ref('left')
watchEffect(() => {
  console.log('activeKey:', activeKey.value)
})
watchEffect(() => {
  console.log('nestActiveKey:', nestActiveKey.value)
})
const key = ref('1')
watchEffect(() => {
  console.log('key:', key.value)
})
function onChange(key: number | string) {
  console.log('change:', key)
}
function handleClick(event: Event, key: string | number) {
  event.stopPropagation() // 阻止事件冒泡
  console.log('event', event)
  console.log('key', key)
}
</script>
<template>
  <div>
    <h1>{{ $route.name }} {{ $route.meta.title }}</h1>
    <h2 class="mt30 mb10">基本使用</h2>
    <h3 class="mb10">activeKey 传入 number[] | string[],所有面板可同时展开</h3>
    <Collapse :collapse-data="collapseData" v-model:active-key="activeKey" @change="onChange" />
    <h2 class="mt30 mb10">'手风琴'</h2>
    <h3 class="mb10">只允许单个内容区域展开,只需 activeKey 传入 number | string 即可</h3>
    <Collapse :collapse-data="collapseData" v-model:active-key="key" />
    <h2 class="mt30 mb10">禁用</h2>
    <Flex vertical>
      <Collapse disabled :collapse-data="collapseData" v-model:active-key="activeKey" />
      <Collapse :collapse-data="disabledCollapseData" v-model:active-key="activeKey" />
    </Flex>
    <h2 class="mt30 mb10">面板嵌套</h2>
    <Collapse :collapse-data="collapseData" v-model:active-key="activeKey">
      <template #content="{ key }">
        <Collapse v-if="key === '1'" :collapse-data="nestCollapseData" v-model:active-key="nestActiveKey" />
      </template>
    </Collapse>
    <h2 class="mt30 mb10">无边框</h2>
    <Collapse :collapse-data="collapseData" v-model:active-key="activeKey" :bordered="false" />
    <h2 class="mt30 mb10">可复制</h2>
    <Collapse copyable lang="template" :collapse-data="collapseData" v-model:active-key="activeKey" />
    <h2 class="mt30 mb10">隐藏箭头</h2>
    <Collapse :collapse-data="arrowCollapseData" v-model:active-key="activeKey" />
    <h2 class="mt30 mb10">箭头位置</h2>
    <Flex vertical>
      <Radio :options="positionOptions" v-model:value="arrowPlacement" button button-style="solid" />
      <Collapse :collapse-data="collapseData" v-model:active-key="activeKey" :arrow-placement="arrowPlacement" />
    </Flex>
    <h2 class="mt30 mb10">自定义面板</h2>
    <h3 class="mb10">自定义各个面板的背景色、圆角、边距和箭头图标</h3>
    <Collapse
      :collapse-data="collapseData"
      v-model:active-key="activeKey"
      :bordered="false"
      :collapse-style="{ backgroundColor: '#fff' }"
      :item-style="{
        backgroundColor: '#f7f7f7',
        borderRadius: '8px',
        marginBottom: '16px',
        border: 0
      }"
    >
      <template #arrow="{ key, active }">
        <DoubleRightOutlined v-if="key === '2'" :rotate="active ? 90 : 0" />
        <RightCircleFilled v-else :rotate="active ? 90 : 0" />
      </template>
    </Collapse>
    <h2 class="mt30 mb10">自定义面板样式</h2>
    <Collapse
      :collapse-data="collapseData"
      v-model:active-key="activeKey"
      :arrow-style="{ fontSize: '14px', height: '25px' }"
      :header-style="{ fontSize: '16px', color: '#ff6900' }"
      :content-style="{ padding: '16px 24px', color: 'rgba(0, 0, 0, 0.65)' }"
    />
    <h2 class="mt30 mb10">面板额外内容</h2>
    <Collapse :collapse-data="extraCollapseData" v-model:active-key="activeKey">
      <template #extra="{ key }">
        <StarFilled @click="handleClick($event, key)" v-if="key === '1'" />
        <StarOutlined @click="handleClick($event, key)" v-if="key === '3'" />
      </template>
    </Collapse>
    <h2 class="mt30 mb10">幽灵折叠面板</h2>
    <Collapse :collapse-data="collapseData" v-model:active-key="activeKey" ghost />
  </div>
</template>
  • 6
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值