# ngx-all-in-one-alerts

> This is angular all in one alert library

Latest version **0.0.7** (published 2020-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-all-in-one-alerts
pnpm add ngx-all-in-one-alerts
yarn add ngx-all-in-one-alerts
bun add ngx-all-in-one-alerts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2020-11-14 |
| First published | 2020-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 754 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Raheem Mohamed |
| Maintainers | raheem-mohamed |
| Keywords | Angular, Alerts, Notification, ng-alerts, ngx-alerts, Angular alerts |

## Links

- npm: https://www.npmjs.com/package/ngx-all-in-one-alerts
- Repository: https://github.com/raheemmohamed/ngx-all-in-one-alerts
- Homepage: https://raheemmohamed.github.io/ngx-all-in-one-alerts
- Issues: https://github.com/raheemmohamed/ngx-all-in-one-alert-library/issues
- npm.io page: https://npm.io/package/ngx-all-in-one-alerts

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.0.0

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.0.7 (latest) — 2020-11-14
- 0.0.6 — 2020-11-14
- 0.0.5 — 2020-10-21
- 0.0.4 — 2020-10-21
- 0.0.3 — 2020-10-18
- 0.0.2 — 2020-10-18
- 0.0.1 — 2020-10-18

## README

# Ngx All In One Alerts

This is angular all in one alert library

### Demo

[click here](https://raheemmohamed.github.io/ngx-all-in-one-alerts)

![Alt text](https://i.ibb.co/tpZHFRB/ngx-alerts.png "ngx all in one alerts")

### Prerequisites

Only a few prerequisites to use this plugin.

- Angular font awesome ^0.7.0 [click here to install](https://github.com/FortAwesome/angular-fontawesome)

#### Installation

##### Node

```
npm install ngx-all-in-one-alerts --save
```

#### Configuration

##### Import `NgxAllInOneAlertsModule` to your app module.

```typescript
import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { NgxAllInOneAlertsModule } from "ngx-all-in-one-alerts";

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, NgxAllInOneAlertsModule],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}
```

##### Add `ngx-all-in-one-alerts` selector for your application in template.

```html
<ngx-all-in-one-alerts
  [showModal]="showMessage"
  [msgConfig]="alertConfiguration"
  (modalChangeStatus)="modalChangeStatus($event)"
></ngx-all-in-one-alerts>
```

##### Message configuration.

```javascript
var showMessage = true;

var alertConfiguration = {
  title: "Your message title",
  description: "Your message description",
  closeOption: "default( 'true') if you dont required change to 'false'",
  alertType: "default",
  statusIcon: "default('false') if you required change to 'true'",
};
```

###### Alert message configuration | for example var `alertConfiguration` object

| Name        | Type    | Default   | Description                                                                                                                 |
| ----------- | ------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
| title       | string  | null      | Your message title                                                                                                          |
| description | string  | null      | Your message description                                                                                                    |
| closeOption | boolean | true      | default it's `true`, if you want to hide the message close button you should pass false                                     |
| alertType   | string  | "default" | default alert Type is `default`, but their's several status that you can use such as `success`, `warning`, `info`, `danger` |
| statusIcon  | boolean | false     | default it's `false`, if you set it to `true` then message display with status icons                                        |

###### Properties

| Name      | Type    | Default | Description                                                                 |
| --------- | ------- | ------- | --------------------------------------------------------------------------- |
| showModal | boolean | false   | Here you should pass `true` then message get display.                       |
| msgConfig | Object  | null    | Here you should pass variable `alertConfiguration` for display your message |

###### Events

| Name              | output receive    | Description                                        |
| ----------------- | ----------------- | -------------------------------------------------- |
| modalChangeStatus | `true` or `false` | Callback to invoke on modal display status change. |

## Further help

contact me [click here](https://inproto.net/raheem/)

---
_Source: https://npm.io/package/ngx-all-in-one-alerts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
