mirror of
https://github.com/element-plus/element-plus.git
synced 2026-03-13 07:51:17 +08:00
6703747032
* docs(components): [backtop] * Update to new syntax for the API sectionss. * chore: adjust heading levels and adding comments for APIs Co-authored-by: JeremyWuuuuu <15975785+JeremyWuuuuu@users.noreply.github.com>
52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
---
|
|
title: Backtop
|
|
lang: en-US
|
|
---
|
|
|
|
# Backtop
|
|
|
|
A button to back to top.
|
|
|
|
## Basic Usage
|
|
|
|
Scroll down to see the bottom-right button.
|
|
|
|
:::demo
|
|
|
|
backtop/basic
|
|
|
|
:::
|
|
|
|
## Customizations
|
|
|
|
Display area is 40px \* 40px.
|
|
|
|
:::demo
|
|
|
|
backtop/custom
|
|
|
|
:::
|
|
|
|
## API
|
|
|
|
### Attributes
|
|
|
|
| Name | Description | Type | Default |
|
|
| ----------------- | -------------------------------------------------------------------- | --------- | ------- |
|
|
| target | the target to trigger scroll. | ^[string] | — |
|
|
| visibility-height | the button will not show until the scroll height reaches this value. | ^[number] | 200 |
|
|
| right | right distance. | ^[number] | 40 |
|
|
| bottom | bottom distance. | ^[number] | 40 |
|
|
|
|
### Events
|
|
|
|
| Name | Description | Parameters |
|
|
| ----- | -------------------- | -------------------------------------- |
|
|
| click | triggers when click. | ^[Function]`(evt: MouseEvent) => void` |
|
|
|
|
### Slots
|
|
|
|
| Name | Description |
|
|
| ------- | -------------------------- |
|
|
| default | customize default content. |
|