BackTop 回到顶部

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

何时使用

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

代码演示

基本

最简单的用法

  1. <template>
  2. 向下滚动后,见右下角灰色按钮
  3. <v-back-top></v-back-top>
  4. </template>

自定义样式

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

  1. <template>
  2. 向下滚动后,见右下角蓝色按钮
  3. <v-back-top style="bottom: 100px;" :visibility-height="600" @click.native="handler">
  4. <div :style="styleObject">UP</div>
  5. </v-back-top>
  6. </template>
  7. <script>
  8. export default {
  9. data: function() {
  10. return {
  11. styleObject: {
  12. height: '40px',
  13. width: '40px',
  14. lineHeight: '40px',
  15. borderRadius: '4px',
  16. color: 'rgb(255, 255, 255)',
  17. textAlign: 'center',
  18. fontSize: '20px',
  19. backgroundColor: 'rgb(87, 197, 247)'
  20. }
  21. }
  22. },
  23. methods: {
  24. handler() {
  25. console.log('噢');
  26. }
  27. }
  28. }
  29. </script>

自定义滚动事件的元素

可以自定义回到顶部按钮要滚动的元素。

  1. <template>
  2. <div style="position: relative;">
  3. <div id="back-top-target">
  4. <div>向下滚动后,见右下角绿色按钮</div>
  5. <div>向下滚动后,见右下角绿色按钮</div>
  6. <div>向下滚动后,见右下角绿色按钮</div>
  7. <div>向下滚动后,见右下角绿色按钮</div>
  8. <div>向下滚动后,见右下角绿色按钮t</div>
  9. <div>向下滚动后,见右下角绿色按钮</div>
  10. </div>
  11. <v-back-top style="position: absolute;margin-top: -100px;right: 80px;" :visibility-height="400" :target="getTarget">
  12. <div :style="customStyle">UP</div>
  13. </v-back-top>
  14. </div>
  15. </template>
  16. <style>
  17. #back-top-target {
  18. height: 400px;
  19. border: solid 1px #ddd;
  20. padding: 20px;
  21. margin: 20px;
  22. overflow: auto;
  23. }
  24. #back-top-target div {
  25. height: 280px;
  26. }
  27. </style>
  28. <script>
  29. export default {
  30. data: function() {
  31. return {
  32. customStyle: {
  33. height: '40px',
  34. width: '40px',
  35. lineHeight: '40px',
  36. borderRadius: '4px',
  37. color: 'rgb(255, 255, 255)',
  38. textAlign: 'center',
  39. fontSize: '20px',
  40. backgroundColor: 'rgb(10, 220, 80)'
  41. }
  42. }
  43. },
  44. methods: {
  45. getTarget() {
  46. return document.getElementById("back-top-target");
  47. }
  48. }
  49. }
  50. </script>

API

有默认样式,距离底部 50px,可覆盖。
自定义样式宽高不大于 40px * 40px。

BackTop Props

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