https://github.com/yvescoding/vuepress-theme-vuescroll

A vuepress theme that you can use leverage vuescroll.
https://github.com/yvescoding/vuepress-theme-vuescroll

vuepress-theme vuescroll

Last synced: about 2 months ago
JSON representation

A vuepress theme that you can use leverage vuescroll.

• Host: GitHub
• URL: https://github.com/yvescoding/vuepress-theme-vuescroll
• Owner: YvesCoding
• Created: 2018-09-09T04:03:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-12T02:12:34.000Z (almost 2 years ago)
• Last Synced: 2024-04-26T12:42:07.249Z (9 months ago)
• Topics: vuepress-theme, vuescroll
• Language: Vue
• Homepage: https://vuescrolljs.yvescoding.org/
• Size: 202 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Introduction

> vuepress-theme-vuescroll is a [`vuepress`](https://github.com/vuejs/vuepress) theme `plugin` that allow you customize scrollbars by [`vuescroll`](https://github.com/YvesCoding/vuescroll) in Vuepress.

## Who use this plugin ?

- [vuescroll offical website](http://vuescrolljs.yvescoding.org/)

- More... Welcome to tell me !

## Usage

1. Installation

```bash

  npm i vuepress-theme-vuescroll -S

```

2. Config.js

To use a theme from an npm dependency, provide a theme option in .vuepress/config.js:

```javascript

module.exports = {

  theme: 'vuescroll'

};

```

3. Create an `enhanceApp.js` in your `.vuepress` folder and write such code:

```javascript

// enhanceApp.js

import { registry } from 'vuepress-theme-vuescroll';

export default ({ Vue, router, store }) => {

  // Your  options of most outside vuescroll.

  let ops = {

    bar: {

      background: '#3eaf7c'

    },

    rail: {

      gutterOfEnds: '60px'

    },

    scrollPanel: {

      scrollingX: false

    }

  };

  // THe version you would like to use.

  // default: vuescroll(mix)

  // options: slide, native

  const mode = 'native';

  // Tell vuescroll your option.

  registry(ops, mode);

};

```

4. That's all, you can use vuescroll in your own App!

## Current Vuepress Version

### 0.14.2

## License

### MIT