vue-scrollmonitor

VueScrollmonitor

Handle scroll events like a boss

Wrapper to use the awesome scrollMonitor with Vue@2.4.x

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

Demos

Simple example see source : here

Installation

npm install vue-scrollmonitor

// or

yarn add vue-scrollmonitor

Usage

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

Use the plugin

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)

or registering components directly

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,
  }
}

Doc

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

ScrollContainer

---

Props

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

---

Events

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,
  }
  ...
}

ScrollItem

---

Props

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 When lock option is set to true, your content will be wrapped in a placeholder element to allow fixed positioning to work easily.

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

---

Events

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

---

HTML classes

ScrollItem will assign meaninful classes to reflect current state. It comes handy to style your elements according to its state (eg: floating sidebar) *possible values: isaboveviewport | isbelowviewport | isinviewport | isfullyinviewport *

License

MIT © Alexandre Bonaventure