Skip to content

saionaro/notefer

Repository files navigation

notefer npm version CI minzip license

The lightweight notifications system UI

DEMO

Getting started

Installation

First of all install the package:

NPM: npm install notefer

Yarn: yarn add notefer

Import and usage

Then you can import required things and send notifications

import { pushNotification } from "notefer";
import "notefer/lib/style.css";

pushNotification({
  title: "Direct Message",
  text: "Alex: How are you?",
});

Options

pushNotification(notification: Notification | Notification[]): void

interface Notification {
  title: string; // notification title
  text: string; // notification body

  lifetime?: number; // how long notification box should exist on the screen
  className?: string; // additional class name, applied to notif body
}