WML Notify
This content is for the 19.0.0 version. Switch to thelatest versionfor up-to-date documentation.
The Angular WML Notify library is an Angular-based toolkit designed to enhance user notifications and messaging within applications. Its primary objective is to offer a streamlined and efficient way for developers to integrate and manage notifications, alerts, and informational messages in their Angular projects. The library provides a set of components and services that enable the display of various types of messages, such as errors, information, success, and warnings, with customizable options to cater to different needs and scenarios. It leverages Angular’s powerful features to create a responsive and interactive user experience, addressing common challenges in handling user notifications with ease and precision.
At the heart of the wml-notify library are two central components: WMLNotifyOneComponent and WMLNotifyOneMsgComponent . WMLNotifyOneComponent acts as a container for individual notifications, managing their display and behavior, including auto-hiding, user-initiated closure, and actions. It integrates with the WMLNotifyOneService to listen for notification events and render them appropriately. WMLNotifyOneMsgComponent , on the other hand, is responsible for rendering the message content, supporting both default text messages and custom Angular components for more dynamic and interactive content. Developers can customize notifications using various attributes and methods provided by these components, such as message types, auto-hide functionality, and custom action handlers. The library encourages a modular approach, allowing developers to leverage these components either independently or together, facilitating a versatile implementation that aligns with the specific requirements of their Angular applications.
Installation
Terminal window
npm install -s --verbose @windmillcode/angular-wml-notifyUsage
WMLNotifyOne
Getting Started
Different Alerts
Hide Functionality
Reference
WMLNotifyOneBarModel
| Property | Type | Description |
|---|---|---|
| autoHide | boolean | Determines if the notification should auto-hide. |
| closed | boolean | Indicates if the notification is closed. |
| closeable | boolean | Determines if the notification can be manually closed by the user. |
| hideDelay | number | Time in milliseconds before the notification auto-hides. |
| hideOnHover | boolean | Determines if the notification should hide when hovered. |
| id | number | Unique identifier for the notification. |
| style | Partial<CSSStyleDeclaration> | Styles to be applied to the notification bar. |
| msgtype | ”default" | "custom” |
| custom | WMLCustomComponent | Custom component to be used as the notification content. |
| message | string | The message to be displayed in the notification. |
| type | WMLNotifyOneBarType | The type of the notification (Error, Info, Success, Warning). |
| typeValue | string | The string value of the notification type. |
| shouldDisplay | function | Function to determine if the notification should be displayed. |
WMLNotifyOneService Methods
| Method | Parameters | Description |
|---|---|---|
| create | notificationBar: WMLNotifyOneBarModel | Creates and displays a new notification. |
| clear | None | Clears all displayed notifications. |
WMLNotifyOneComponent Events
| Event | Parameters | Description |
|---|---|---|
| action | notificationBar: WMLNotifyOneBarModel | Emitted when an action on a notification is triggered. |
| closed | notificationBar: WMLNotifyOneBarModel | Emitted when a notification is closed. |
WMLNotifyOneBarType Enumeration
| Value | Description |
|---|---|
| Error | Represents an error notification. |
| Info | Represents an informational notification. |
| Success | Represents a success notification. |
| Warning | Represents a warning notification. |
Changelog
v1.0.0
MAJOR rename to angular-wml-notifyfixed major problems concerning ngx-translate
// translate// first make sure to have ONLY ONE in the imports for AppModule TranslateModule.forRoot({ defaultLanguage: 'en', loader: { provide: TranslateLoader, useFactory: HttpLoaderFactory, deps:[HttpClient] } }),// thenWmlNotifyNGXTranslateModule// for regularWmlNotifyModule%!(EXTRA string=
v16.2.80
updated package to reflect the version 16.2.80 of @angular/core package),
v16.2.80
updated package to reflect the version 16.2.80 of @angular/core package,
v16.2.90
updated package to reflect the version 16.2.90 of @angular/core package,
v16.2.91
updated package to reflect the version 16.2.91 of @angular/core package,
v16.2.93
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v16.2.100
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v16.2.110
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v16.2.120
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v17.0.10
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v17.0.11
updated package to conform with @windmillcode/angular-wml-components-base for unit testing features ,
v17.0.20
updated package to reflect the version ^17.0.2 of @angular/core package,
v17.0.40
updated package to reflect the version ^17.0.4 of @angular/core package,
v17.0.50
updated package to reflect the version ^17.0.5 of @angular/core package,
v17.0.60
updated package to reflect the version ^17.0.6 of @angular/core package,
v17.0.70
updated package to reflect the version ^17.0.7 of @angular/core package,
v17.0.7100
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.7200
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.7300
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.80
updated package to reflect the version ^17.0.8 of @angular/core package,
v17.0.8100
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.8102
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.8103
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.9000
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.0.9001
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.1.0000
updated package to reflect the version ^17.1.0 of @angular/core package,
v17.1.2
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.1.1000
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.1.2000 [2/5/24]
updated package to reflect the version ^17.1.2 of @angular/core package,
v17.1.2001 [2/8/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.1.3000 [2/8/24]
updated package to reflect the version ^17.1.3 of @angular/core package,
v17.2.1000 [2/17/24]
updated package to reflect the version ^17.2.1 of @angular/core package,
v17.2.2000 [2/23/24]
updated package to reflect the version ^17.2.2 of @angular/core package,
v17.2.2001 [2/23/24]
updated package to reflect the version ^17.2.2 of @angular/core package,
v17.2.3000 [2/28/24]
updated package to reflect the version ^17.2.3 of @angular/core package,
v17.2.3001 [3/2/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.2.3002 [3/5/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.2.4000 [3/8/24]
updated package to reflect the version ^17.2.4 of @angular/core package,
v17.2.4001 [3/12/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.2.4002 [3/12/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.2.4003 [3/13/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.2.4004 [3/13/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.3.0 [3/17/24]
updated package to reflect the version ^17.3.0 of @angular/core package ,
v17.3.1000 [3/22/24]
updated package to reflect the version ^17.3.1 of @angular/core package,
v17.3.2000 [3/28/24]
updated package to reflect the version ^17.3.2 of @angular/core package,
v17.3.3000 [4/4/24]
updated package to reflect the version ^17.3.3 of @angular/core package,
v17.3.4000 [4/11/24]
updated package to reflect the version ^17.3.4 of @angular/core package,
v17.3.4001 [4/16/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.3.5000 [4/20/24]
updated package to reflect the version ^17.3.5 of @angular/core package,
v17.3.5110 [5/1/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v17.3.6000 [5/1/24]
updated package to reflect the version ^17.3.6 of @angular/core package,
v17.3.7000 [5/9/24]
updated package to reflect the version ^17.3.7 of @angular/core package,
v17.3.8000 [5/9/24]
updated package to reflect the version ^17.3.8 of @angular/core package,
v17.3.9000 [5/16/24]
updated package to reflect the version ^17.3.9 of @angular/core package,
v18.0.1 [5/22/24]
updated package to reflect the version ^18.0.0 of @angular/core package,
v18.0.4 [5/25/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.0.1000 [5/29/24]
updated package to reflect the version ^18.0.1 of @angular/core package,
v18.0.2000 [6/6/24]
updated package to reflect the version ^18.0.2 of @angular/core package,
v18.0.3000 [6/13/24]
updated package to reflect the version ^18.0.3 of @angular/core package,
v18.0.3010 [6/18/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.0.4000 [6/23/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.0.5000 [6/26/24]
updated package to reflect the version ^18.0.5 of @angular/core package,
v18.0.6000 [7/5/24]
updated package to reflect the version ^18.0.6 of @angular/core package,
v18.1.4 [7/13/24]
updated package to reflect the version ^18.1.0 of @angular/core package,
v18.1.6 [7/14/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.1000 [7/18/24]
updated package to reflect the version ^18.1.1 of @angular/core package,
v18.1.2000 [7/24/24]
updated package to reflect the version ^18.1.2 of @angular/core package,
v18.1.2300 [7/27/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.2301 [7/30/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.3000-beta1 [8/1/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.3000-beta2 [8/1/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.3000-beta3 [8/1/24]
updated package to conform with @windmillcode/angular-wml-components-base ,
v18.1.3000-beta4 [8/1/24]
v18.1.3001 [8/4/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3002 [8/4/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3002 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3003 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3004 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3005 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3006 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.3007 [8/5/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.4000 [8/14/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.1.4001 [8/14/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.0 [8/15/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.1 [8/20/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.1000 [8/22/24]
updated package to reflect the version 18.2.1 of @angular/core package
v18.2.1010 [8/22/24]
[FIX] fixed a bug with the click action for wml-notify
v18.2.2000 [8/30/24]
updated package to reflect the version 18.2.2 of @angular/core package
v18.2.2100 [9/1/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.2101 [9/1/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.2200 [9/3/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.3000 [9/4/24]
updated package to reflect the version 18.2.3 of @angular/core package
v18.2.3100 [9/8/24]
updated package to reflect the version 18.2.3 of @angular/core package
v18.2.3110 [9/10/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.3112 [9/10/24]
updated package to conform with @windmillcode/angular-wml-components-base
v18.2.4000 [9/16/24]
updated package to reflect the version 18.2.4 of @angular/core package
v18.2.4100 [9/19/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.4200 [9/21/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.5001 [9/22/24]
updated package to reflect the version 18.2.5 of @angular/core package
v18.2.6000 [10/1/24]
updated package to reflect the version 18.2.6 of @angular/core package
v18.2.7000 [10/2/24]
updated package to reflect the version 18.2.7 of @angular/core package
v18.2.7001 [10/5/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.7010 [10/9/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.7020 [10/10/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.8000 [10/10/24]
updated package to reflect the version 18.2.8 of @angular/core package
v18.2.8000 [10/11/24]
updated package to reflect the version 18.2.8 of @angular/core package
v18.2.8001 [10/11/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.9000 [10/23/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.10000 [10/31/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.11000 [11/7/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.12000 [11/15/24]
updated package to conform with @windmillcode/wml-components-base
v18.2.12001 [11/17/24]
updated package to conform with @windmillcode/wml-components-base
v19.0.0 [11/19/24]
updated package to conform with @windmillcode/wml-components-base
v19.0.3 [11/20/24]
updated package to conform with @windmillcode/wml-components-base
v19.0.4 [11/26/24]
updated package to conform with @windmillcode/wml-components-base
v19.0.1000 [11/26/24]
updated package to conform with @windmillcode/wml-components-base