Documentation > Web

UI Components

To maximize the chances that your users subscribe to notifications, we built multiple ways of asking for permission.

When in fully secure mode, you have the possibility of asking for the browser's notification optin directly, even if not recommended.
A UI Component is required for the HTTP/Multidomain mode, as a click event is required to open a popup without it being caught by browser's builtin blockers.

UI Components (except for popup, which is used by the HTTP/Multidomain SDK) are automatically added to your web page once you configure them.
Configuring a UI component allows you to override its behaviour, position or even translations. We'll detail what configuration options are supported for every builtin UI Component.

For example, here's how a button would work in the configuration:

batchSDK(['setup', {
  ...
  ui: {
    button: {
      corner: 'bottom left',
      backgroundColor: '#FFFFFF',
      hover: 'Subscribe to our notifications!',
    }
  }
});

Alert

Alert screenshot

Requires Batch SDK 2.0.0

The alert format is similar to popups you can get using alert(). It is not actually modal: the user is still able to interact with the content around it.

It can show up in any of the four corners, or can be centered on the top or the bottom of the page.

To enable it, add a child object of ui named alert.

Supported parameters:

IdDescription
autoShowBoolean - Optional
Whether the component should show as soon as possible, or if it should wait for a manual 'show' API call. Default: true
E.g.{"autoShow":false}
attachString - Optional
Where to attach the alert. Should be a mix of top|bottom and left|center|right.
E.g.{"attach":"bottom left"}
iconURL String - Optional
Link to a square icon representing your website, which will show up on the left of the banner. The file must be a PNG or JPG image hosted on an HTTPS server.
E.g.{"icon":"https://mydomain.com/icon.png"}
textString - Optional
Overrides the text that's displayed in the banner.
E.g.{"text":"Never miss an update !"}
backgroundColorHex Color String - Optional
Color of the banner's background.
E.g.{"backgroundColor":"#646464"}
textColorHex Color String - Optional
Color of the banner's text.
E.g.{"textColor":"#646464"}
fontSizeInteger - Optional
Font size. Unitless.
E.g.{"fontSize":"12"}
fontFamilyString - Optional
Overrides the font used in the banner. Works exactly like CSS' font-family attribute.
E.g.{"fontFamily":"helvetica"}
btnBackgroundColorHex Color String - Optional
Color of the button's background.
E.g.{"btnBackgroundColor":"#646464"}
btnTextColorHex Color String - Optional
Color of the button's text.
E.g.{"btnTextColor":"#646464"}
btnHoverColorHex Color String - Optional
Color of the button's hover state.
E.g.{"btnHoverColor":"#646464"}
btnFontSizeInteger - Optional
Font size of both buttons in px. Do not add the unit to the value.
E.g.{"btnFontSize":"12"}
positiveSubBtnLabelString - Optional
Text override for when the positive button will subscribe the user.
E.g.{"positiveSubBtnLabel":"Subscribe"}
positiveUnsubBtnLabelString - Optional
Text override for when the positive button will unsubscribe the user.
E.g.{"positiveUnsubBtnLabel":"Unsubscribe"}
negativeBtnLabelString - Optional
Text override for when the negative button, which hides for popup temporarily, until the delay in `hideFor` has been reached.
E.g.{"negativeBtnLabel":"Later"}
positiveBtnStyleButton style configuration - Optional
Style configuration for the positive ("Subscribe"/"Unsubscribe") button. See below for more info about this object. Note: When in unsubcribe mode, this button will always have a red background color.
E.g.{"positiveBtnStyle":{"textColor":"red"}}
negativeBtnStyleButton style configuration - Optional
Style configuration for the negative ("Later") button. See below for more info about this object.
E.g.{"negativeBtnStyle":{"textColor":"red"}}
hideForInteger - Optional
When closed, do not display the banner again until X seconds elapsed (default: 604800 or 7 days). Use a 0 value to hide the alert forever.
E.g.{"hideFor":604800}
zIndexInteger - Optional
z-index of the component
E.g.{"zIndex":999}

Alert button style configuration

IdDescription
backgroundColorHex Color String - Optional
Color of the button's background.
E.g.{"backgroundColor":"#646464"}
hoverBackgroundColorHex Color String - Optional
Color of the button's background when hovered. Falls back on `backgroundColor` if not specified.
E.g.{"hoverBackgroundColor":"#646464"}
textColorHex Color String - Optional
Color of the banner's text.
E.g.{"textColor":"#646464"}
fontSizeInteger - Optional
Font size in px. Do not specify an unit in this value.
E.g.{"fontSize":"12"}
shadowBoolean - Optional
Whether this button should cast a shadow, or not. Default: true for the positive button, false for the negative one.
E.g.{"shadow":false}

Example:

alert: {
    positiveBtnStyle: {
        backgroundColor: "blue",
        textColor: "white",
        fontSize: 25,
        shadow: true
    }
}

Banner

Banner screenshot

The banner shows up at the top of your webpage. It has an optional logo, a colorable button, and can be floating or fixed.

To enable it, add a child object of ui named banner.

Supported parameters:

IdDescription
autoShowBoolean - Optional
Whether the component should show as soon as possible, or if it should wait for a manual 'show' API call. Default: true
E.g.{"autoShow":false}
iconURL String - Optional
Link to a square icon representing your website, which will show up on the left of the banner. The file must be a PNG or JPG image hosted on an HTTPS server.
E.g.{"icon":"https://mydomain.com/icon.png"}
textString - Optional
Overrides the text that's displayed in the banner.
E.g.{"text":"Never miss an update !"}
fixedBoolean - Optional
Makes the banner push the webpage's content rather than float on top of it (default: False).
E.g.{"fixed":true}
attachBottomBoolean - Optional
Makes the banner show on the bottom of the page, rather than on top. Forces 'fixed' to true (default: False).
E.g.{"attachBottom":true}
backgroundColorHex Color String - Optional
Color of the banner's background.
E.g.{"backgroundColor":"#646464"}
textColorHex Color String - Optional
Color of the banner's text.
E.g.{"textColor":"#646464"}
fontSizeInteger - Optional
Font size. Unitless.
E.g.{"fontSize":"12"}
fontFamilyString - Optional
Overrides the font used in the banner. Works exactly like CSS' font-family attribute.
E.g.{"fontFamily":"helvetica"}
btnBackgroundColorHex Color String - Optional
Color of the button's background.
E.g.{"btnBackgroundColor":"#646464"}
btnTextColorHex Color String - Optional
Color of the button's text.
E.g.{"btnTextColor":"#646464"}
btnHoverColorHex Color String - Optional
Color of the button's hover state.
E.g.{"btnHoverColor":"#646464"}
btnFontSizeInteger - Optional
Button's font size. Unitless.
E.g.{"btnFontSize":"12"}
btnWidthInteger - Optional
Button width. Unitless.
E.g.{"btnWidth":"200"}
btnSubString - Optional
Text override for when the button will subscribe the user.
E.g.{"btnSub":"Subscribe"}
btnUnsubString - Optional
Text override for when the button will unsubscribe the user.
E.g.{"btnUnsub":"Unsubscribe"}
hideForInteger - Optional
When closed, do not display the banner again until X seconds elapsed (default: 604800 or 7 days). Use a 0 value to hide the banner forever.
E.g.{"hideFor":604800}
zIndexInteger - Optional
z-index of the component
E.g.{"zIndex":999}

Button

Button screenshot

The Button UI Component shows a simple bell icon in the corner you want which, once clicked, show a pop-in with a customizable opt-in text, and a button to enable notifications.

To enable it, add a child object of ui named button.

Supported parameters:

IdDescription
autoShowBoolean - Optional
Whether the component should show as soon as possible, or if it should wait for a manual 'show' API call. Default: true
E.g.{"autoShow":false}
cornerString - Optional
Corner to display the button in. Should be a mix of top|bottom and left|right.
E.g.{"corner":"bottom left"}
hoverString - Optional
Override the text that appears when hovering the button.
E.g.{"hover":"Never miss an update !"}
backgroundColorHex Color String - Optional
Color of the button's background.
E.g.{"backgroundColor":"#646464"}
foregroundColorHex Color String - Optional
Color of the button's glyph.
E.g.{"foregroundColor":"#646464"}
hoverColorHex Color String - Optional
Color of the button's background on hover.
E.g.{"hoverColor":"#646464"}
hoverForegroundColorHex Color String - Optional
Color of the button's glyph on hover.
E.g.{"hoverForegroundColor":"#646464"}
popinObject - Optional
Overrides the popin's properties.
titleString - Override the pop-in's title.
E.g.{"title":"Subscribe to notifications"}
btnSubString - Overrides the pop-in subscribe button text.
E.g.{"title":"Subscribe"}
btnUnsubString - Overrides the pop-in unsubscribe button text.
E.g.{"title":"Unsubscribe"}
exampleObject - Example notification to display instead of the placeholder. See 'Theming' for more info.
E.g.{"example":{"body":"This is what a notification looks like"}}
zIndexInteger - Optional
z-index of the component
E.g.{"zIndex":999}

Theming

The button theme supports full color customization of the button itself, but not the popin. Just like any other component attribute, just override the wanted value in the configuration object.

Here's what colors you can change on the button, with their property names: Button screenshot

You can also customize the placeholder notification in the popin, by specifying a example object under popin:

IdDescription
iconImage URL String - Optional
URL of the image to display on the left of the example notification.
E.g.{"icon":"https://path/to/your/image.jpg"}
titleString - Required
Notification title text.
E.g.{"title":"Test title"}
bodyString - Required
Notification body text.
E.g.{"body":"Test body"}

Example:

button: {
    corner: 'bottom left',
    popin: {
        example: {
            icon: 'https://path/to/your/icon.jpg',
            title: 'Test title',
            body: 'Test body'
        }
    }
}

Toggling visibility programmatically

Starting with Batch SDK 2.0.0, you can programatically control the display of builtin UI components.

Two methods are available on the public API: ui.show, and ui.hide. They take as a parameter the name of a UI component that has been configured earlier, in the SDK setup:

batchSDK("ui.show", "alert");
batchSDK("ui.hide", "alert");
// or
batchSDK(api => { api.ui.show("alert") });
batchSDK(api => { api.ui.hide("alert") });

Note: Most components will be shown as soon as possible. In order to make them wait for your show call, please refer to the configuration of the UI component you're trying to tweak: look for the autoShow key.

Note that some UI components might chose not to display even if you tell them to. Reasons can be:

  • The user is already subscribed to notifications
  • The user dismissed the UI element, and the minimum time between two dismissal (controlled by the hideFor configuration key) has not been reached.

    In these cases, you can use the second "force" parameter, which allows you to force the display:

    batchSDK("ui.show", "alert", true)