Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.75 KB

options.rst

File metadata and controls

31 lines (25 loc) · 1.75 KB

Plugin configuration options

Options

Property Type Example Required Default Purpose
allowHtml boolean true No false Enable HTML markup in descriptions
debug boolean true No false Enable logs in console
shareBox boolean false No true Enable social media share
socialMedia object See SocialMedia object No -- Social media configuration
triggerEvent string "click|hover" No 'hover' Mouse event to trigger the display of an item

SocialMedia

Property Type Example Required Default Purpose
url string "http://www.example.com" No Document URL URL to share
text string "Text" No Page title Text
hashtags array ["jQuery", "cloudedLeopard"] No -- Hashtags
twitterUsername string "my_twitter_account" No -- Twitter account
You do not need to prefix your Twitter account by @.