Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.28 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.28 KB
Raw

BigCommerce Loading Overlay Module

Scope an overlay to a specific area, or cover the whole page (for use while waiting on API response).

Installation

NPM:

npm install --save github:pixelunion/bc-loading

Usage

import $ from 'jquery';
import Loading from 'bc-loading';

const loadingOptions = {
  loadingMarkup: '<div class="loading"><span class="loading-spinner"></span></div>',
  visibleClass: 'visible',
  scrollLockClass: 'scroll-locked',
};

const cartTotalsOverlay = new Loading(loadingOptions, false, '[data-cart-totals]');

const shippingCalculator = new ShippingCalculator({
  willUpdate: () => cartTotalsOverlay.show(),
  didUpdate: () => cartTotalsOverlay.hide(),
});

Options

Instantiate with: new Loading(options, scrollLock, scope);

loadingMarkup: Simple markup comprsing your loading overlay.

visibleClass: Class to be applied to show overlay (e.g, 'visible').

scrollLockClass Class to be applied to stop the body from scrolling (e.g, 'scroll-locked').

scrollLock Pass a boolean value into each instance of the loading overlay to dictate whether or not the scroll lock should be used.

scope Pass an element selector into each instance of the loading overlay to scope the overlay to a particular area (defaults to 'body').