https://github.com/yvescoding/vuescroll

A customizable scrollbar plugin based on vue.js for PC , mobile phone, touch screen, laptop.
https://github.com/yvescoding/vuescroll

component javascript scrollbar slide virtual-scrollbar vue vue-components vuescroll

Last synced: 7 days ago
JSON representation

A customizable scrollbar plugin based on vue.js for PC , mobile phone, touch screen, laptop.

• Host: GitHub
• URL: https://github.com/yvescoding/vuescroll
• Owner: YvesCoding
• License: mit
• Created: 2017-07-25T13:51:16.000Z (over 7 years ago)
• Default Branch: dev
• Last Pushed: 2023-09-28T08:13:46.000Z (over 1 year ago)
• Last Synced: 2024-04-28T07:12:50.521Z (9 months ago)
• Topics: component, javascript, scrollbar, slide, virtual-scrollbar, vue, vue-components, vuescroll
• Language: JavaScript
• Homepage: https://vuescrolljs.yvescoding.me
• Size: 4.36 MB
• Stars: 1,270
• Watchers: 19
• Forks: 111
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.MD
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
 


Vuescroll



  

   

  









   



## Introduction

Vuescroll is a scrollbar plugin based on Vue.js 2.X, it is very easy to use, no complex options and each option has its default value(It means you don't even have to write any configuration). Just wrap the content by `` and a custom scrollbar will show. It supports:

- Customizable scrollbar

- Pull-to-refresh, push-to-load

- Carousel

## Compatibility

| vue version | vuescroll version |

| ----------- | ----------------- |

| 2.x         | <=4.X             |

| 3.x         | >=5.0.0           |

## Demo

- You can find demo under examples folder of repo.

- You can see the full features of vuescroll at [Live Demo](https://nifty-shannon-7eab38.netlify.app/demo) section of the website.

## Install

```bash

npm i vuescroll -S

# OR

yarn add vuescroll

```

## Usage

### Import and registry

#### For vue2.x

```js

import vuescroll from 'vuescroll';

import Vue from 'vue';

Vue.use(vuescroll, {

  ops: {

    // The global config

  },

  name: 'myScroll' // customize component name, default -> vueScroll

});

// OR

Vue.component('vue-scroll', vuescroll);

```

#### For vue3.x

```js

import { createApp } from 'vue';

import vuescroll from 'vuescroll';

const app = createApp(App);

// You can set global config here.

app.use(vuescroll, {

  ops: {

    // The global config

  },

  name: 'myScroll' // customize component name, default -> vueScroll

});

```

### Wrap the content by vue-scroll

```html



  

    


  



```


## Documentation

For detailed docs, please see [Guide](https://nifty-shannon-7eab38.netlify.app/guide) section on the website.

## Communication

- Wechat

 

- Twitter

[@wangyi70991](https://twitter.com/wangyi70991)

## License

**MIT** By Yves Wang(Wangyi Yi)