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:
onClick
event handler that calls close()
.function close(data: object): Promise<void>;
The data to pass back to the openLightbox()
method.
import { lightbox } from "@wix/site-window";
// ...
await lightbox.lightbox().close();
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.