# @vuepress-reco/vuepress-plugin-back-to-top

![demo.png](./images/demo.png)

## Details

> Back-to-top plugin for vuepress-theme-reco or other vuepress theme.

|使用位置|值|
|-|-|
|plugin name|@vuepress-reco/vuepress-plugin-back-to-top|
|component name|BackToTop（自动出现在页面中，无需添加额外代码）|

## Options

> 以下为插件注入时的参数。

**Attributes**

|参数|说明|类型|默认值|可选值|
|-|-|-|-|-|
|icon|按钮中间的图标名字|string|reco-up|主题内置的其他图标|
|visibilityHeight|按钮出现时的最小滚动高度|number|400|-|
|customStyle|自定义按钮的样式|Object|{right:'1rem',bottom: '6rem',width: '2.5rem',height: '2.5rem','border-radius': '.25rem','line-height': '2.5rem',backgroundColor: 'rgba(231, 234, 241,.5)'}|-|