toaster7zz
v0.0.4
Published
Toaster7zz is an Angular library that provides a simple and customizable toaster notification system. It allows developers to display messages to users in a visually appealing way, with different message types (success, error, warning, info).
Downloads
222
Readme
Toaster7zz
Toaster7zz is an Angular library that provides a simple and customizable toaster notification system. It allows developers to display messages to users in a visually appealing way, with different message types (success, error, warning, info).
Requirements
For optimal functionality and styling, it is necessary to have Bootstrap 5 integrated into your Angular application. This library utilizes Bootstrap styles to render notifications effectively and responsively.
Features
- Simple interface for showing notifications
- Supports different message types: success, error, warning, info
- Automatic dismiss after a specified duration
- Customizable styles
Installation
To install the toaster7zz
library, run the following command:
npm install toaster7zz
You also need to install Bootstrap 5:
npm install bootstrap
Make sure to include Bootstrap 5 in your project's global styles. Add the following line to angular.json in the styles array:
"styles": [
"src/styles.scss", // or styles.css, depending on your setup
"node_modules/bootstrap/dist/css/bootstrap.min.css"
],
Usage
Import the Module In your application module (e.g., app.module.ts), import the ToasterModule:
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import { ToasterModule } from 'toaster7zz'; // Import the ToasterModule
@NgModule({
declarations: [
AppComponent,
// other components
],
imports: [
BrowserModule,
AppRoutingModule,
Toaster7zzModule // Include ToasterModule here
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
Using the Toaster Add the to your main component template (app.component.html): import { Component } from '@angular/core'; import { Toaster7zzService } from 'toaster7zz'; // Import the toaster service
@Component({
selector: 'app-main',
templateUrl: './main.component.html',
styleUrls: ['./main.component.css'],
})
export class MainComponent {
constructor(private toasterService: Toaster7zzService) {}
showToastSuccess() {
this.toasterService.show('This is a success message!', 'Success', 'success'); // Show success message
}
showToastError() {
this.toasterService.show('This is an error message!', 'Error', 'error'); // Show error message
}
showToastWarning() {
this.toasterService.show('This is a warning message!', 'Warning', 'warning'); // Show warning message
}
showToastInfo() {
this.toasterService.show('This is an info message!', 'Info', 'info'); // Show info message
}
}
Other Details
Selector:
The toaster-7zz selector for the toaster component is included where it's used.
Service:
The Toaster7zzService is correctly utilized in the usage examples.
Custom Messages:
Examples are provided to demonstrate how to display different types of messages.
Configuration
You can customize the duration that the toast remains visible by modifying the duration parameter in the show method.
License
This project is licensed under the MIT License - see the LICENSE file for details.