Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lazycuh/angular-notification
A singleton, global Angular service to programmatically show notifications
https://github.com/lazycuh/angular-notification
angular angular-notification angular-notification-component angular-notification-service notification-component notification-service notification-ui
Last synced: 5 days ago
JSON representation
A singleton, global Angular service to programmatically show notifications
- Host: GitHub
- URL: https://github.com/lazycuh/angular-notification
- Owner: lazycuh
- License: mit
- Created: 2023-11-12T04:33:06.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-16T17:29:46.000Z (4 months ago)
- Last Synced: 2024-07-17T07:01:17.994Z (3 months ago)
- Topics: angular, angular-notification, angular-notification-component, angular-notification-service, notification-component, notification-service, notification-ui
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@babybeet/angular-notification
- Size: 6.29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - angular-notification - A singleton, global Angular service to programmatically show notifications. (Table of contents / Third Party Components)
README
# angular-notification [](https://app.circleci.com/pipelines/github/lazycuh/angular-notification?branch=main)
A singleton, global Angular service to programmatically render notifications.
## Table of contents
- [Angular compatibility](#angular-compatibility)
- [Installation](#installation)
- [Available APIs](#available-apis)
- [`NotificationService`](#notificationservice)
- [`NotificationConfiguration`](#notificationconfiguration)
- [`Theme`](#theme)
- [Example Usage](#example-usage)
- [Code example](#code-example)
- [Result](#result)
## Angular compatibility
| This library | Angular |
| ------------ | ------- |
| 1.x.x | 16 - 18 |
## Installation
- `npm`
```
npm i -S @lazycuh/angular-notification
```
- `pnpm`
```
pnpm i -S @lazycuh/angular-notification
```
- `yarn`
```
yarn add @lazycuh/angular-notification
```
## Available APIs
These are the symbols that are available from this package
### `NotificationService`
A singleton Angular service to programmatically show notifications.
```ts
class NotificationService {
/**
* Set the default theme that will be used for all notifications created in the future.
*
* @param theme The new theme to be used as the default.
*/
static setDefaultTheme(theme: Theme): void;
/**
* Set the default label for the close button. Default is `Close`.
*/
static setDefaultCloseButtonLabel(label: string): void;
/**
* Open a notification using the provided configuration. The opened notification
* will be closed automatically after 10 seconds by default.
*
* @param notificationConfiguration The notification configuration object.
*/
open(notificationConfiguration: NotificationConfiguration);
}
```
### `NotificationConfiguration`
The configuration object for the notification to be created.
```ts
interface NotificationConfiguration {
/**
* The optional number of milliseconds after which the notification is closed. Default is 10 seconds.
*/
autoCloseMs?: number;
/**
* The optional class name to add for this notification.
*/
className?: string;
/**
* The optional label for the notification's close button. Default is `Close`.
*/
closeButtonLabel?: string;
/**
* The required notification content to show. HTML is supported.
*/
content: string;
/**
* The optional theme for the floating box. Default is `light`.
*/
theme?: Theme;
}
```
### `Theme`
```ts
type Theme = 'dark' | 'light';
```
## Example Usage
### Code example
```typescript
// Import the service into your class to start using it
import { NotificationService } from '@lazycuh/angular-notification';
@Component({
selector: 'test-component',
template: `
Click me
`
})
export class TestComponent {
constructor(private readonly notificationService: NotificationService) {}
showNotification() {
this.notificationService.open({
content: 'This notification is very important'
});
}
}
```
### Result
| Theme | |
| ----- | ------------------------------------------------------------------------------ |
| Light |  |
| Dark |  |