BackTop 回到顶部

返回页面顶部的操作按钮。

基础用法

参数	说明	类型	默认值
v-model:active	绑定当前组件是否显示的标识符	`boolearn`	`false`
target	触发滚动的目标对象，支持传入选择器或 DOM 元素，默认最近的父级滚动容器	`string \| HTMLElement`	-
right	距离页面右侧的距离，默认单位为 `px`	`number \| string`	`30`
bottom	距离页面底部的距离，默认单位为 `px`	`number \| string`	`40`
offset	滚动高度达到此参数值时才显示组件	`number`	`200`
teleport	指定挂载的节点，等同于 Teleport 组件的 to 属性	`string \| Element`	`body`
immediate	是否瞬间滚动到顶部	`boolean`	`false`
z-index	设置组件的 z-index 层级	`number \| string`	`100`

事件名	说明	回调参数
click	点击组件时触发	`event: MouseEvent`

名称	说明
default	自定义按钮显示内容

组件导出以下类型定义：

import type { BackTopProps, BackTopThemeVars } from 'ryxon'

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。