Sunbird

@project-sunbird/sb-notification

@project-sunbird/sb-notification is a lightweight and very complete Angular library for notifications module in Sunbird.

Getting started

How to use @project-sunbird/sb-notification in your projects

Using library locally

1. Build library

npm run build

2. Link library to your project

npm link @project-sunbird/sb-notification

Table of contents

• Installation
• Import in Angular
• Options
• Versions

Installation

$ npm i @project-sunbird/sb-notification

Import in Angular

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { SbNotificationModule } from '@project-sunbird/sb-notification';

import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    SbNotificationModule
  ],
  providers: [ ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

<sb-notification tabindex="0" [notificationList]="notificationList" [inAppNotificationConfig]="inAppNotificationConfig" (showMore)="handleShowMore($event)" (showLess)="handleShowLess($event)"></sb-notification>

Options

• notificationList: Array of notification objects.

• inAppNotificationConfig: Object of in-app notification configuration.

    title: string;
    subTitle: string;
    clearText: string;
    moreText: string;
    lessText: string;
    minNotificationViewCount: number;

• (showMore): Event emitted when user clicks on "Show more"

• (showLess): Event emitted when user clicks on "Show less"

Versions

| release branch | npm package version | Angular Version | |:-----------------: |:-------------------: |:---------------: | | release-5.1.0_v9 | 5.0.2 | NG V9 | | release-5.1.0_v10 | 5.0.3 | NG V10 | | release-5.1.0_v10 | 5.0.4 | NG V10 | | release-5.1.0_v11 | 5.0.5 | NG V11 | | release-5.1.0_v12 | 5.0.6 | NG V12 | | release-5.1.0_v10 | 5.0.8 | NG V10 | | release-5.1.0_v12 | 5.0.9 | NG V12 | | release-6.0.0_v13 | 6.0.0 | NG V13 | | release-6.0.0_v14 | 6.1.0 | NG V14 | | 8.0.0_v15 | 8.0.0 | NG V15 | | 8.0.0_v16 | 8.0.1 | NG V16 |