doAction( “show_overlay” )

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

Fired after the background overlay was attached to the DOM and is currently fading-in.

Params

overlay
(object) The jQuery object of the overlay element.

Examples

// Apply a custom class to the overlay div.
DiviArea.addAction( 'show_overlay', function( overlay ){
    overlay.addClass( 'my-class' );
});

Notes

When this action is fired, the overlay is attached to the DOM and fully initialized. At this point, the fade-in animation has started (the duration of this animation can be changed via DiviAreaConfig.animateSpeed).

Was this article helpful?

Related Articles