ICEN UI 回到顶部
Docs ⌘K
Core · 稳定

回到顶部

回到顶部:滚动过阈值浮出的悬浮钮。

Preview
导航 back-top

点击按钮平滑滚到页面底部,右下角会浮出回到顶部按钮(autoCreate 模式,悬停有提示)。

html
<div class="demo-row">  <button class="icen-btn" id="back-top-demo">向下滚动本页试试</button></div><p class="icen-dim" style="margin:8px 0 0;font-size:12px">点击按钮平滑滚到页面底部,右下角会浮出回到顶部按钮(autoCreate 模式,悬停有提示)。</p>

特性

接口

初始化
initBackTop()(kit 一行入口可直接命名导入)
导出
initBackTop
事件
icen:back-top detail 契约见 IcenEventMap
类型
dist/behaviors/back-top.d.mts(随 npm 包发布,含全部 JSDoc 约束)

安装

bun add @icen.ai/ui

一行引入该组件(CSS 与 behavior 自动带上,无需关心内部 CSS 文件名):

js
import '@icen.ai/ui/kit/back-top';

也可以用脚手架直接打印引入行:

bash
bunx --bun @icen.ai/ui add back-top

Astro 项目注意:kit 入口里的 CSS import 在页面 <script> 里会被 Astro 的 client bundle 摇掉——请改在布局 frontmatter 里引 CSS(import '@icen.ai/ui/components/back-top.css';),JS 行为仍可走 kit。Vite SPA / webpack 项目无此问题。

用法

js
import { initBackTop } from '@icen.ai/ui/behaviors/back-top';// 全自动:portal 一个默认按钮到 body,滚到顶initBackTop({ autoCreate: true });// 或手写:// <button class="icen-back-top" data-icen-back-top type="button" aria-label="回到顶部">…svg…</button>// initBackTop();// 可选 data-* 或 opts:threshold(默认 320)/ target(滚动容器)/ offset(滚到多少 px)