SBackTop2.js 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. const n = `<template>
  2. <!-- 锚点只用来在 DOM 上找滚动祖先,本身不占位、不参与交互 -->
  3. <span ref="anchorRef" class="s-back-top-anchor" aria-hidden="true"></span>
  4. <teleport to="body">
  5. <transition name="s-back-top-fade">
  6. <button
  7. v-show="visible"
  8. class="s-back-top"
  9. type="button"
  10. :title="$l('回到顶部')"
  11. :style="{ right: pos.right + 'px', bottom: pos.bottom + 'px' }"
  12. @click="toTop"
  13. >
  14. <UpOutlined />
  15. </button>
  16. </transition>
  17. </teleport>
  18. </template>
  19. <script setup>
  20. import { onBeforeUnmount, onMounted, reactive, ref } from 'vue'
  21. import { UpOutlined } from '@ant-design/icons-vue'
  22. defineOptions({ name: 'SBackTop' })
  23. const props = defineProps({
  24. /**
  25. * 滚动容器:CSS 选择器或 DOM 元素。
  26. * 不传时自动向上找最近的滚动祖先(如 SPanelLayout 的内容区),找不到则监听 window。
  27. */
  28. target: {
  29. type: [String, Object],
  30. default: null
  31. },
  32. /** 滚动超过该距离才出现;可滚动距离本身更短时按比例下调,避免按钮永不出现 */
  33. visibilityHeight: {
  34. type: Number,
  35. default: 200
  36. },
  37. /** 距滚动容器右边缘的距离(px);容器铺满窗口时即距窗口右边缘 */
  38. right: {
  39. type: Number,
  40. default: 30
  41. },
  42. /** 距滚动容器下边缘的距离(px) */
  43. bottom: {
  44. type: Number,
  45. default: 40
  46. }
  47. })
  48. const anchorRef = ref(null)
  49. const visible = ref(false)
  50. const pos = reactive({ right: props.right, bottom: props.bottom })
  51. // 滚动容器:元素为 window 时说明整页滚动
  52. let scroller = null
  53. let observer = null
  54. const isScrollable = (el) => {
  55. if (!el || el.nodeType !== 1) return false
  56. const style = window.getComputedStyle(el)
  57. const canScroll = /(auto|scroll|overlay)/.test(style.overflowY)
  58. return canScroll && el.scrollHeight > el.clientHeight + 1
  59. }
  60. /**
  61. * 自动找最近的滚动祖先,找不到返回 window(整页滚动)。
  62. * 先找「已溢出」的容器;内容还没撑开时(异步渲染)退回第一个声明了 overflow 的祖先,
  63. * 否则会误判成整页滚动,按钮跑到窗口角上。
  64. */
  65. const findScroller = () => {
  66. if (props.target) {
  67. if (typeof props.target === 'string') return document.querySelector(props.target) || window
  68. return props.target
  69. }
  70. let el = anchorRef.value ? anchorRef.value.parentElement : null
  71. let fallback = null
  72. while (el && el !== document.body && el !== document.documentElement) {
  73. if (isScrollable(el)) return el
  74. if (!fallback && /(auto|scroll|overlay)/.test(window.getComputedStyle(el).overflowY)) {
  75. fallback = el
  76. }
  77. el = el.parentElement
  78. }
  79. return fallback || window
  80. }
  81. const scrollTop = () => {
  82. if (!scroller || scroller === window) {
  83. return window.pageYOffset || document.documentElement.scrollTop || 0
  84. }
  85. return scroller.scrollTop
  86. }
  87. const scrollRange = () => {
  88. if (!scroller || scroller === window) {
  89. return document.documentElement.scrollHeight - window.innerHeight
  90. }
  91. return scroller.scrollHeight - scroller.clientHeight
  92. }
  93. /** 按钮贴在滚动容器右下角内侧,容器铺满窗口时退化为窗口右下角 */
  94. const updatePos = () => {
  95. const el = scroller
  96. if (!el || el === window) {
  97. pos.right = props.right
  98. pos.bottom = props.bottom
  99. return
  100. }
  101. const rect = el.getBoundingClientRect()
  102. pos.right = Math.max(0, window.innerWidth - rect.right) + props.right
  103. pos.bottom = Math.max(0, window.innerHeight - rect.bottom) + props.bottom
  104. }
  105. const onScroll = () => {
  106. const range = scrollRange()
  107. const threshold = Math.min(props.visibilityHeight, Math.max(40, range * 0.15))
  108. visible.value = scrollTop() > threshold
  109. // 容器高度可能随内容变化(如侧边折叠),滚动时顺手校正位置
  110. updatePos()
  111. }
  112. const bindScroller = () => {
  113. scroller = findScroller()
  114. updatePos()
  115. onScroll()
  116. if (observer) observer.disconnect()
  117. if (scroller && scroller !== window && typeof ResizeObserver !== 'undefined') {
  118. observer = new ResizeObserver(() => {
  119. updatePos()
  120. onScroll()
  121. })
  122. observer.observe(scroller)
  123. }
  124. }
  125. const toTop = () => {
  126. const top = { top: 0, behavior: 'smooth' }
  127. if (!scroller || scroller === window) {
  128. window.scrollTo(top)
  129. return
  130. }
  131. scroller.scrollTo(top)
  132. }
  133. onMounted(() => {
  134. bindScroller()
  135. // 捕获阶段监听:容器内滚动不冒泡,这样任意容器的滚动都能收到
  136. document.addEventListener('scroll', onScroll, true)
  137. window.addEventListener('resize', updatePos)
  138. })
  139. onBeforeUnmount(() => {
  140. document.removeEventListener('scroll', onScroll, true)
  141. window.removeEventListener('resize', updatePos)
  142. if (observer) observer.disconnect()
  143. observer = null
  144. scroller = null
  145. })
  146. <\/script>
  147. <style lang="less" scoped>
  148. .s-back-top-anchor {
  149. display: none;
  150. }
  151. .s-back-top {
  152. position: fixed;
  153. z-index: 1000;
  154. display: flex;
  155. align-items: center;
  156. justify-content: center;
  157. width: 40px;
  158. height: 40px;
  159. padding: 0;
  160. border: 1px solid var(--s-border-color-split, #e5e6eb);
  161. border-radius: 10px;
  162. background: var(--s-bg-color-container, #fff);
  163. color: var(--s-text-color-secondary, #4e5969);
  164. font-size: 16px;
  165. box-shadow: 0 4px 14px rgba(0, 0, 0, 0.14);
  166. cursor: pointer;
  167. outline: none;
  168. transition:
  169. color 0.2s,
  170. border-color 0.2s,
  171. box-shadow 0.2s;
  172. &:hover,
  173. &:focus-visible {
  174. color: var(--s-color, #1677ff);
  175. border-color: var(--s-color, #1677ff);
  176. box-shadow: 0 6px 18px rgba(0, 0, 0, 0.18);
  177. }
  178. }
  179. .s-back-top-fade-enter-active,
  180. .s-back-top-fade-leave-active {
  181. transition:
  182. opacity 0.2s,
  183. transform 0.2s;
  184. }
  185. .s-back-top-fade-enter-from,
  186. .s-back-top-fade-leave-to {
  187. opacity: 0;
  188. transform: translateY(8px);
  189. }
  190. @media (prefers-reduced-motion: reduce) {
  191. .s-back-top-fade-enter-active,
  192. .s-back-top-fade-leave-active {
  193. transition: none;
  194. }
  195. }
  196. </style>
  197. `;
  198. export {
  199. n as default
  200. };