• BackTop 回到顶部
    • 何时使用
    • 代码演示
      • 基本
      • 自定义样式
  • API
    • 事件

    BackTop 回到顶部

    返回页面顶部的操作按钮。

    何时使用

    • 当页面内容区域比较长时;
    • 当用户需要频繁返回顶部查看相关内容时。

    代码演示

    BackTop 回到顶部 - 图1

    基本

    最简单的用法。

    1. <template>
    2. <div>
    3. <a-back-top />
    4. Scroll down to see the bottom-right
    5. <strong style="color: rgba(64, 64, 64, 0.6)"> gray </strong>
    6. button.
    7. </div>
    8. </template>

    BackTop 回到顶部 - 图2

    自定义样式

    可以自定义回到顶部按钮的样式,限制宽高:40px * 40px

    1. <template>
    2. <div id="components-back-top-demo-custom">
    3. <a-back-top>
    4. <div class="ant-back-top-inner">UP</div>
    5. </a-back-top>
    6. Scroll down to see the bottom-right
    7. <strong style="color: #1088e9"> blue </strong>
    8. button.
    9. </div>
    10. </template>
    11. <style scoped>
    12. #components-back-top-demo-custom .ant-back-top {
    13. bottom: 100px;
    14. }
    15. #components-back-top-demo-custom .ant-back-top-inner {
    16. height: 40px;
    17. width: 40px;
    18. line-height: 40px;
    19. border-radius: 4px;
    20. background-color: #1088e9;
    21. color: #fff;
    22. text-align: center;
    23. font-size: 20px;
    24. }
    25. </style>

    API

    有默认样式,距离底部 50px,可覆盖。

    自定义样式宽高不大于 40px * 40px。

    参数说明类型默认值
    target设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数Function() => window
    visibilityHeight滚动高度达到此参数值才出现 BackTopnumber400

    事件

    事件名称说明回调参数
    click点击按钮的回调函数Function