Popup Builder – Getting Started

  1. Overview
  2. Integration
  3. The Basics
  4. Content Width
  5. HTML Output (HTML Partials)
  6. Popup workspace
  7. Common settings
  8. Popup workspace layout
  9. Content area width

Overview

This section provides the information you need to get started integrating PopUp Builder in your SaaS applications. For more advanced settings, see Popup Builder – Advanced Settings.

Integration

Out-of-the-box, the setup, and configuration are the same as Email and Page Builder.  Loading Popup Builder with no additional settings will present the end-user with a beautifully designed popup and workspace to design their content.




beeConfig: {
  uid: 'CmsUserName', // [mandatory]
  container: 'bee-plugin-container', // [mandatory]
  ...
}



However, the popup builder comes with an additional, robust set of configuration options to customize the workspace.  This allows the host application to build a workspace that matches their popup’s look and feel and the page where you will embed the popup.

For example, the host app can customize…

  • The popup workspace background to view how the popup will look “in context” on the destination page.
  • The theme and position of the popup for both desktop and mobile design modes.

In the following sections, we will look at how to customize the workspace, starting with the common settings and working up to a full custom layout.

The Basics

Let’s start by looking at some of the differences between Page Builder and Popup Builder.

Content Width

In Email and Page Builder, the content area width is saved in the template. For example, if you start with an empty template, a default width that works for most scenarios is chosen, but the designer can use the message width slider to adjust it. If you start with an existing template, the content width was chosen by the template’s designer using the message width slider in the BEE Plugin’s Settings tab.

With Popup Builder, the same template may have multiple contexts, and each context will likely have specific size requirements. For example, an exit-intent popup may have a max-width of 600px on a desktop with a classical layout centered on the screen. The host app may display the same template on mobile in the bar style docked at the bottom of the screen with a restricted width of 300px.

Since the content area’s width is tightly coupled to the context and layout, no one size fits all width is saved in the template. Instead, the host app will specify the width settings when the editor loads, based on the context in which you will use the template.  You’ll find an example in the common settings section below.

Popup Builder MVP does not support fluid 100% width content. This is due to the internal dependencies on a fixed width, such as Image and Carousel Blocks.  A responsive option with 100% width is being scoped.

HTML Output (HTML Partials)

In Email and Page Builder, the BEE Plugin HTML parser service converts your template into an HTML document customized for email or pages, respectively. However, the Popup Builder will not return a full HTML page because the final destination is up to the host application. BEE Plugin Popup Builder doesn’t provide the scripts to control the popup’s behavior, such as opening and closing. Rather, Popup Builder provides the HTML “partials” to embed within your popup’s content area or body.

The HTML partial will come with all the CSS required to look as it did in the preview mode. The parser service will wrap the content with a special container that will clear all the host application styles and prevent style conflicts. The HTML output is designed to be embeddable into any popup framework or application and still render the way it appeared in the editor.

Popup workspace

Now that we covered the basic differences between Popup Builder and our other plugins let’s talk about what you should expect when the editor starts. 

As mentioned above in the Getting Started section, you will receive a ready-to-go design experience if no settings are provided.  The default layout is a classic centered modal with a fixed width.

 

If the default popup style and layout suit your needs, then you are all set to start designing! You can load the editor without any additional configuration and use the same standard controls and callbacks to access the HTML and JSON template.

What if you like most of the defaults but want to make some minor adjustments? We have you covered!

Common settings

Easily change the background to make the workspace look like the destination page where you’ll embed the popup.




beeConfig: {
  ...
  workspace: {
    popup: {
      backgroundImage: 'https://.../background.png',
      backgroundImageMobile: 'https://.../background.png',
      ...
    }
  }
}


If this option is not set, then we will provide a default skeleton layout.  It’s worth noting at this point that you can apply every setting for both desktop and mobile design modes. That means you can have a different background when editing in Mobile Design Mode. We’ll show you how later!

One of the most common needs is changing the popup’s position from the default-centered position to better match the end-user’s use case. Out-of-the-box, the Popup Builder comes with many of the most common popup layouts preconfigured. You can use any of the available presets “as is” or use them as starting points that you can fine-tune to your satisfaction.




beeConfig: {
  ...
  workspace: {
    popup: {
      layout: 'bar-top'
    }
  }
}


Here is a complete list of preset layouts:

table here to do

Content area width

As mentioned above, the content area’s width is tightly coupled to the layout, no one size fits all width is saved in the template. All Popup Builder preset layouts come with a default width, which you can override with the following configuration settings.




workspace: {
  popup: {
    contentWidth: 600,
    contentWidthMobile: 300
  }
}