Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including propel-web-push with all npm packages installed. Try it out:

propel-web-push lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("propel-web-push/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

propel-web-push v0.1.3

A library to support developers implementing Web Push notifications

Propel

Build Status Dependency Status devDependency Status

A library to support developers implementing Web Push notifications

Getting Started

To use the Propel library do the following:

  1. Install Propel with npm install --save propel-web-push

  2. Add propel-client.js to your web page

    <script src="/node_modules/propel-web-push/dist/propel-client.js"></script>
    
  3. Add a web app manifest to your page. It's required by Chrome.

    <link rel="manifest" href="manifest.json">
    
  4. Use PropelClient in your JavaScript.

    var PropelClient = window.goog.propel.PropelClient;
    
    // Check if push is supported by the current browsers
    if (PropelClient.isSupported()) {
      // Initialise Push Client
      var propelClient = new PropelClient('/sw.js');
      propelClient.addEventListener('statuschange', function(event) {
        if (event.permissionStatus === 'denied') {
          // Disable UI
        } else if (event.currentSubscription) {
          // Enable UI
          // Show that user is subscribed
    
          // Send the subscription object to your server
          fetch('/your-backend-api', {
            method: 'post',
            headers: new Headers().append('Content-Type', 'application/json'),
            body: JSON.stringify(event.currentSubscription)
          });
        } else {
          // Enable UI
          // Show that user is not subscribed
        }
      });
    
      propelClient.subscribe();
      // OR
      propelClient.unsubscribe();
    }
    
  5. Check out the docs to learn more.

Support

If you’ve found an error in this library, please file an issue: https://github.com/GoogleChrome/Propel/issues

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub.

License

Copyright 2015 Google, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free