@incendiarybean/notify-framework NPM

Notify Framework

Notify-Framework is an extremely lightweight NPM module for creating pop-up notifications.

This module uses TailwindCSS and Animate.css and must be installed alongside it.

Installation

Use NPM to install it and the other 2 requirements with the below command:

npm install @incendiarybean/notify-framework tailwindcss animate.css --save

Usage

Import the module:

import { Notify } from '@incendiarybean/notify-framework';

Try the Demo

Making a large popup notification with buttons:

let content = {
    title:"This is a title",
    body: "This is the body",
    colour: "blue",
    options: ["Dismiss"]
};

Notify(content, "max");

The max popup can be moved around the screen using the draggable feature of the module, though you may need to tweak your Tailwind config to allow active/grab cursor like below:

module.exports = {
    theme: { 
        extend:{
            cursor: {
                grabbing: 'grabbing',
                grab: 'grab'
            },
        }
    },
    variants: {
        cursor: ['responsive', 'hover', 'focus', 'active'],
    },
}

You can also customise the buttons that appear on the notification through a JS file, it will check the root directory for a notify.config.js file (or default to the predefined one). If you don't need to add any functions, you can avoid the func property and leave the file as notify.config.json. The JS file looks like this:

module.exports = {
    "actions":{
        "Dismiss": {
            "options": ["Dismiss", "No", "Cancel"],
            "func": function(){
                    console.log("Do custom function!");
                },
            "close": true,
            "resolve": true,
            "reload": false,
            "returnComment":{
                "ACTION":"Dismissed"
            },
            "colour": "red"
        },
    }
}

This is where you define what the button does, in options you can see the different variants of a dismiss button.

This dismiss button will close the window, resolve the promise, won't reload the page and the returned resolution of the promise is "ACTION": "Dismissed". The button is also red.

If you want to run a custom function along side one of these buttons, you would need to use the property 'func', when clicking the button - this function would then run.

Making a small slide from the side notification:

let content = {
    title:"This is a title",
    body: "This is the body",
    colour: "blue",
    position: ["top", "left"]
};

Notify(content, "min");

You can tell the notification where to position by using the position attribute, you don't have to supply either/or attributes but it will default to bottom left.