0.0.3 • Published 5 months ago
ng-toster v0.0.3
Here's a README.md
file for your ng-toster
npm package:
# ng-toster
`ng-toster` is a simple and customizable toast notification library for Angular applications. It provides an easy way to display messages to users in a toast-like notification style.
## Installation
You can install the package via npm:
```bash
npm install ng-toster
Usage
Step 1: Import TosterModule
in your AppModule
In your app.module.ts
, import the TosterModule
and add it to the imports
array.
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { TosterModule } from 'ng-toster';
import { AppComponent } from './app.component';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, TosterModule],
bootstrap: [AppComponent],
})
export class AppModule {}
Step 2: Add the <ng-toster></ng-toster>
in your template
In your component's HTML file, include the <ng-toster></ng-toster>
tag.
<ng-toster></ng-toster>
<button (click)="showToast()">Show Toast</button>
Step 3: Use TosterService
to Show Toast Messages
In your component, inject the TosterService
and use the show
method to display a toast notification.
import { Component } from '@angular/core';
import { TosterService } from 'ng-toster';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
})
export class AppComponent {
constructor(private tosterService: TosterService) {}
showToast() {
this.tosterService.show('This is a success message!', 'success');
}
}
Available Toast Types
- 'success': Green success toast
- 'error': Red error toast
- 'info': Blue informational toast
- 'warning': Yellow warning toast
Customization
You can customize the duration, position, and other settings of the toast notifications by providing options in the show()
method. Refer to the library documentation for more advanced configuration options.
License
This project is licensed under the MIT License - see the LICENSE file for details.
This template includes installation instructions, usage examples, available options, and basic details about your package. You can adjust it further if necessary!