MathMesquita / v-bar

A virtual scrollbar component for VueJS 2x

VBar

A virtual scrollbar component for VueJS 2x

Usage

Install

# Using NPM
npm i v-bar

# Using yarn
yarn add v-bar

In your .vue component

<style>
    # Create one class to your wrapper
    # Using SASS
    .wrapper
        height: 300px
        width: 300px

    # Using pure CSS
    .wrapper {
        height: 300px;
        width: 300px;
    }
</style>

<template>
    # Include the component in your template
    # Using PUG lang
    v-bar(wrapperClass="",
        verticalBarClass="",
        verticalBarInternalClass="",
        horizontalBarClass="",
        horizontalBarInternalClass="")
        # Your content
        ...

    # Using HTML
    <v-bar wrapperClass=""
        verticalBarClass=""
        verticalBarInternalClass=""
        horizontalBarClass=""
        horizontalBarInternalClass="">
        # Your content
        ...
    </v-bar>
</template>

<script>
    # Import component
    import VBar from 'v-bar'

    # Declare
    export default {
        components: { VBar }
    }
</script>

Options

VBar is fully customizable. You can use your CSS classes to make it even more beautiful :)

    { String } *required* wrapperClass=""
    { String } *optional* verticalBarClass=""
    { String } *optional* verticalBarInternalClass=""
    { String } *optional* horizontalBarClass=""
    { String } *optional* horizontalBarInternalClass=""

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# build for production and view the bundle analyzer report
npm run build --report

To contribute

Contributions are always welcome!
Clone the repo
Change what you want
Send PR