Repository files navigation

Handle scroll events like a boss

Wrapper to use the awesome scrollMonitor withVue@2.4.x

To know more :https://github.com/stutrek/scrollMonitor

Simple examplesee source :here

npm install vue-scrollmonitor// oryarn add vue-scrollmonitor

VueScrollMonitor relies on two components. So in order to use it, you have two choices:

It will register the components globally so you'll be able to leverage the plugin in every components.

import VueScrollMonitor from 'vue-scrollmonitor'Vue.use(VueScrollMonitor)

Otherwise fell free to import and register manually the two plugins.

import { ScrollContainer, ScrollItem } from 'vue-scrollmonitor'// then, in component definition:{  name: 'MyComponent',  components: {    ScrollContainer,    ScrollItem,  }}

see source of example for recipesTo track items with ScrollItem component you'll need to wrap them in a ScrollContainer component.

container :DOMElement
By default, ScrollContainer will listen to scroll events emitted from HTML body, but you can setup another DOM element to watch for scrolling event.see also

change => Object
Every time scrollMonitor updates, it will fire a change event transporting the state of tracked items (aka all ScrollItem components children of this container).

One common pattern is to retrieve the state in the parent component (or register it in Vuex state for example) listening to this event. That way you can have access the state in the template easily.

The state is an index following this structure:

{  id: {    isAboveViewport: Boolean,    isBelowViewport: Boolean,    isInViewport: Boolean,    isFullyInViewport: Boolean,  }  ...}

id :String|Number
default: random uid
Id is required to keep track of each item watcher & state. You can pass your own id as long as you make sure it is unique for each ScrollItem in a ScrollContainer component.

lock :Boolean
default: false
see

offset :Number | { top :Number, bottom :Number }
default: undefined
see

change => Object
same as ScrollContainer but for this item.

MIT © Alexandre Bonaventure