close( )

Closes a lightbox.

The close() method closes a lightbox and allows you to pass data from the lightbox to the page that opened the lightbox. If a lightbox is closed through the 'X' icon, close button, or lightbox overlay, data will not be returned to the original page.

To ensure data can be passed:

  1. Call this method to close a lightbox programmatically. For example, add a button with an onClick event handler that calls close().
  2. Disable these closing options in the lightbox's settings under Set Triggers.
Method Declaration
Copy
function close(data: object): Promise<void>;
Method Parameters
dataData

The data to pass back to the openLightbox() method.

JavaScript
import { lightbox } from "@wix/site-window";

// ...

await lightbox.lightbox().close();
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?