BKWLD / vue-in-view

Vue component for triggering animations, adding classes, firing events, and syncing slot variables based on visibility in the viewport.

vue-in-view

Vue component for triggering animations, adding classes, firing events, and syncing slot variables based on visibility in the viewport.

• View demo
• Edit CodeSandbox

Install

yarn add @bkwld/vue-in-view

Default

import InView from '@bkwld/vue-in-view'
Vue.component 'in-view', InView

Nuxt

// nuxt.config.js
export default {
  buildModules: [ '@bkwld/vue-in-view/nuxt' ]
}

Usage

Use the animate prop to have vue-in-view reset CSS animations when the component does not mount within the viewport. When the user scrolls far enough to reveal the component, the animations will begin from the start. This is the primary use case of vue-in-view.

<template>
  <in-view animate class="box" />
</template>
<style>
.box {
  animation: box-intro 1s both;
}
@keyframes box-intro {
  to {
    background: pink;
  }
}
</style>

For more examples, check out the demo.

API

Props

Prop	Default	Description
animate	false	Reset CSS animations when hidden and play them when visible.
classes	false	Adds hidden class when hidden and visible when visible.
once	false	Stops watching for viewport changes after the first instance of the component being visible.
when	0%	A px or % value for delaying when the visible effect is applied. Can be a number (.25 for 25%, 200 for 200px) or a string. This is used to set the rootMargin and, as such, only px and % values are supported.
target	descendants	Only used with animate, this controls which elements' animations are controlled. May be descendants (self and all descendant elements), children (just the immediate children), or self (just animations applied to the vue-in-view component).

Slots

Slot	Description
default	Slot props:
	visible - True when in-view is visible.

Events

Event	Description
visible	Fired when in-view intersects the viewport.
hidden	Fired when not visible.

Contributing

Run yarn dev to open a Nuxt dev build of the demo directory.