https://github.com/abdallahhemdan/vee-observe
Detect when an element is becoming visible or hidden on the page using Vue component for the Intersection observer API
https://github.com/abdallahhemdan/vee-observe
intersection-observer scrolling vee-observe viewport vuejs
Last synced: about 1 year ago
JSON representation
Detect when an element is becoming visible or hidden on the page using Vue component for the Intersection observer API
- Host: GitHub
- URL: https://github.com/abdallahhemdan/vee-observe
- Owner: AbdallahHemdan
- License: mit
- Created: 2023-03-25T18:44:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T22:10:59.000Z (about 3 years ago)
- Last Synced: 2025-04-29T10:48:56.039Z (about 1 year ago)
- Topics: intersection-observer, scrolling, vee-observe, viewport, vuejs
- Language: Vue
- Homepage: https://www.npmjs.com/package/vee-observe
- Size: 257 KB
- Stars: 17
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vee Observe
[![Version Badge][npm-version-svg]][package-url]
[![GZipped size][npm-minzip-svg]][bundlephobia-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[](https://github.com/AbdallahHemdan/vee-observe/contributors)
[](https://github.com/AbdallahHemdan/vee-observe/stargazers)
> Vue implementation of the [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to tell you when an element enters or leaves the viewport.
## Features
- 📦 **Component API** - With `vee-observe` it's easier than ever to monitor elements
- ⚡️ **Optimized performance** - Reuses Intersection Observer instances where possible
- ⚙️ **Matches native API** - Intuitive to use
- 🧪 **Ready to test** - Mocks the Intersection Observer for easy testing with [Jest](https://jestjs.io/)
- 💥 **Tiny bundle** - Around **1.1kB**
## Installation
Install using [Yarn](https://yarnpkg.com):
```sh
yarn add vee-observe
```
or NPM:
```sh
npm install vee-observe --save
```
## Usage
### `vee-observe` component
```vue
Scroll down to see the image
![]()
import VeeObserve from './components/observer/observer.vue';
export default {
name: 'App',
data () {
return {
imgSrc: '',
};
},
components: { VeeObserve },
methods: {
onChange (entry) {
console.log('on change', entry);
if (entry.isIntersecting) {
console.log('intersecting');
this.imgSrc = 'https://picsum.photos/200/300';
}
},
notSupported () {
console.log('not supported');
this.imgSrc = 'https://picsum.photos/200/300';
},
},
};
.large-content__wrapper {
height: 2000px;
line-height: 1000px;
text-align: center;
font-size: 48px;
color: #2c3e50;
font-weight: bold;
}
```
## API
### Options
Provide these as the options argument as props on the **``** component.
| Name | Type | Default | Description |
| ---------------| -----------------------------| ----------- | ----------- |
| **root** | `Element` | `document` | The Intersection Observer interface's read-only root property identifies the Element or Document whose bounds are treated as the bounding box of the viewport for the element which is the observer's target. If the root is `null`, then the bounds of the actual document viewport are used. |
| **rootMargin** | `string` | `'0px'` | Margin around the root. Can have values similar to the CSS margin property, e.g. "10px 20px 30px 40px" (top, right, bottom, left). The values can be percentages. This set of values serves to grow or shrink each side of the root element's bounding box before computing intersections. Defaults to all zeros. |
| **threshold** | `number` or `number[]` | `0` | Number between `0` and `1` indicating the percentage that should be visible before triggering. Can also be an array of numbers, to create multiple trigger points. |
| **once** | `boolean` | `false` | Only trigger the observer once. |
| **onChange** | `(entry, unobserve) => void` | `undefined` | Call this function whenever the intersection state changes. It will receive the current `IntersectionObserverEntry` along with `unobserve` function to stop monitoring and observing the component. |
| **notSupported** | `() => void` | `undefined` | Call this function if intersection observer is not support. |
[package-url]: https://www.npmjs.com/package/vee-observe
[npm-version-svg]: https://img.shields.io/npm/v/vee-observe.svg
[npm-minzip-svg]:
https://img.shields.io/bundlephobia/minzip/vee-observe.svg
[bundlephobia-url]:
https://bundlephobia.com/result?p=vee-observe
[license-image]: http://img.shields.io/npm/l/vee-observe.svg
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/vee-observe.svg
[downloads-url]:
http://npm-stat.com/charts.html?package=vee-observe
[test-image]:
https://github.com/thebuilder/vee-observe/workflows/Test/badge.svg