doAction( “click_overlay” )

  1. Home
  2. Knowledge Base
  3. Codex
  4. JS API
  5. JS Actions
  6. doAction( “click_overlay” )
DiviArea.doAction( 'click_overlay' );

Function description

Params

This action has no params.

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”, or no Popup is visible then nothing else will happen.

Was this article helpful?

Related Articles