obstacl v1.0.0

obstacl

A simple multipurpose loading/loader plugin for any frontend project. Works in any typescript and javascript project.

This plugin makes it easy to create and use loading buttons and api content loaders, etc in different contexts.

Installation

npm install obstacl --save

Usage

Import the module

import { Obstacl } from 'obstacl'

Below are the MainOptions that can currently be passed directly to the plugin's "create" method

/* syntax */
Obstacl.create(element/*  HTMLElement | string */, options /* MainOptions = {} */)
Obstacl.destroy(element/*  HTMLElement | string */)

/* Types */
MainOptions {
    action?: Function | void /* This is the default action to perform when the obstacl is created
     NOTE: Do not call the function passed as action. Otherwise the function will be executed immediately. */
    onClick?: Function  /* You can also add a click event to the obstacl to make users perform an action if they click on the obstacl after its created. */
    timer?: number /* If you want the obstacl to be automatically destroyed at a specific time. Note: should be in miliseconds e.g: 5000 = 5sec */
    showCountdown?: boolean /* Displays the countdown timer on the element. only works if timer is set */
    text?: string /* Custom text to show on the overlay if needed. Defaults to "Wait..." */
    icon?: string /* Custom icon to show on the overlay if needed. You have to use your prefered icons class used in project as string */
    font?: number /* Custom font-size for the inner texts. Defaults to "16"*/
    animate?: boolean /* Whether to animate the icon if con is provided. defaults to true ( 360deg spin animation) */


    injectHTML?: string /* You can decide not to use any of the other options above and insert your own code */
    useOverlay?: boolean /* If injecting your own code, you may decide not to use default overlay */
}

It has diverse applications, but some common use scenarios are shown below.

import { Obstacl } from 'obstacl'
import '/node_modules/obstacl/dist/obstacl.min.css' /* Or use it from cdn link 
 unpkg.com/obstacl/dist/obstacl.min.css */

// block login button until api response
const sendBtn = document.querySelector('#sendBtn')
/* activates when button is clicked */
        Obstacl.create(sendBtn, {
			icon: 'icon-spin6',
			text: 'Please wait',
            action: function () {
                $Auth.login({
                    email: this.email
                    password: this.password,
                }).then(done => {
                    Obstacl.destroy(sendBtn)
                })
            }
		})
				
// disable element and re-enable after a countdown timer
            Obstacl.create('#button', {
				action: function () { 
					// some default actions to perform
				},
				onClick: function () { 
					// what happens if user click element while obstacl is active
					// some actions to perform 
				},
				text: 'Please wait',
				timer: 10000,
				showCountdown: true,
				font: 30
			})


// inject a prefered custom element instead of default options
const customHtml = `
	<div class="LoadingClass custom-overlay custom-loading-icon m-auto">
		// some more innerHtml
	</div>
`
			window.onload = function {
				Obstacl.create('#main-page .wholePageLoading', {
					injectHTML: customHtml,
					useOverlay: false,
					action: function () { 
						// some default actions to perform
						fetch('api-stuffs-link').then(()=>{
							//
							Obstacl.destroy(...)
						})
					},
				})
			}

// more diverse use cases ...

disclaimer

Please note that no guarantee is granted with the use of this code.