Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 5.05 KB

README.md

File metadata and controls

121 lines (83 loc) · 5.05 KB
Raw

BigCommerce Site Wide Banners

Provides a way to enable sitewide banners on your BigCommerce store theme.

Getting Started

These instructions will get you a new category called Sitewide Banners on your store and a test banner to show it's working.

Prerequisites

Nodejs v8+ (we assume you have installed something like nvm for changing Node versions).

Have a valid .stencil file as documented here.

Installing

npm install bigcommerce-sitewide-banners

You need to add grunt.loadNpmTasks('bigcommerce-sitewide-banners'); on your theme GruntFile.js.

On your terminal run grunt bigcommerce-sitewide-banners:init

Running this command we

  • create a template file
  • add a line on theme.scss to hide the sitewide banner Category (since BigCommerce adds this as a menu item)
  • add a line to .stencil file for local development
  • create Sitewide banner Category page using the BigCommerce API

Manual steps:

  • On global.js file you need to call the getBanner() function based on your preferences (please check the example a couple of sections below);
  • Bundle your theme and upload it into your store.
  • Apply the uploaded theme.
  • Go to Products > Product Categories and click on Sitewide banners Category.
  • On template file dropdown select sitewide-banners. Click Save & Exit.
  • On Marketing > Banners create (or edit) a banner and associate it to Sitewide banners.

You can follow the explanatory video where we show some settings for our package on the assets folder.

Some notes

Since we're creating a Category for sitewide banners BigCommerce places it as menu item. If you want to remove it from the DOM, you could add on global.js (or on your specific script) lines like these:

    const $siteWideMenu = document.querySelector(`.navPages-action[href="/sitewide-banners/"]`);
    if ($siteWideMenu) {
        $siteWideMenu.parentNode.removeChild($siteWideMenu);
    }

You can place the banner on top of any DOM element you want as long as it's an element present on the page. You can do it passing a CSS selector to getBanner() on global.js, an example can be getBanner('header.header') (where top banners are placed). If nothing is passed, banners are placed by default on header (for top banners) or the footer (for bottom ones).

Example

Say, we have three banners applied into our Sitewide Banners Category on our store:

;

and we want to apply these on all pages, one at the top, one at the bottom and one above the title (if it exists). This is how we applied it on global.js (we omitted all non-to our example code).

import SiteWideBanner from 'bigcommerce-sitewide-banners';

export default class Global extends PageManager {
    onReady() {
        cartPreview(this.context.secureBaseUrl, this.context.cartId);
        quickSearch();
        currencySelector();
        foundation($(document));
        quickView(this.context);
        carousel();
        menu();
        mobileMenuToggle();
        privacyCookieNotification();
        maintenanceMode(this.context.maintenanceMode);
        loadingProgressBar();
        svgInjector();
        objectFitImages();

        const swb = new SiteWideBanner();
        swb.getBanners()
            .then(banners => {
                // On dashboard selected as Top of page
                swb.addBanners({ banners: [banners.top[0]] });

                // On dashboard selected as Top of page
                swb.addBanners({ place: 'bottom', banners: [banners.top[1]] });

                // On dashboard selected as Bottom of page
                swb.addBanners({ place: '.page-heading', banners: [banners.bottom[0]] });
            })
            .catch(error => console.error(error));
    }
}

You need to check the order of the banners (BigCommerce put the latest created on index 0 in this case).

You see we pass arrays for the banners property. You can use more than one banner at the same time at the same place.

If nothing is passed as the argument, top banners are assumed. If no top banners, we check for bottom ones.

This is how it looks on our demo page:

You need to call addBanners every time a banner is needed on another location

You also need to better handling for the catch part but it's good enough for our example.

Notes

  • Since BigCommerce doesn't transpile external package code (for oldies like IE11), we provide transpiled files inside dist/ folder. You can access these files adding an alias on your webpack.conf.js (or webpack.common.js) file like 'bigcommerce-sitewide-banners': path.resolve(__dirname, 'node_modules/bigcommerce-sitewide-banners/dist/sitewide-banners.min.js')

Authors

  • Carson Reinke
  • Hector Fernando Hurtado

License

This project is licensed under the MIT License - see the LICENSE file for details

alt text