Angelos Chatzimparmpas
e069030893
|
3 years ago | |
|---|---|---|
| .. | ||
| dist | 3 years ago | |
| example | 3 years ago | |
| src | 3 years ago | |
| test/unit | 3 years ago | |
| types | 3 years ago | |
| .eslintrc.js | 3 years ago | |
| LICENSE | 3 years ago | |
| README.md | 3 years ago | |
| _config.yml | 3 years ago | |
| karma.conf.js | 3 years ago | |
| package.json | 3 years ago | |
| postcss.config.js | 3 years ago | |
| rollup.config.js | 3 years ago | |
| webpack.config.js | 3 years ago | |
README.md
vue2-perfect-scrollbar
Vue.js minimalistic but powerful wrapper for perfect scrollbar
Why I Created it ?
Because I ❤️ to use perfect-scrollbar in my projects (🙌 utatti). But also because the current solutions on github are outdated or overcomplicated.
Why would you use it ?
Because you want to load perfect-scrollbar to your Vue project in an easy way. But also because this plugin is updated, tested and build by rollup. So you will not find any unnecessary 💩 code in this repo. I hope 🙏.
If you have any reasonable PR you are welcome 🤘
Install
npm
npm install vue2-perfect-scrollbar
yarn
yarn add vue2-perfect-scrollbar
How to use
Global Registration
import PerfectScrollbar from 'vue2-perfect-scrollbar'
import 'vue2-perfect-scrollbar/dist/vue2-perfect-scrollbar.css'
Vue.use(PerfectScrollbar)
So then you can use this plugin in each component as
<perfect-scrollbar>
<p> Lorem Ipsum is simply dummy text of the printing and typesetting industry. </p>
</perfect-scrollbar>
Global options
Install method takes additional parameters:
name {String}
Name of your global component.
Default: PerfectScrollbar
tag {String}
Tag which will be render as perfect scrollbar container
Default: div
watchOptions {Boolean}
Set true if you want to update perfect-scrollbar on options change
Default: false
options {Object}: Options
perfect-scrollbar options.
Default: {}
Local Registration
<template>
<div>
<perfect-scrollbar>
<p> Lorem Ipsum is simply dummy text of the printing and typesetting industry. </p>
</perfect-scrollbar>
</div>
</template>
<script>
import { PerfectScrollbar } from 'vue2-perfect-scrollbar'
export default {
components: {
PerfectScrollbar
}
}
</script>
<style src="vue2-perfect-scrollbar/dist/vue2-perfect-scrollbar.css"/>
Props
tag {String}
Tag which will be render as perfect scrollbar container
Default: div
watchOptions {Boolean}
Set true if you want to update perfect-scrollbar on options change
Default: false
options {Object}: Options
perfect-scrollbar options.
Events
You can listen on every event which offer you perfect-scrollbar. Read more
DEMO
https://mercs600.github.io/vue2-perfect-scrollbar/. You can also fork example from codesandbox
Cookbook
Soon