Using Lightbox SDK Without Installation ​

If you wish to use the Lightbox SDK library without installing it, you can do so thanks to the messaging interface it provides. This functionality is based on the postMessage method from JavaScript's window API. Instead of directly calling the library's functions, you can send messages from the iframe, which the library will interpret.

Message Structure ​

The basic structure of the messages you send should be as follows:

• Type

  ts

  parent.postMessage(
    { type: string; payload?: unknown, preventClose?: boolean }, '*'
  )

• Details

  Here, type is the name of the event you want to fire, payload is any additional data you want to pass to the event handler, and preventClose indicates whether to prevent the lightbox from closing after the event

• Example

  js

  parent.postMessage({ type: 'close' }, '*')

Reserved Types ​

The Lightbox SDK library uses certain types of events for internal functions. Using these types will trigger the associated predefined actions, but will also invoke the callback of the same name (enclosing the interaction information). The reserved types are the following:

• close: Triggers the lightbox to close.
• sendStyles: Requests for new styles to be applied to the lightbox.
• hideCloseButton: Hides the manual close button of the lightbox.

Predefined Actions ​

Given the use of certain names for predefined events, you can trigger these actions by sending a message with the corresponding event type. For example, to close the lightbox, you can send the following message:

parent.postMessage({ type: 'close' }, '*')

This will result in the lightbox closing. This approach can be used to interact with the Lightbox SDK library without needing to install it directly into your code.