@easy-smart-app-banner/core v2.0.0

Easy Smart App Banner

An Easy Smart App Banner for promoting mobile app installs based on the Safari Apple Experience.

This isn't for everyone. Most people should probably prefer the PWA approach. However, if you need a 'simple' banner that redirects to a native mobile app then keep reading.

For specific details on iOS and Safari specifically, read here and for Android see here.

Features

• Typescript support
• Standalone/Frameworkless
• Small! 16.74 kB │ gzip: 4.83 kB │ map: 55.62 kB
• Platform specific
  • custom banner for iOS (non-Safari) and Android user agents
  • Safari specific config
• Option, use SCSS/Sass variables to configure the banner as needed
• Cookie-based dismissal, dismiss once per browser

Install

npm i -S @easy-smart-app-banner/core

Configuration

See here

Advanced Usage

Platform Specific Overrides

Several options have platform specific overrides. These take precedence over any equivalent option when running on the relevant platform.

For specific details on iOS and Safari specifically, read here. For Android see here.

Icon

A single icon is typical, but specific ones can be configured.

{
    icon: '/assets/my-icon.jpeg',
    androidIcon: null,
    appleIcon: null,
}

Price

The price tagline defaults to FREE with platform specific defaults for both Android and iOS platforms.

{
    price: 'FREE',
    androidPrice: 'FREE - On the Google Play Store',
    applePrice: 'GET - On the App Store'
}

Call to Action Button Label

{
    buttonLabel: 'View',
    androidButtonLabel: null,
    appleButtonLabel: null
}

SCSS/Sass Variables

Styles can be overriden using the provided SCSS/Sass variables. See here.

You can provide these styles as needed by using the .scss files instead,

@use 'smart-app-banner/dist/variables' as *;

// overwrite as needed
$background-color: #000;

Platform Specific Plugins

Looking for a platform that isn't here? Propose a PR to add it!

• Vue 3 Plugin

Development

To get started, pull the repo and run a build as well as the tests.

don't forget to run npm i!

npm run build
npm run test

You can checkout the rest of the commands in the package.json.

The next step would be to boot a demo project. Checkout the Vue demo here.

Publish a Release

1. Checkout a new branch release/major.minor.patch
2. Create the new version using npm version major|minor|patch
3. Update any docs as needed
4. Publish the branch

Having merged the PR for that branch... Generate a release with a matching tag for the newly created version.

Licence

MIT License © 2025-PRESENT Albert Ferguson