Block Client API

OpenPopup1

Requests to open a popup (HTML5 modal dialog) displaying a given URL.

MethodpostMessage
Message Data{ "bubblehouseBlockClientCall": "OpenPopup1", ... }

Blocks API Example

For an elaborate example showing how to embed blocks and handle Block Client calls, including popups, see the dedicated Blocks API example page.

Query Parameters

  • instancestringrequired

    Block instance identifier passed to the Blocks API.

    Empty string if an instance identifier has not been provided.

  • urlstringrequired

    URL of the popup block to open.

    This URL is gonna refer to a Bubblehouse Block. It will already have auth populated with the same token you have passed to the opener block.

    IMPORTANT: You are expected to generate a unique block instance identifier and add it to the URL as instance query parameter.

  • namestringrequired

    Name of the block to open.

    You don't need to do anything with this value (because the URL already encodes the block name). It is provided to aid in naming and debugging.

  • dialogStylestringrequired

    CSS styles to apply to the DIALOG element.

    Set your new HTML5 dialog's style property to this value.

  • frameStylestringrequired

    CSS styles to apply to the IFRAME element.

    Set your new iframe's style property to this value.

Previous
AddProductToCart1