Handy-Notification

A handy Google+ style notification which notifies you & transitions back to the bottom!! 🔔🔔🔔

Downloads
81
Stars
21

Handy-Notification

Google+ style notification which comes from the bottom to notify.

Demo

Quick links

  1. Screenshot
  2. Usage
  3. API
  4. Contribute

Screenshot

The above screenshot is from React-Instagram-clone-2.0

Usage

  1. First install the package with npm or Yarn.

    # with npm
    npm install handy-notification
    
    # or with Yarn
    yarn add handy-notification
    
  2. Create a div with class handy-notify.

    <div class='handy-notify'>
        <span></span>
    </div>
    
  3. And here comes the fun part.

    import Notify from 'handy-notification'
    Notify({
        value: "Hello, how are you?",   // Message to be displayed
        onClick: e => console.log('Clicked!!'),  // Function executed when clicked on the notification bar
        done: () => console.log('I notified you & went back to the bottom!')    // function to be executed when you're notified
    })
    

Example

npm run example

Run the above command and open http://localhost:7007

API

Notify(options:Object)
options = {
    beforeTop: String,
    afterTop: String,
    value: String,
    selector: jQueryElement,
    onClick: Function,
    done: Function
}

Contribute

Show your support by the project!!

Feel free to contribute!!

Thanks for reading!!

Package Rankings
Top 9.09% on Npmjs.org
Badges
Extracted from project README
npm version