BackTop 回到顶部

可一键快捷返回顶部的按钮。

基本用法

对具体 window 滚动使用:

<template>
  <i-back-top />
</template>
显示代码

具体节点滚动

对具体 DOM 节点滚动使用:

  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • <template>
      <i-back-top target="#idesign-demo-scroll1" />
      <div id="idesign-demo-scroll1" :style="{ height: '400px', overflow: 'auto' }">
        <li
          className="idesign-demo-itemy"
          v-for="(item, index) in data"
          :key="index"
        >
          {{ item }}
        </li>
      </div>
    </template>
    
    <script setup>
    const data = Array(24).fill('item')
    </script>
    
    显示代码

    滚动显示起点

    通过 visibleHeight 属性控制滚动到指定高度时,才显示返回顶部按钮:

  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • item
  • <template>
      <i-back-top :visibleHeight="100" target="#idesign-demo-scroll2" />
      <div id="idesign-demo-scroll2" :style="{ height: '400px', overflow: 'auto' }">
        <li
          className="idesign-demo-itemy"
          v-for="(item, index) in data"
          :key="index"
        >
          {{ item }}
        </li>
      </div>
    </template>
    
    <script setup>
    const data = Array(24).fill('item')
    </script>
    
    显示代码

    自定义返回顶部按钮

    直接包裹自定义内容:

    ⬆️
    <template>
      <i-back-top>
        <div>⬆️</div>
      </i-back-top>
    </template>
    
    显示代码

    BackTop Attributes

    属性说明类型默认值
    target监听滚动的元素string〡HTMLElement〡Windowwindow
    visibleHeight显示起点高度number0
    smooth是否平滑滚动booleantrue

    BackTop Events

    属性说明类型默认值
    click点击返回顶部时触发() => void--
    scroll滚动层节点滚动时触发() => void--
    Last Updated:
    Contributors: Leophen