Easy Smart App Banner - Vue Plugin

A Vue Plugin for Smart App Banner.

Install

npm i -S @easy-smart-app-banner/vue-plugin

Usage

// main.ts
import './assets/main.css';

import { createApp } from 'vue';
import App from './App.vue';
import createSmartAppBanner, {
    type SmartBannerOptions,
} from '@easy-smart-app-banner/vue-plugin';
import '@easy-smart-app-banner/vue-plugin/style.css';
// or SCSS if you prefer
// import '@easy-smart-app-banner/vue-plugin/style.scss';

createApp(App)
    .use(createSmartAppBanner, {
        title: 'Hello world!',
        author: 'Albert Ferguson',
        // using the create-vue asset logo (any image is valid!)
        icon: '/src/assets/logo.svg',
        // optionally enable verbose logging - this is disabled by default
        verbose: true,
        googlePlayStoreUrl: 'https://play-store-application-url',
        appStoreUrl: 'https://app-store-application-url',
    } as SmartBannerOptions)
    .mount('#app');

// App.vue
<script setup lang="ts">
import { useSmartAppBanner } from '@easy-smart-app-banner/vue-plugin';

const smartAppBanner = useSmartAppBanner();

try {
    // mount the component
    smartAppBanner.mount();
} catch (error) {
    // catch any errors gracefully if there's any config or platform issues
    console.error(error);
}
</script>

For more on configuration, see the Smart App Banner repository.

Development

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

don't forget to run npm i!

npm run build

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

The next step would be to boot up the dependent project, as you're probably looking to edit it too. See here.

Publish a Release

1. Checkout a new branch release/vue-plugin-major.minor.patch
2. update the core package dependency (if needed) and run npm i
3. execute npm run build
4. Update any docs as needed
5. Create the new version using npm version major|minor|patch
6. Publish, review, and merge the branch
7. Publish the latest plugin package to NPM using npm publish --access public
8. Validate the install and version by bumping the vue-demo project

Done! 🎈

Licence

MIT License © 2025-PRESENT Albert Ferguson