UNPKG

jquery.smartbanner

Version:

Smart Banners are a new feature in iOS 6 to promote apps on the App Store from a website. This jQuery plugin brings this feature to older iOS versions, Android devices and for Windows Store apps.

73 lines (63 loc) 3.88 kB
jQuery Smart Banner =================== [Smart Banners][1] are a new feature in iOS 6 to promote apps on the App Store from a website. This jQuery plugin brings this feature to older iOS versions, Android devices and for Windows Store apps. # _Low maintanace_ _jQuery Smart Banner is currently not being actively maintained. Issues will not be solved, but pull requests **might** be merged. If you like to collaborate or take over this project, please contact me at arnold@jasny.net._ ## Usage ## <html> <head> <title>YouTube</title> <meta name="author" content="Google, Inc."> <meta name="apple-itunes-app" content="app-id=544007664"> <meta name="google-play-app" content="app-id=com.google.android.youtube"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" href="jquery.smartbanner.css" type="text/css" media="screen"> <link rel="apple-touch-icon" href="apple-touch-icon.png"> </head> <body> ... <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8/jquery.min.js"></script> <script src="jquery.smartbanner.js"></script> <script type="text/javascript"> $(function() { $.smartbanner() } ) </script> </body> </html> ## Options ## $.smartbanner({ title: null, // What the title of the app should be in the banner (defaults to <title>) author: null, // What the author of the app should be in the banner (defaults to <meta name="author"> or hostname) price: 'FREE', // Price of the app appStoreLanguage: 'us', // Language code for App Store inAppStore: 'On the App Store', // Text of price for iOS inGooglePlay: 'In Google Play', // Text of price for Android inAmazonAppStore: 'In the Amazon Appstore', inWindowsStore: 'In the Windows Store', // Text of price for Windows GooglePlayParams: null, // Aditional parameters for the market icon: null, // The URL of the icon (defaults to <meta name="apple-touch-icon">) iconGloss: null, // Force gloss effect for iOS even for precomposed url: null, // The URL for the button. Keep null if you want the button to link to the app store. button: 'VIEW', // Text for the install button scale: 'auto', // Scale based on viewport size (set to 1 to disable) speedIn: 300, // Show animation speed of the banner speedOut: 400, // Close animation speed of the banner daysHidden: 15, // Duration to hide the banner after being closed (0 = always show banner) daysReminder: 90, // Duration to hide the banner after "VIEW" is clicked *separate from when the close button is clicked* (0 = always show banner) force: null, // Choose 'ios', 'android' or 'windows'. Don't do a browser check, just always show this banner hideOnInstall: true, // Hide the banner after "VIEW" is clicked. layer: false, // Display as overlay layer or slide down the page iOSUniversalApp: true, // If the iOS App is a universal app for both iPad and iPhone, display Smart Banner to iPad users, too. appendToSelector: 'body', //Append the banner to a specific selector onInstall: function() { // alert('Click install'); }, onClose: function() { // alert('Click close'); } }) ## Contributors [![Arnold Daniels](https://avatars3.githubusercontent.com/u/100821?v=2&s=64)](https://github.com/jasny) [![Thomas De Laet](https://avatars1.githubusercontent.com/u/5644283?v=2&s=64)](https://github.com/delaetthomas) [![John-David Dalton](https://avatars2.githubusercontent.com/u/4303?v=3&s=64)](https://github.com/jdalton) [1]: http://developer.apple.com/library/ios/#documentation/AppleApplications/Reference/SafariWebContent/PromotingAppswithAppBanners/PromotingAppswithAppBanners.html