# bee-backtop

> Backtop ui component for react

Latest version **1.0.2** (published 2020-04-24) · MIT license · 92 weekly downloads

## Install

```sh
npm install bee-backtop
pnpm add bee-backtop
yarn add bee-backtop
bun add bee-backtop
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-04-24 |
| First published | 2017-07-12 |
| Weekly downloads | 92 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 4 |
| Unpacked size | 17 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | yonyou |
| Maintainers | ahua52, banyudu, bjyxszd, guoyongfeng, huayingjie, jonyw, kvkens, liushaozhen, liuyk, npm_yx, tinper-bot, whizbz, yangchch, yonyoufed, zhaoyuchief |
| Keywords | react, react-component, bee-backtop, iuap-design, tinper-bee, Backtop |

## Links

- npm: https://www.npmjs.com/package/bee-backtop
- Repository: https://github.com/tinper-bee/bee-backtop
- Homepage: https://github.com/tinper-bee/bee-backtop.git
- Issues: https://github.com/tinper-bee/bee-backtop.git/issues
- npm.io page: https://npm.io/package/bee-backtop

## Dependencies (4)

- [bee-icon](https://npm.io/package/bee-icon.md) ^1.0.3
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.23.0
- [tinper-bee-core](https://npm.io/package/tinper-bee-core.md) latest

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-04-24
- 1.0.1 — 2017-11-01
- 1.0.0 — 2017-10-20
- 0.3.1 — 2017-10-17
- 0.3.0 — 2017-10-12
- 0.2.1 — 2017-09-04
- 0.2.0 — 2017-09-04
- 0.1.9 — 2017-08-30
- 0.1.8 — 2017-08-30
- 0.1.7 — 2017-08-30
- 0.1.6 — 2017-08-29
- 0.1.5 — 2017-08-23
- 0.1.4 — 2017-08-21
- 0.1.3 — 2017-07-14
- 0.1.2 — 2017-07-12
- … 1 more at https://npm.io/package/bee-backtop/versions

## README

# bee-backtop

[![npm version](https://img.shields.io/npm/v/bee-backtop.svg)](https://www.npmjs.com/package/bee-backtop)
[![Build Status](https://img.shields.io/travis/tinper-bee/bee-backtop/master.svg)](https://travis-ci.org/tinper-bee/bee-backtop)
[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-backtop/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-backtop?branch=master)
[![devDependency Status](https://img.shields.io/david/dev/tinper-bee/bee-backtop.svg)](https://david-dm.org/tinper-bee/bee-backtop#info=devDependencies)
[![NPM downloads](http://img.shields.io/npm/dm/bee-backtop.svg?style=flat)](https://npmjs.org/package/bee-backtop)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tinper-bee/bee-backtop.svg)](http://isitmaintained.com/project/tinper-bee/bee-backtop "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/tinper-bee/bee-backtop.svg)](http://isitmaintained.com/project/tinper-bee/bee-backtop "Percentage of issues still open")


react bee-backtop component for tinper-bee

返回顶部

## 使用方法

```
import BackTop from 'bee-backtop';

class BackTopDemo extends Component {
    render() {
        return (
            <BackTop/>
        )
    }
}
```
#### 样式引入
- 可以使用link引入build目录下BackTop.css
```
<link rel="stylesheet" href="./node_modules/bee-backtop/build/BackTop.css">
```
- 可以在js中import样式
```js
import "./node_modules/bee-backtop/src/BackTop.scss"
//或是
import "./node_modules/bee-backtop/build/BackTop.css"
```


## API

|参数|说明|类型|默认值|
|:--|:---:|:--:|---:|
|visibilityHeight|当滚动条高度达到多少显示backtop|`number`|400|
|target|设置要监听滚动事件的元素|`function`|() => window|
|click|点击backTop时的回调函数|`function`|-|
|character|自定义字符|`ReactNode`/`string`|<Icon type="uf-top-up"/>|

#### 开发调试

```sh
$ npm install -g bee-tools
$ git clone https://github.com/tinper-bee/bee-backtop
$ cd bee-backtop
$ npm install
$ npm run dev
```

---
_Source: https://npm.io/package/bee-backtop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._