在shadcn-ui项目中实现返回顶部按钮功能

背景介绍

shadcn-ui是一个流行的UI组件库，提供了丰富的React组件。在实际开发中，返回顶部按钮是一个常见的功能需求，特别是在长页面中，为用户提供快速返回页面顶部的便捷操作。

实现原理分析

返回顶部按钮的核心功能包含两个部分：

1. 显示/隐藏逻辑：当用户滚动页面超过一定高度时显示按钮，否则隐藏
2. 滚动行为：点击按钮时平滑滚动到页面顶部

技术实现方案

我们可以基于shadcn-ui的Button组件扩展实现一个ScrollToTop组件：

import { Button, ButtonProps } from "@/components/ui/button";
import { useEffect, useState } from "react";

export function ScrollToTop({
  minHeight, // 按钮开始显示的最小滚动高度
  scrollTo, // 滚动到的目标位置
  ...props
}: ButtonProps & { minHeight?: number; scrollTo?: number }) {
  const [visible, setVisible] = useState(false);

  useEffect(() => {
    const onScroll = () => {
      setVisible(document.documentElement.scrollTop >= (minHeight ?? 0));
    };

    onScroll();
    document.addEventListener("scroll", onScroll);

    return () => document.removeEventListener("scroll", onScroll);
  }, []);

  return (
    <>
      {visible && (
        <Button
          onClick={() =>
            window.scrollTo({
              top: scrollTo ?? 0,
              behavior: "smooth",
            })
          }
          {...props}
        />
      )}
    </>
  );
}

使用示例

在实际页面中使用该组件：

import { ScrollToTop } from "@/components/scroll-to-top";
import { ArrowUpToLine } from "lucide-react";

export default Page() {
  return (
    <div className="relative">
      {/* 页面内容 */}
      <ScrollToTop 
        minHeight={20} 
        scrollTo={10} 
        className="absolute right-4 bottom-4"
      >
        <ArrowUpToLine />
      </ScrollToTop>
    </div>
  )
}

参数说明

1. minHeight：控制按钮开始显示的最小滚动高度，默认为0
2. scrollTo：指定滚动到的目标位置，默认为0（页面顶部）
3. className：可以自定义按钮的样式和位置
4. children：可以自定义按钮的内容，通常使用上箭头图标

优化建议

1. 节流处理：滚动事件可以添加节流函数优化性能
2. 动画效果：可以添加淡入淡出动画提升用户体验
3. 响应式设计：在不同屏幕尺寸下调整按钮位置和大小
4. 无障碍访问：添加ARIA属性提升可访问性

总结

通过扩展shadcn-ui的Button组件，我们可以轻松实现一个功能完善、可定制性强的返回顶部按钮。这种实现方式既保持了与shadcn-ui设计风格的一致性，又提供了灵活的参数配置，能够满足各种场景下的使用需求。