BackTop 回到顶部

导航组件

页面右下角按钮,一键返回页面顶部。

何时使用

需要回到顶部功能时使用本组件。

代码示例

基础用法

tsx

import { BackTop } from "@/components/ui/back-top"

export function Basic() {
return <BackTop />
}

变体

tsx

{/* 展示 variant 变体 */}
<div className="flex flex-wrap items-center gap-3">
<BackTop variant="default">Default</BackTop>
<BackTop variant="outline">Outline</BackTop>
<BackTop variant="ghost">Ghost</BackTop>
</div>

尺寸

tsx

{/* 尺寸对照 */}
<div className="flex flex-wrap items-center gap-3">
<BackTop size="sm">Sm</BackTop>
<BackTop size="default">Default</BackTop>
<BackTop size="lg">Lg</BackTop>
</div>

样式变体

变体

Variant	说明	默认
`default`	默认样式	✓
`outline`	描边样式
`ghost`	幽灵(无背景)样式

尺寸

Size	说明	默认
`default`	默认尺寸	✓
`sm`	小号
`lg`	大号

API / Props

BackTop

Prop	Type	Default	说明
`className`	`string`	—	自定义样式类名
`target`	`(...args) => unknown`	—	Scroll container target
`visibilityHeight`	`number`	`400`	Threshold in px before showing
...rest	`React.ComponentProps<"button">`	—	透传 `<button>` 原生属性

注意事项

Client Component: 使用 "use client",依赖 React hooks/状态,需在客户端渲染。
CVA 变体: 通过 class-variance-authority 管理样式变体,类型安全。变体对象可导出复用。
原生属性: 继承所有 <button> 原生 HTML 属性。

📘 完整交互式示例与控件属性请查看 Storybook 文档。