doAction( "click_overlay" )
doAction( "click_overlay", $overlay );
The user clicked (or tapped) on the background overlay.
Params
-
$overlay
- (jQuery, required) The jQuery object of the overlay element.
Examples
// Clicking the overlay will hide it. // To test this, create a Popup with the option "Close on Background-Click: NO". // Of course, you need to click on the background to see the effect ;) DiviArea.addAction( 'click_overlay', function() { DiviArea.hideOverlay(); });
Notes
This action is the fired before any other check is done - it simply means "the overlay is visible and the user clicked it".
When the current Popup is set to "Close on Background-Click: NO" then nothing else will happen after this action was fired.