Skip to content
forked from luiguild/v-bar

A virtual scrollbar component for VueJS 2x

License

Notifications You must be signed in to change notification settings

Gr33nbl00d/v-bar

 
 

Repository files navigation

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
# using NPM
npm install

# using yarn
yarn

# 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 and make it better

Clone/fork the repo
Change what you want
Send PR

Contributions are always welcome!

Special thanks!

Carlo Fragni https://github.com/carlofragni

About

A virtual scrollbar component for VueJS 2x

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.0%
  • Vue 40.2%
  • CSS 7.9%
  • HTML 0.9%