mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
* [WIP] [ADF-4947] Array type supported in data table columns * * removed resolver for aria label * * process services feature added * * fixed docs
5.5 KiB
5.5 KiB
Title, Added, Status, Last reviewed
Title | Added | Status | Last reviewed |
---|---|---|---|
Notification Service | v2.0.0 | Active | 2018-06-08 |
Notification Service
Shows a notification message with optional feedback.
Class members
Methods
- dismissSnackMessageAction()
dismiss the notification snackbar - openSnackMessage(message:
string
, config?:number|MatSnackBarConfig
, interpolateArgs?:any
):MatSnackBarRef
<any>
Opens a SnackBar notification to show a message.- message:
string
- The message (or resource key) to show. - config:
number|MatSnackBarConfig
- (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - interpolateArgs:
any
- (Optional) The interpolation parameters to add for the translation - Returns
MatSnackBarRef
<any>
- Information/control object for the SnackBar
- message:
- openSnackMessageAction(message:
string
, action:string
, config?:number|MatSnackBarConfig
, interpolateArgs?:any
):MatSnackBarRef
<any>
Opens a SnackBar notification with a message and a response button.- message:
string
- The message (or resource key) to show. - action:
string
- Caption for the response button - config:
number|MatSnackBarConfig
- (Optional) Time before notification disappears after being shown or MatSnackBarConfig object - interpolateArgs:
any
- (Optional) The interpolation parameters to add for the translation - Returns
MatSnackBarRef
<any>
- Information/control object for the SnackBar
- message:
- showError(message:
string
, action?:string
, interpolateArgs?:any
):MatSnackBarRef
<any>
Rase error message- message:
string
- Text message or translation key for the message. - action:
string
- (Optional) Action name - interpolateArgs:
any
- (Optional) The interpolation parameters to add for the translation - Returns
MatSnackBarRef
<any>
-
- message:
- showInfo(message:
string
, action?:string
, interpolateArgs?:any
):MatSnackBarRef
<any>
Rase info message- message:
string
- Text message or translation key for the message. - action:
string
- (Optional) Action name - interpolateArgs:
any
- (Optional) The interpolation parameters to add for the translation - Returns
MatSnackBarRef
<any>
-
- message:
- showWarning(message:
string
, action?:string
, interpolateArgs?:any
):MatSnackBarRef
<any>
Rase warning message- message:
string
- Text message or translation key for the message. - action:
string
- (Optional) Action name - interpolateArgs:
any
- (Optional) The interpolation parameters to add for the translation - Returns
MatSnackBarRef
<any>
-
- message:
Details
The Notification Service is implemented on top of the Angular Material Design snackbar. Use this service to show a notification message, and optionally get feedback from it.
import { NotificationService } from '@alfresco/adf-core';
export class MyComponent implements OnInit {
constructor(private notificationService: NotificationService) {
}
ngOnInit() {
this.notificationService
.openSnackMessage('test', 200000)
.afterDismissed()
.subscribe(() => {
console.log('The snack-bar was dismissed');
});
}
}
import { NotificationService } from '@alfresco/adf-core';
export class MyComponent implements OnInit {
constructor(private notificationService: NotificationService) {
}
ngOnInit() {
this.notificationService
.openSnackMessageAction('Do you want to report this issue?', 'send', 200000)
.afterDismissed()
.subscribe(() => {
console.log('The snack-bar was dismissed');
});
}
}
import { NotificationService } from '@alfresco/adf-core';
import { MatSnackBarConfig } from '@angular/material';
export class MyComponent implements OnInit {
snackBarConfig: MatSnackBarConfig = new MatSnackBarConfig();
constructor(private notificationService: NotificationService) {
}
ngOnInit() {
this.notificationService
.openSnackMessageAction('Do you want to report this issue?', 'send', snackBarConfig)
.afterDismissed()
.subscribe(() => {
console.log('The snack-bar was dismissed');
});
}
}
The default message duration is 5000 ms that is used only if you don't pass a custom duration in the parameters of openSnackMessageAction/openSnackMessage methods. You can also change the default 5000 ms adding the following configuration in the app.config.json:
"notificationDefaultDuration" : "7000"