README.md

@dwmt/loader

Loader is a simple library for easier and more reliable way to handle loading animations. You can easily define loaders globally and handle individual loaders inside front end components or backend signaling.

Table of Contents

• Install
• Usage
• API
• Contributing
• License

Install

npm i @dwmt/loader

Usage

You can define loaders inside a global singleton container and retrieve it from anywhere inside your application

const LC = require('@dwmt/loader')

const globalLoader = LC.registerLoader('globalLoader')
globalLoader.reset()

// API.js

const LC = require('@dwmt/loader')

const loader = LC.getLoader('globalLoader')

const workId = loader.work()

// API slow logic

loader.terminate(workId)

You can also initiate loaders manually withoud the container

const Loader = require('@dwmt/loader/lib/Loader')

const buttonLoader = new Loader()
buttonLoader.onActivation(() => {
  // show loader
})

buttonLoader.onTermination(() => {
  // hide loader
})

const workId = buttonLoader.work()

buttonLoader.terminate(workId)

API

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © dwmt.