Code Monkey home page Code Monkey logo

apprise's Introduction

apprise experimental

A simple browser module for displaying stacking notifications.

This module makes as few assumptions about styling as possible, and simply handles stacking notifications fixed to the screen – you'll even have to remove the elements yourself when they're done. None the less, this should simplify the implementation for you while still providing you plenty of design flexibility.

apprise

Usage

NPM

notify = apprise(options)

Returns a notify function that you can use to create new notifications.

Accepts the following options:

  • top: boolean – set to true to align the notifications with the top of the screen.
  • left: boolean – set to true to align the notifications with the left of the screen.
  • bottom: convenience option – opposite of top.
  • right: convenience option – opposite of left.

div = notify([timeout])

Create a new notification. You're handed back a DOM element which will be attached to a fixed element shared with the other notifications.

Optionally, you can pass a timeout value in milliseconds to automatically remove the notification.

notify.on('enter', enter(node, close))

Triggered when a new notification is created. Use this for adding common content/functionality to notifications.

The node passed to the event is that notification's <div> element.

close is a function which will trigger the exit event on the notification, in case you opted not to use a timeout or would like to remove it early.

notify.on('exit', exit(node))

Triggered when a notification is removed. Use this to remove notifications from the DOM. The node passed to the event is that notification's <div> element.

License

MIT. See LICENSE.md for details.

apprise's People

Contributors

hughsk avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.