# react-back-top

> React component for back to top

Latest version **1.0.4** (published 2017-08-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-back-top
pnpm add react-back-top
yarn add react-back-top
bun add react-back-top
```

## 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.4 |
| Published | 2017-08-05 |
| First published | 2017-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | wangziqiang |
| Maintainers | wangziqiang |
| Keywords | react, component, back, top |

## Links

- npm: https://www.npmjs.com/package/react-back-top
- Repository: https://github.com/ZiQiangWang/react-back-top
- Homepage: https://github.com/ZiQiangWang/react-back-top#readme
- Issues: https://github.com/ZiQiangWang/react-back-top/issues
- npm.io page: https://npm.io/package/react-back-top

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^15.6.1
- [react-dom](https://npm.io/package/react-dom.md) ^15.6.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10

## 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.4 (latest) — 2017-08-05
- 1.0.3 — 2017-08-05
- 1.0.2 — 2017-08-05
- 1.0.1 — 2017-08-04
- 1.0.0 — 2017-08-04

## README

# react-back-top
React component to back to top.  
![](example/back_top.gif)
## 1. Installation
> npm install --save react-back-top

## 2. Demo & Examples
To build the examples locally, run:
> npm install  
npm start

## 3. Usage
```js
import React from 'react';
import BackToTop from 'react-back-top';
const Demo = (props) => {
  const config = {
      text: "回到顶部",
        topDistance: 10,
        timing=“easeIn”
    }
  return <BackToTop ...config/>
}
export default Demo;
```
## 4. Properties

prop | type | default | notes  
------- | ------- | ------- | -------
shape | string | default | `default` or `round`, default is rectangle
radius | number | 24 | Only work for `round` shape
text | string |  | Content of button
fontSize | string | 16px |
position | object | {  bottom: '10%', right: '5%'} | `top` `bottom` `left` `right` are avalible, determine the position of button
icon | string | | It is a class name of icon,font icon such as `font awesome` and `icomoon` are supported. For `Material Design Icons`, icon should be `material-icons search`, search is the name of icon, but fontSize is not worked for `Material Design Icons`, you need to set `icon`to be `material-icons md-18 search`
color | string | white | Color of text or icon
background | string | #ff5252 | Backgound of button 
hover | object | {background: '#eb0000' } | Effect when hover
topDistance | number | 200 | Scroll y position where button is visible, set 0 the button will always visible
timing | string | linear | Timing function scroll to top, `linear`, `easeIn`, `easeOut`, `easeInOut` are available
speed | number | 100 | Speed to scroll

## License
Copyright (c) 2017 ZiQiangWang [MIT](https://github.com/ZiQiangWang/react-back-top/blob/master/LICENSE) Licensed.

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