@arturdoruch/process-noticer

ProcessNoticer

Displays message notices of pending processes (e.g. while sending ajax request). Displays process pending loader.

Install

yarn add @arturdoruch/process-noticer

Usage

import ProcessNoticer from '@arturdoruch/process-noticer';
import '@arturdoruch/process-noticer/styles/process-notice.css';

const processNoticer = new ProcessNoticer();

// Example of usage.
let notice = processNoticer.add('Sending ajax request', true);
processNoticer.display();

setTimeout(function () {
    processNoticer.remove(notice);
}, 3000);

Global options

Global options are the options used by every instance of the ProcessNoticer class. Set by calling function setOptions().

import { setOptions as processNoticerSetOptions } from '@arturdoruch/process-noticer';

processNoticerSetOptions({
    // Options 
});

• classNamePrefix string (default: ad-process-notice)

  The class name prefix for the list and loader elements.

• listTag string (default: ul)

• itemTag string (default: li)

• centerList boolean (default: false)

  Whether to center displayed process notice list.

Instance options

Instance options are the options applied for specific ProcessNoticer instance.

import ProcessNoticer from '@arturdoruch/process-noticer';

const processNoticer = new ProcessNoticer({
    // options
});

• listClassName string (default: null)

• loaderClassName string (default: null)

• centerList boolean (default: false)

  Whether to center displayed process notice list.