GithubHelp home page GithubHelp logo

isabella232 / choo-notification Goto Github PK

View Code? Open in Web Editor NEW

This project forked from choojs/choo-notification

0.0 0.0 0.0 88 KB

Web Notification plugin for Choo

Home Page: https://notification.choo.io/

License: Apache License 2.0

JavaScript 100.00%

choo-notification's Introduction

choo-notification

npm version build status downloads js-standard-style

Web Notification plugin for Choo.

Note: be careful when using notifications. Overuse, or even asking for permissions unexpectedly can provide people with a bad experience. Make sure people know why you're asking for permission to send notifications. Use this API responsibly.

Usage

var html = require('choo/html')
var choo = require('choo')

var app = choo()
app.use(require('choo-devtools')())
app.use(require('./')())

app.route('/', (state, emit) => {
  return html`
    <body>
      <button onclick=${enable} disabled=${state.notification.permission}>
        ${state.notification.permission
          ? 'Notifications are enabled'
          : 'Enable notifications'}
      </button>

      <button onclick=${notify}>
        Clicky
      </button>
    </body>
  `

  function enable () {
    emit('notification:request')
  }

  function notify () {
    if (state.notification.permission) {
      emit('notification:new', 'clicky!')
    }
  }
})

app.mount('body')

Events

'notification:request' | state.events.NOTIFICATION_REQUEST

Request to use the notifications API. Emits either 'notification:granted' or 'notification:denied' after calling it. Also emits a 'render' event after the permission state changes.

'notification:granted' | state.events.NOTIFICATION_GRANTED

Emitted after calling 'notification:request'.

'notification:denied' | state.events.NOTIFICATION_DENIED

Emitted after calling 'notification:request'.

'notification:new' | state.events.NOTIFICATION_NEW

Emit a new notification. Make sure you have access to send notifications before.

API

notificationPlugin = chooNotification()

Create a new choo-notification instance.

Installation

$ npm install choo-notification

Further Reading

License

Apache-2.0

choo-notification's People

Contributors

yoshuawuyts avatar goto-bus-stop 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.