Trigger A Function When You Scroll To An Element – VueWaypoint

Trigger A Function When You Scroll To An Element – VueWaypoint

Trigger A Function When You Scroll To An Element – VueWaypoint trigger functions based on elements' positions, based on viewport

VueWaypoint

trigger functions based on elements' positions, based on viewport

Demo

demo page

Installation

npm

$ npm install vue-waypoint --save-dev

Vue

import Vue from 'vue'
import VueWaypoint from 'vue-waypoint'

// Waypoint plugin
Vue.use(VueWaypoint)

Usage

VueWaypoint is a directive named v-waypoint

Template

<template>
  <div v-waypoint="{ active: true, callback: onWaypoint, options: intersectionOptions }"></div>
</template>

Javascript

export default {
  data: () => ({
    intersectionOptions: {
      root: null,
      rootMargin: '0px 0px 0px 0px',
      threshold: [0, 1] // [0.25, 0.75] if you want a 25% offset!
    } // https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
  })
  methods: {
    onWaypoint ({ going, direction }) {
      // going: in, out
      // direction: top, right, bottom, left
      if (going === this.$waypointMap.GOING_IN) {
        console.log('waypoint going in!')
      }

      if (direction === this.$waypointMap.DIRECTION_TOP) {
        console.log('waypoint going top!')
      }
    }
  }
}

API

Directive's options

  • active [boolean]: set this parameter as you wish, changing dynamically the waypoint status (it removes and adds the waypoint physically)

  • callback [function]: every time the waypoint triggers this function will be called with a Waypoint object as parameter

  • options [object]: you can leave this undefined or follow IntersectionObserver API (options)

Waypoint object

Each callback call comes with a Waypoint object defined as follows:

{
  el: Node,
  going: String,
  direction: String,
  _entry: IntersectionObserverEntry
}

You can map going and direction with the following global map, callable in every Vue's Component:

this.$waypointMap

Then you can compare map's elements with the callback's parameters:

if (direction === this.$waypointMap.DIRECTION_TOP) {}

Public API methods

  • VueWaypoint.addObserver (Element el, function callback, Object options)

  • VueWaypoint.removeObserver (Element el, function callback)

  • VueWaypoint.map

Best practices

You are encouraged to use v-waypoint directive since it follows the Vue's flow, anyway you can progammatically add new waypoints as you like, even outside Vue's context.

This can be accomplished with addObserver and removeObserver.

You can call them inside Vue's components with this.$addObserver and this.$removeObserver.

They are also available as standalone-plugin, just go with VueWaypoint.addObserver and VueWaypoint.removeObserver.

Caveats

Waypoint first trigger is on page load, this means it actually triggers its own callback with direction = undefined (yes, we can't determine direction if no scroll has been made by the user)

You may need an IntersectionObserver polyfill for browsers like IE11

How to use with Nuxt

You have to make certain changes when using vue-waypoint in a nuxt application mainly because it is designed for client side. Otherwise this could cause errors due to references to the window object.

1. Add the package to the project as usual

$ npm install vue-waypoint --save

2. Create new plugin file

Create new file under plugins folder and name it v-waypoint.js

3. Add the following code to v-waypoint.client.js to install the vue-waypoint

import Vue from "vue"
import VueWaypoint from "vue-waypoint"

Vue.use(VueWaypoint)

4. Update the nuxt.config.js to reference the plugin file

The mode: 'client' option will make sure v-waypoint is rendered and used only in the client-side bundle.

...
  plugins: [    
    ...
    {
      src: "~/plugins/v-waypoint.js",
      mode: 'client'
    }
  ],
...

Download Details:

Author: scaccogatto

Demo: https://scaccogatto.github.io/vue-waypoint/

Source Code: https://github.com/scaccogatto/vue-waypoint

vuejs vue javascript

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

8 Popular Websites That Use The Vue.JS Framework

In this article, we are going to list out the most popular websites using Vue JS as their frontend framework. Vue JS is one of those elite progressive JavaScript frameworks that has huge demand in the web development industry. Many popular websites are developed using Vue in their frontend development because of its imperative features.

Vue Native is a framework to build cross platform native mobile apps using JavaScript

Vue Native is a framework to build cross platform native mobile apps using JavaScript. It is a wrapper around the APIs of React Native. So, with Vue Native, you can do everything that you can do with React Native. With Vue Native, you get

How to Make a Simple Vue Custom Select Component

In this article, you’ll learn how to build a Vue custom select component that can be easily be styled using your own CSS. In fact, it’s the same component that we use in production on Qvault, and you can see it in action on the playground.

Creating a Custom Tooltip Component in Vue

There are plenty of libraries out there that will have you up and running with a good tooltip solution in minutes. However, if you are like me, you are sick and tired of giant dependency trees that have the distinct possibility of breaking at any time.

Vue ShortKey plugin for Vue.js

Vue-ShortKey - The ultimate shortcut plugin to improve the UX .Vue-ShortKey - plugin for VueJS 2.x accepts shortcuts globaly and in a single listener.