close( )


Closes the lightbox.

The close() function closes the lightbox and returns the given data to the openLightbox() function that was used to open the lightbox.

To pass data back to the page that opened the lightbox, you must close the lightbox programmatically using the close() function. If the lightbox is closed by the site visitor clicking the 'X' icon, close button, or lightbox overlay, data will not be passed back the the page that opened the lightbox. Therefore, if you want to make sure data is passed back to the page that opened the lightbox, disable all of the methods mentioned above and create your own method for closing the lightbox programmatically. For example, you can add a button with an onClick event handler that calls the close() function.

Method Declaration
Copy
Method Parameters
dataobject

The data to pass back to openLightbox() function.

Was this helpful?
Yes
No