npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-push-notifiy

v1.0.35

Published

React push notifications

Downloads

12

Readme

react-push-notifiy is based on react-push-notification that includes bug fixes and improvements to address issues that are not being maintained by the original package!

NOTE: this package is actively maintained and I will continue to address any issues or bugs that arise and users are welcomed to report issues or contribute to the project

Easy, Type safe & Lightweight push notification library for React.js. Writtin in TypeScript & compiled to JavaScript for robust code.

In app notification system, as well as web native Notification support.

Install

yarn add react-push-notifiy

or

npm i react-push-notifiy

Sneakpeak

In app notification example. Regular React components.

Web native notification exmaple. Web native components. Send push notifications outside of the browser while the browser is in running in the background or just idle.

Mac OSX example:

Set-up

Add the Notifications component to the top of your React.js project. This is probably index.js or app.js. When using native: true, this step is not required.

import { Notifications } from 'react-push-notifiy';

const App = () => {
    return (
      <div className="app">
        // Top of DOM tree
        <Notifications />
        <div className="row">
          <div className="content">
           Hello world.
          </div>
        </div>
      </div>
    );
  }
};

export default App;

Usage

import the addNotification function and call it.

import addNotification from 'react-push-notifiy';

const Page = () => {

    const buttonClick = () => {
        addNotification({
            title: 'Warning',
            subtitle: 'This is a subtitle',
            message: 'This is a very long message',
            theme: 'darkblue',
            native: true // when using native, your OS will handle theming.
        });
    };

    return (
      <div className="page">
          <button onClick={buttonClick} className="button">
           Hello world.
          </button>
      </div>
    );
  }
};

export default Page;

Props

| Property | Description | | ---------------------------------- | ------------------------------------------------------------------ | | position string | One of top-left, top-middle, top-right, bottom-left, bottom-middle, bottom-right. Default: top-left |

addNotification({Options}) argument properties

The addNaddNotification() function has the following function type:


const options = {
    title: 'title',
    subtitle: 'subtitle', //optional
    message: 'message', //optional
    onClick: (e: Event | Notification) => void, //optional, onClick callback.
    theme: 'red', //optional, default: undefined
    duration: 3000, //optional, default: 5000,
    backgroundTop: 'green', //optional, background color of top container.
    backgroundBottom: 'darkgreen', //optional, background color of bottom container.
    colorTop: 'green', //optional, font color of top container.
    colorBottom: 'darkgreen', //optional, font color of bottom container.
    closeButton: 'Go away', //optional, text or html/jsx element for close text. Default: Close,
    native?: boolean, //optional, makes the push notification a native OS notification
    icon?: string, // optional, Native only. Sets an icon for the notification.
    vibrate?: number | number[], // optional, Native only. Sets a vibration for the notification.
    silent?: boolean // optional, Native only. Makes the notification silent.

};

const addNotification: (options: Options) => void;

The addNotification() function takes an object as argument with the follow properties:

| Property | Description | | ---------------------------------- | ------------------------------------------------------------------ | | title string | Required. Title of the push notification | | subtitle string | Optional. Subtitle of the push notification | | message string | Optional. Message of the push notification | | onClick (e: Event OR Notification) => void | Optional. onClick callback of push notification. When native: true e will be of type Notification. Else e will be of type Event. | | theme string | Optional. One of darkblue, red, light, undefined. Default: undefined | | duration number | Optional. Duration of the push notification in ms. Default: 3000 | | backgroundTop string | Optional. background color of top container. | | backgroundBottom string | Optional. background color of bottom container. | | colorTop string | Optional. font color of top container. | | colorBottom string | Optional. font color of bottom container. | | closeButton string | Optional. text or html/jsx element for close text. Default: Close | | native boolean | Optional. Turns the notification into a native web notification using serviceWorker. Default: false| | iconstring | Optional. Native only. Shows an icon in the notification. | | vibratenumber|number[] | Optional. Native only. Makes the notification vibrate. | | silentboolean` | Optional. Native only. Makes the notification silent. |

The custom background or font colors will always override a chosen theme.