openfin-notifications
TypeScript icon, indicating that this package has built-in type declarations

2.3.2 • Public • Published

OpenFin Notification Center

This library is deprecated. We will stop publishing updates to it after July 2024. Use @openfin/workspace/notifications instead.

Overview

The OpenFin Notification Center provides developers with a uniform way to create, display and organize desktop notifications as well as responding to notification events.

Notifications will be displayed as toasts as well as being listed and organized in a Notification Center. The Notification Center can be accessed by clicking on the Notifications icon in the system tray.

This project consist of 3 parts:

  1. The Notification Center, displaying and managing notifications
  2. The Notification Center Client Library, exposing APIs for applications to create and manage notifications
  3. The Notification Studio, A visual editor for user notifications.

Features

  • Create notifications.
  • Clear and dismiss notifications.
  • Attach handlers for when notifications are created, closed, and interacted with.
  • Attach indicators and buttons with actions to notifications.
  • Persist notifications in the Notification Center.
  • Persist notification toasts.
  • Create expiring and/or future notifications.
  • Search notifications in the Notification Center.
  • Create notifications with markdown, form, premade or custom templated notification content.
  • Create grouping streams for notifications.
  • Create pop-out frame windows for individiual notification senders and streams.
  • Customize to specify the Notification Center and notification toast corners on screen.
  • Customize Notification Center theme via Workspace Platforms.

Getting Started

Integrating the Notification Center within an application is done by importing the Client API.

Import the Client API

npm install openfin-notifications

The client library is also available as a resource which can be included via <script> tag:

<script src="https://cdn.openfin.co/services/openfin/notifications/<VERSION>/openfin-notifications.js"></script>

This will expose the global variable notifications with the API methods documented in the link below. Example:

const notes = await notifications.getAll();

The client module exports a set of functions, documented in the API docs.

Usage

Documentation is available here.

Readme

Keywords

none

Package Sidebar

Install

npm i openfin-notifications

Weekly Downloads

5,272

Version

2.3.2

License

SEE LICENSE IN LICENSE.MD

Unpacked Size

151 kB

Total Files

34

Last publish

Collaborators

  • marek_openfin
  • yoge-openfin
  • nil.ffej
  • gilesstevenson-openfin
  • eheyder
  • newaz.sharif
  • efraim-herstic
  • royhafin
  • openfincolinhu
  • openfin-johans
  • alan15008
  • openfin-ci-gh
  • hina-khalid
  • ife-dev1
  • mjosling
  • elliott.burr
  • vsaw3
  • aykochubey
  • gallak-openfin
  • galim.kaudinov
  • dewinner
  • hzhi0209
  • andy.westacott
  • __tomasz__
  • cameronopenfin
  • jennrondeau
  • dhilan
  • benstubbington
  • davidcoxon-of
  • openfin-jeff
  • gouthamc
  • hannahmcmillen
  • xyopenfin
  • smocarski
  • eugeneross-openfin
  • imansuri
  • manamiueda
  • sakibahmad
  • shahossain
  • openfinbrandon
  • pierrebaize
  • noyangunday
  • michaelmcoates
  • johnmandia-openfin
  • rdepena
  • tgoc99
  • wenjunche
  • harsimran.openfin.singh
  • luiemilio
  • licui3936
  • connormccafferty
  • adam.saland
  • openfin-ci
  • chrishobsonexpero
  • richbrowne-openfin
  • azizyok
  • openfin-gavin
  • oblarg