0.0.5 • Published 2 years ago

v-scroll-progression v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

v-scroll-progression

Scroll progress indicator component for Vue 2.

Installation

# Using NPM
npm install v-scroll-progression
# Using Yarn
yarn add v-scroll-progression

Register the component:

import VScrollProgression from "v-scroll-progression";

Vue.use(VScrollProgression);

Nuxt 2

Create a file called v-scroll-progression.client.js in your plugins/ folder. In there put the following:

import Vue from "vue";
import VScrollProgression from "v-scroll-progression";

Vue.use(VScrollProgression);

Next, open your nuxt.config.js and add ~/plugins/v-scroll-progression.js to the plugins array.

Usage

U can use the component in any of your components by using the <v-scroll-progression/> or <VScrollProgression/> tag.

Props

NameTypeRequiredDefault ValueAllowed ValuesDescription
colorStringfalse#41B883Color of the progress indicator.
backgroundStringfalse#35495EBackground color of the progress bar.
heightString, Numberfalse5pxHeight of the progress bar.
placementStringfalsetopbottom, topSets the placement of the progess bar.

License

The MIT License (MIT). Please see the License File for more information.