Component Options

The Zappar embed component can be customized with the options outlined below.

Option	Type	Description
hostAppData	string	An arbitrary string set by the application and passed into the embed.
launchDeepLink	string	Sets a ZapWorks experience to launch directly into. For more information see the Deep Links article.
showFullScreen	boolean	Sets whether the component will be started in fullscreen.
suppressAnimation	boolean	Sets if all animations will be suppressed.
barColor	string	Sets the bar color with a hex value.
showHistoryButton	boolean	Sets whether the History button is shown.
showFavoriteButton	boolean	Sets whether the Favorites button is shown.
showPhotoButton	boolean	Sets whether the Photo button is shown.
showGifButton	boolean	Sets whether the Gif button is shown.
showAgeGate	boolean	Sets whether the age gate message is shown.
showARWarning	boolean	Sets whether the AR warning is shown (Android only).
onMessage	string	Sets a custom variable message.
forceLandscape	boolean	Sets whether to force the device to display in landscape mode.

The parameters above can be passed with key-value pairs.

Example:

onDeviceReady: function() {
    this.receivedEvent('deviceready');
    var zapparButton = document.getElementById("zapparbutton");

    zapparButton.addEventListener('click', function() {
        window.launchZappar(
        // launch options can be set/included here
        {
            // example params :
            // onMessage : gotMsg,
            // barColor : "#334455"
        });
    });