如何利用组合式 API 实现全站唯一的“滚动到顶”通用 Hooks?

大宇同学_3841

大宇同学_3841

2026-05-19

745人浏览

原创

useScrollToTop是一个全局可用的Vue Hook,通过监听window滚动事件、提供scrollToTop函数实现全站平滑回顶,支持自动显隐控制与第三方滚动库扩展,零依赖且无状态冗余。

如何利用组合式 api 实现全站唯一的“滚动到顶”通用 hooks?

直接封装一个全局可用的 useScrollToTop Hook,不依赖任何 UI 库,也不需要在每个页面重复写逻辑,就能让全站任意组件一键触发平滑回顶。

核心思路:监听滚动 + 提供统一触发函数

真正的“全站唯一”,关键不在调用次数,而在行为一致性 —— 滚动目标、动画效果、触发时机都由同一个 Hook 管理。它不绑定具体 DOM 节点,而是操作 window 或 document.documentElement,天然具备全局性。

  • 用 ref 存储是否已启用平滑滚动(避免重复初始化)
  • 用 onMounted 和 onUnmounted 控制生命周期,防止内存泄漏
  • 暴露 scrollToTop 函数,内部调用 window.scrollTo 并指定 behavior: 'smooth'
  • 可选:自动监听 scroll 事件,通过 ref 暴露当前滚动位置,方便做“回到顶部”按钮显隐逻辑

基础版 useScrollToTop(零依赖,开箱即用)

新建 src/hooks/useScrollToTop.ts:

import { ref, onMounted, onUnmounted } from 'vue'

export function useScrollToTop() {
  const scrollTop = ref(0)
  const isEnabled = ref(false)

  const updateScrollTop = () => {
    scrollTop.value = window.pageYOffset || document.documentElement.scrollTop
  }

  const scrollToTop = () => {
    window.scrollTo({ top: 0, behavior: 'smooth' })
  }

  const init = () => {
    if (isEnabled.value) return
    window.addEventListener('scroll', updateScrollTop)
    isEnabled.value = true
  }

  const destroy = () => {
    if (!isEnabled.value) return
    window.removeEventListener('scroll', updateScrollTop)
    isEnabled.value = false
  }

  onMounted(init)
  onUnmounted(destroy)

  return {
    scrollTop,
    scrollToTop
  }
}

在任意组件中使用:

<script setup>
import { useScrollToTop } from '@/hooks/useScrollToTop'

const { scrollTop, scrollToTop } = useScrollToTop()
</script><template><button v-if="scrollTop > 200">回到顶部</button>
</template>

增强版:支持自定义容器与取消监听

如果项目用了平滑滚动库(如 Lenis 或 Locomotive Scroll),原生 scrollTo 可能失效。这时可扩展 Hook,接受可选的滚动容器实例或取消函数:

  • 传入 customScrollInstance(如 lenis.scrollTo(0))
  • 或传入 cancelScrollHandler,用于在组件卸载时清理第三方库监听
  • 保持返回值结构一致,上层组件无需修改调用方式

为什么它能真正“全站唯一”?

这个 Hook 不创建多个实例,也不维护多份状态。所有组件调用 useScrollToTop(),拿到的都是同一套响应式逻辑和同一组事件监听器 —— 因为 Vue 的组合式函数每次调用都是独立作用域,但底层共享的是浏览器原生 window 对象和统一的事件机制。只要你不手动多次 addEventListener('scroll'),就不会出现冲突或叠加。

不需要 Vuex/Pinia 存储,也不需要 provide/inject 透传,轻量、稳定、无副作用。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2703

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5883

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6850

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6598

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

943

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1714

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

12322

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

316

23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习