Available parameters


Define custom options with the following script:

Below you will find all available parameters.

Variable Default Type Description
timer 0 integer Set time to auto unlock content. “0” don’t add this options.
closeButton false boolean Enable/Disable button to close mask.
buttons [] array, string An array of buttons to create. The order indicates the order of created buttons. Available value: “facebook_like”, “facebook_share”, “twitter_tweet”, “twitter_follow”, “google_plus1”, “google_share”
theme ” “ string Plugin style. Available value: ” ” – (empty string), “blueSky”, “material”, “hipster”, “lollipop”, “slick”, “image”
customClass “” string Add custom class name to main container.
fullPage false boolean Enable/Disable full page type popup.
beforeInit false function Function invoke before plugin init.
beforeCreateMask false function Function invoke before create mask.
afterCreateMask false function Function invoke after create mask.
afterRemoveMask false function Function invoke after remove mask.
afterAddContent false function Function invoke after add content.
afterFBLikeClick false function Function invoke after click facebook like button.
afterFBShareClick false function Function invoke after click facebook share button.
afterTwitterTweetClick false function Function invoke after click twitter tweet button.
afterTwitterFollowClick false function Function invoke after click twitter follow button.
afterGooglePlusOneClick false function Function invoke after click google +1 button.
afterGooglePlusShareClick false function Function invoke after click google share button.

texts:

Variable Default Type Description
maskHeader “Simple test heading” string Mask header text.
maskText “Simple paragraph text” string Mask paragraph text.
timerWaitText “or wait” string Text before timer if timer exist.
timerSecText “sec” string “Second” text after timer if timer exist.
closeCharacter “×” string “Close button” value.

Facebook:

Variable Default Type Description
appId “0” string Facebook application ID important for facebook share button, but optional for like button. You can create your own app
here
lang “en_US” string Language of the button labels. More info here

likeButton

Variable Default Type Description
url “” string Link to like.
colorscheme “light” string Button scheme color. Available value: “light”, “dark”.
width “auto” string Width button container.
action “like” string Verb to display. Available value: “like”, “recommend”.
ref “” string Label for tracking referrals.
layout “button_count” string Button layout. Available value: “standard”, “box_count”, “button_count”, “button”.

shareButton:

Variable Default Type Description
url “” string Link to share.
width “auto” string Width button container.
layout “button_count” string Button layout. Available value: “box_count”, “button_count”, “button”, “icon_link”, “icon”, “link”.
name “” string Name of the product or content you want to share.
picture “” string Path to an image you would like to share with this content.
caption “” string Caption.
description “” string Description of your product or content.

twitter:

Variable Default Type Description
lang “en” string Language of the button labels. More info here.

tweetButton:

Variable Default Type Description
url “” string Tweet url.
message “” string Default message in tweet.
hashtags “” string Hash tags separated by comma. Example: “hash1, hash2, hash3”.
related “” string Related accounts.
count “horizontal” string Count position. Available value: “none”, “horizontal”, “vertical”.
size “default” string Button size. Available value: “default”, “large”.

followButton:

Variable Default Type Description
username “” string Twitter username.
showScreenName “false” string Enable/disable username inside button.
size “default” string Button size. Available value: “default”, “large”.

googlePlus:

Variable Default Type Description
lang “en-US” string Language of the button labels. More info here

plusOneButton:

Variable Default Type Description
url “” string Link to like
size “medium” string Button size. Available value: “small”, “medium”, “standard”, “tall”.
annotation “bubble” string Annotation to display. Available value: “none”, “bubble”, “inline”.
width “auto” string Button container width. Not available with “bubble” annotation
align “left” string Button horizontal align. Available value: “left”, “right”.
expandTo “” string Hover and confirmation bubbles display position; separated by comma list of: top, right, bottom, left.

shareButton:

Variable Default Type Description
url “” string Link to share
annotation “bubble” string Annotation to display. Available value: “none”, “bubble”, “inline”, “vertical-bubble”.
width “auto” string Button container width.
height “20” string Button height.
align “left” string Button horizontal align. Available value: “left”, “right”.
expandTo “” string Hover and confirmation bubbles display position; separated by comma list of: top, right, bottom, left.