ant-design/components/back-top/index.zh-CN.md
afc163 e027cbec1c
docs: format all markdown (#38629)
* chore: add prettier-ignore in markdown demo

* docs: format markdown api table

* docs: format markdown api table
2022-11-17 17:31:26 +08:00

1.0 KiB
Raw Blame History

category subtitle title cover demo group
Components 回到顶部 BackTop https://gw.alipayobjects.com/zos/alicdn/tJZ5jbTwX/BackTop.svg
cols
2
其他

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

何时使用

  • 当页面内容区域比较长时;
  • 当用户需要频繁返回顶部查看相关内容时。

代码演示

基本 自定义样式

API

有默认样式,距离底部 50px,可覆盖。

自定义样式宽高不大于 40px * 40px。

参数 说明 类型 默认值 版本
duration 回到顶部所需时间ms number 450 4.4.0
target 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 () => HTMLElement () => window
visibilityHeight 滚动高度达到此参数值才出现 BackTop number 400
onClick 点击按钮的回调函数 function -