Alpine UI is on sale for Black Friday! Grab 'em here →

Intersect Plugin

Alpine's Intersect plugin is a convenience wrapper for Intersection Observer that allows you to easily react when an element enters the viewport.

This is useful for: lazy loading images and other content, triggering animations, infinite scrolling, logging "views" of content, etc.

Installation

You can use this plugin by either including it from a <script> tag or installing it via NPM:

Via CDN

You can include the CDN build of this plugin as a <script> tag, just make sure to include it BEFORE Alpine's core JS file.

<!-- Alpine Plugins -->
<script defer src="https://unpkg.com/@alpinejs/[email protected]/dist/cdn.min.js"></script>
 
<!-- Alpine Core -->
<script defer src="https://unpkg.com/[email protected]/dist/cdn.min.js"></script>

Via NPM

You can install Intersect from NPM for use inside your bundle like so:

npm install @alpinejs/intersect

Then initialize it from your bundle:

import Alpine from 'alpinejs'
import intersect from '@alpinejs/intersect'
 
Alpine.plugin(intersect)
 
...

x-intersect

The primary API for using this plugin is x-intersect. You can add x-intersect to any element within an Alpine component, and when that component enters the viewport (is scrolled into view), the provided expression will execute.

For example, in the following snippet, shown will remain false until the element is scrolled into view. At that point, the expression will execute and shown will become true:

<div x-data="{ shown: false }" x-intersect="shown = true">
<div x-show="shown" x-transition>
I'm in the viewport!
</div>
</div>
Scroll Down 👇
I'm in the viewport!
 

x-intersect:enter

The :enter suffix is an alias of x-intersect, and works the same way:

<div x-intersect:enter="shown = true">...</div>

You may choose to use this for clarity when also using the :leave suffix.

x-intersect:leave

Appending :leave runs your expression when the element leaves the viewport:

<div x-intersect:leave="shown = true">...</div>

Modifiers

.once

Sometimes it's useful to evaluate an expression only the first time an element enters the viewport and not subsequent times. For example when triggering "enter" animations. In these cases, you can add the .once modifier to x-intersect to achieve this.

<div x-intersect.once="shown = true">...</div>

.half

Evaluates the expression once the intersection threshold exceeds 0.5.

Useful for elements where it's important to show at least part of the element.

<div x-intersect.half="shown = true">...</div> // when `0.5` of the element is in the viewport

.full

Evaluates the expression once the intersection threshold exceeds 0.99.

Useful for elements where it's important to show the whole element.

<div x-intersect.full="shown = true">...</div> // when `0.99` of the element is in the viewport

.threshold

Allows you to control the threshold property of the underlying IntersectionObserver:

This value should be in the range of "0-100". A value of "0" means: trigger an "intersection" if ANY part of the element enters the viewport (the default behavior). While a value of "100" means: don't trigger an "intersection" unless the entire element has entered the viewport.

Any value in between is a percentage of those two extremes.

For example if you want to trigger an intersection after half of the element has entered the page, you can use .threshold.50:

<div x-intersect.threshold.50="shown = true">...</div> // when 50% of the element is in the viewport

If you wanted to trigger only when 5% of the element has entered the viewport, you could use: .threshold.05, and so on and so forth.

.margin

Allows you to control the rootMargin property of the underlying IntersectionObserver. This effectively tweaks the size of the viewport boundary. Positive values expand the boundary beyond the viewport, and negative values shrink it inward. The values work like CSS margin: one value for all sides, two values for top/bottom, left/right, or four values for top, right, bottom, left. You can use px and % values, or use a bare number to get a pixel value.

<div x-intersect.margin.200px="loaded = true">...</div> // Load when the element is within 200px of the viewport
<div x-intersect:leave.margin.10%.25px.25.25px="loaded = false">...</div> // Unload when the element gets within 10% of the top of the viewport, or within 25px of the other three edges
<div x-intersect.margin.-100px="visible = true">...</div> // Mark as visible when element is more than 100 pixels into the viewport.

Code highlighting provided by Torchlight