Scroll Trigger

The "Scroll Depth" Trigger fires when the visitor has reached the specified amount of scroll depth set in percentage or pixel. If the specified scroll depth is visible in the viewport when the page loads, the trigger will fire without a scroll occurring. Below you can find how to set up a popup with "Scroll Depth" trigger, all supported settings for this trigger explained as well as how to trigger it with the JavaScript Events API.

To set up your popup to trigger on Scroll Depth go to your popup settings > Behavior Tab > Trigger Section and apply the following settings:

Under the Trigger setting, select Scroll Depth.
Set the Scroll Depth indicating the unit(Percentage or Pixel) used to identify if the user has reached the determined scroll depth to fire the event.
Selecting "Percentage" will display a Scroll Percentage setting that you can set the percentage that will be used to identify whether the user has scrolled to the amount you specified on your page.
Selecting "Pixel" will display a Pixel setting that you can set the number of pixels to identify whether the user has scrolled the amount you specified on your page.
Set whether to close the popup when you reverse scroll on the page on the Close on Reverse Scroll setting.
Set whether to fire the trigger once or unlimited times on the Firing Frequency setting.
Lastly, set the delay of the trigger by entering a number in milliseconds in the Delay setting

Trigger Settings

Below you can find all settings that are configurable when you choose the "Scroll Depth" Trigger.

Setting	Value	Description
Trigger	Scroll Depth	Fires when the visitor has reached the specified amount of scroll depth
Scroll Depth	Percentage / Pixel	The vertical scroll depths reached to fire the event. If the specified scroll depth is visible in the viewport when the page loads, the trigger will fire without a scroll occurring.
Scroll Percentage	80	Popup will appear when the user has scrolled at a selected percentage of the document's total height. Enter a number 1-100
Pixel	100	Popup will appear when the user has scrolled at a selected amount of pixels of the document's total height.
Close on Reverse Scroll	Disabled	Close the popup when the user scrolls on the opposite direction
Firing Frequency	Once Per Page	Configure the fire frequency of this trigger per page. Once Per Page: The trigger will fire only once per page. Unlimited: The trigger will fire whenever the event occurs on the page.
Delay	0	Delay trigger in miliseconds. Leave 0 for immediate execution or enter 2000 for 2 seconds delay. If the trigger point is set to onElementHover then this value is used to delay or prevent the accidental firing of the popup and attempts to determine the user's intent. It is recommended to use at least 30 ms.

Use Cases

A use case for this trigger would be when you want to display a popup near the end of your page(i.e. above the footer), as soon as your user scrolls to 80% of your page height. This trigger gives you flexibility as well as provides accuracy by letting you display your popup in any part of your page.

This use case is rather useful when you want to display a popup after a user has scrolled a specific number of pixels, above, on or below specific content on your page that you can define it in pixel-perfect accuracy.

Frequently Asked Questions

How to Trigger using JavaScript

Using the JavaScript Events API v2, you can configure any popup to be triggered using the "Scroll Depth" Trigger. Below you can find a JavaScript snippet:

EngageBox.onReady(function() {
    // Get box instance
    const box = EngageBox.getInstance(5);

    box.bindTrigger('onScrollDepth', {
        scroll_depth: 'pixel',
        scroll_depth_value: 300
        reverse_scroll_close: true
    });
});

You can read more on the JavaScript Events API documentation, Scroll Depth Trigger.

How to create a Scroll Triggered popup in Joomla

Trigger Settings

Use Cases

Open popup once the user has scrolled to 80% of the page height

Open popup once the user has scrolled an amount of pixels

Frequently Asked Questions

How to Trigger using JavaScript