Vuescroll
English Version | [中文版](https://github.com/YvesCoding/vuescroll/blob/dev/README-ZH.md)
> A beautiful scrollbar based on Vue.js for PC and mobile.
> [vuescrolljs.yvescoding.org](http://vuescrolljs.yvescoding.org/)
## Preview
## Online Demo & Documentation
[Offical Website](http://vuescrolljs.yvescoding.org/demo/)
## Features
- Support mobile and phone
- Smooth scroll
- Customizable
- Pull to refresh and push to load
- ...
## Quick Start
### Installation
#### Install by npm or yarn
```bash
npm install vuescroll -S
# yarn add vuescroll
```
#### Or Upgrade
```bash
npm i vuescroll@latest
# yarn add vuescroll@latest
```
### Usage
1. First, install `Vuescroll` in your entry file
```javascript
import Vue from 'vue';
import vuescroll from 'vuescroll';
// Note: from 4.6.6, you need to import the .css file
import 'vuescroll/dist/vuescroll.css';
Vue.use(vuescroll);
const vm = new Vue({
el: '#app',
data: {
ops: {
// The following configurations correspond to different parts of Vuescroll.
vuescroll: {},
scrollPanel: {},
rail: {},
bar: {}
}
}
});
```
2. Then use vuescroll to wrap the contents that need to be scrolled.
```html
```
### API
[API](http://vuescrolljs.yvescoding.org/guide/api.html)
### Event
[Event](http://vuescrolljs.yvescoding.org/guide/event.html)
### Slot
[Slot](http://vuescrolljs.yvescoding.org/guide/slot.html)
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/YvesCoding/releases).
## Contribution
Please check out [CONTRIBUTING](.github/CONTRIBUTING.md).
## Inspired By
- [slimscroll](http://rocha.la/jQuery-slimScroll)
- [element-ui](http://element.eleme.io/#/zh-CN/component/installation)
- [scroller](http://zynga.github.io/scroller/)
- [CodePen](https://codepen.io/wangyi7099/pen/YLVBNe)
- [better-scroll](https://github.com/ustbhuangyi/better-scroll)
## License
**MIT**