# vue-slim-scrolltop

> A Simple ScrollTop Button Component for Vue.js, that scroll page to top when clicked.

Latest version **0.1.0** (published 2019-12-13) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install vue-slim-scrolltop
pnpm add vue-slim-scrolltop
yarn add vue-slim-scrolltop
bun add vue-slim-scrolltop
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-12-13 |
| First published | 2019-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | CHE5YA |
| Maintainers | che5ya |
| Keywords | scrolltop, backtotop, floating, button, vue, vuejs |

## Links

- npm: https://www.npmjs.com/package/vue-slim-scrolltop
- Repository: https://github.com/che5ya/vue-slim-scrolltop
- Homepage: https://github.com/che5ya/vue-slim-scrolltop#readme
- Issues: https://github.com/che5ya/vue-slim-scrolltop/issues
- npm.io page: https://npm.io/package/vue-slim-scrolltop

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.5.17
- [request-animation-frame-polyfill](https://npm.io/package/request-animation-frame-polyfill.md) ^1.0.1

## Recent versions

- 0.1.0 (latest) — 2019-12-13

## README

# vue-slim-scrolltop

A Simple ScrollTop Button Component for Vue.js, that scroll page to top when clicked.


## Features

- Make Floating ScrollTop Button Component on your project


## Installing

```bash
$ npm install vue-slim-scrolltop
```


## Usage

* Default Usage :
```js
<template>
  <div>
    <scroll-top />
  </div>
</template>

<script>
import ScrollTop from 'vue-slim-scrolltop';

export default {
  components: {
    ScrollTop,
  },
};
</script>

```

* If you wanna use custom settings, then : 
```js
<template>
  <div>
    <scroll-top
    :locationX="locationX"
    :locationY="locationY"
    :dataX="dataX"
    :dataY="dataY"
    :text="text" />
  </div>
</template>

<script>
import ScrollTop from 'vue-slim-scrolltop';

export default {
  components: {
    ScrollTop,
  },
  data() {
    return {
      locationX: 'left',
      locationY: 'bottom',
      dataX: 10,
      dataY: 10,
      text: 'Scroll to Top (Custom Text)',
    };
  },
};
</script>

```

## Props

| Name                | Type             | Default              | Description                                    |
|---------------------|------------------|----------------------|------------------------------------------------|
| locationX           | String           | 'right'              | X-Axis Type of position, like 'left', 'right'. |
| locationY           | String           | 'bottom'             | Y-Axis Type of position, like 'top', 'bottom'. |
| dataX               | String or Number | 80                   | X-Axis value of position                       |
| dataY               | String or Number | 80                   | Y-Axis value of position                       |
| text                | String           | 'Scroll Page to Top' | Text of button                                 |


## Author

**vue-slim-scrolltop** © [CHE5YA](https://github.com/che5ya), Released under the [MIT](./LICENSE) License.<br>

> GitHub [@che5ya](https://github.com/che5ya) · Facebook [@che5ya](https://www.facebook.com/che5ya) · Twitch [@chesya_](https://www.twitch.tv/chesya_)


## License

[MIT](LICENSE)

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