Git Product home page Git Product logo

app-banner's Introduction

Ombori App Banner

The lightweight mobile application banner for your website

Preview

Mobile

Easy to use, free, open-source configurable application banner for your website.

How does it work?

When a customer visits your site, Desktop users are sent an SMS with a link to download your app. Mobile users are automatically directed to the appropriate app store.

After a user has seen the app install banner, it won’t reappear. This ensures that the UX of your site is not degraded in any way.

Usage

External script

Just include this snippet in your website main page.

<script>
  (function () {
    var appleId = 'id1234567890';
    var googleId = 'com.yourcompany.yourapp';
    var placement = 'bottom-left';
    var s = document.createElement('script');
    s.type = 'text/javascript';
    s.async = true;
    s.id = 'TheAppBanner';
    s.src = 'https://bruce.presencekit.com/p/main.js?&p=' + placement + '&apple=' + appleId + '&google=' + googleId;
    var x = document.getElementsByTagName('script')[0];
    x.parentNode.insertBefore(s, x);
  })();
</script>

Npm package

Alternatively you can use the App Banner via npm package

npm install --save app-banner
var appBanner = require('app-banner');
// - or -
import appBanner from 'app-banner';

appBanner.init({
  apple: 'id1234567890',
  google: 'com.youcompany.yourapp',
  placement: 'bottom-left',
})

React component

Also you can use the App Banner as a React component

npm install --save app-banner
import AppBanner from 'app-banner/src';

...
<div>
  <AppBanner google="com.youcompany.yourapp" apple="id1234567890" position="bottom-left" />
</div>

Parameters

  • apple or a - App Store ID of your application
  • google or g - Google Play ID of your application
  • placement or p - Banner position on screen. Possible values are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'. Default value is 'bottom-right'. Only applies to desktop version of banner.
  • minimize or m - Banner behaviour when user dismisses the banner. When minimized, the banner will display smaller version of itself instead of completly dissapear. Possible values are 'yes', 'no' and 'mobile'. When 'mobile' is specified, the banner will be minimized if shown on mobile device and completely dissapear on desktop. Default value is 'no'.
  • noTrack or n - Do not track usage statistics. false by default.

Note: shorthand parameters like a, g or p are only supported in script URL when App Banner is used via external script.

app-banner's People

Contributors

gu5taf avatar hassellof avatar kvasdopil avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.