@craftsjs/notifier
v5.1.0
Published
Material menu library for angular
Downloads
26
Readme
CRAFTSJS notifier
CRAFTSJS notifier is a library for angular
Getting Started
To get started, let's install the package through npm:
Choose the version corresponding to your Angular version:
Angular | @craftsjs/alert ----------- | ------------------- 15 | 5.x 13 | 4.x 12 | 3.x 11 | 2.x 10 | 1.x
npm i @craftsjs/notifier --SInstall peer dependencies
npm i
@craftsjs/core
@angular/material
@angular/cdk
@angular/animations --SHow to use
- Import the module NotifierModule into the AppModule
import { NotifierModule } from '@craftsjs/notifier';
@NgModule({
imports: [
NotifierModule.forRoot() ,
// options
/*NotifierModule.forRoot({
position: NotifierPositionType.bottomRight,
timeout: 5000,
classIcon: 'material-icons',
iconValue: 'notifications'
})*/
]
})
export class AppModule { }- Import the module NotifierModule into the ChildModule
import { NotifierModule } from '@craftsjs/notifier';
@NgModule({
imports: [NotifierModule],
declarations: [NotifierComponent]
})
export class ChildModule { }- Create a component an inject NotifierService
@Component(// ...)
export class NotifierComponent {
constructor(private notifierService: NotifierService) { }
openNotifier() {
this.notifierService.open({
type: NotifierType.success,
message: 'Notifier success'
});
}
} <button type="button" mat-raised-button color="primary" (click)="openNotifier()">Notifier success</button>- Notifier type options
export enum NotifierType {
primary,
accent,
success,
warning,
danger,
info
}Custom notifier
@Component(// ...)
export class NotifierCustomComponent {
constructor(@Inject(CRAFTSJS_NOTIFIER_DATA) public notifier: Notifier) {
console.log(notifier);
}
} <span class="notifier-custom">
<mat-icon suffix *ngIf="notifier.data?.icon">{{notifier.data.icon}}</mat-icon> {{notifier.message}}
</span>import { NotifierModule } from '@craftsjs/notifier';
@NgModule({
imports: [
//...,
NotifierModule
],
declarations: [NotifierCustomComponent, NotifierCustomSuccessComponent],
entryComponents: [
NotifierCustomComponent // important this line
]
})
export class ChildModuleModule { }@Component(// ...)
export class NotifierCustomSuccessComponent {
constructor(private notifierService: NotifierService) { }
openNotifier() {
this.notifierService.open({
type: NotifierType.success,
message: 'Custom notifier success',
templateOrComponent: NotifierCustomComponent,
data: {
icon: 'done'
}
});
}
}Import css
@import '~@angular/material/theming';
@import '~@craftsjs/notifier/craftsjs-notifier.theme';
$craftsjs-app-primary: mat-palette($mat-teal, 800);
$craftsjs-app-accent: mat-palette($mat-pink, 800, A100, 100);
$craftsjs-app-warn: mat-palette($mat-red);
$craftsjs-app-theme: mat-light-theme($craftsjs-app-primary, $craftsjs-app-accent, $craftsjs-app-warn);
$craftsjs-theme-variables: (
color-info: #20a9d2,
color-success: #5cb85c,
color-danger: #d43934,
color-warning: #e09d3d
);
@include mat-core();
body.theme-default {
@include angular-material-theme($craftsjs-app-theme);
@include notifier($craftsjs-app-theme, $craftsjs-theme-variables);
}- Do not forget to put the theme-default class in the html body
<body class="theme-default"></body>