Smoking hot Notifications for Angular. Lightweight, customizable and beautiful by default. Inspired from react-hot-toast

https://github.com/ngxpert/hot-toast/assets/6831283/ae718568-d5ea-47bf-a41d-6aabc7d4a044

Compatibility with Angular Versions

For older Angular versions, keep using @ngneat/hot-toast from npm.

Features

• 🔥 Hot by default
• ☕ Easy to use
• 🐍 Snackbar variation
• ♿ Accessible
• 🖐️ Reduce motion support
• 😊 Emoji Support
• 🛠 Customizable
• ⏳ Observable API
• ✋ Pause on hover
• 🔁 Events
• 🔒 Persistent

Installation

With npm:

1npm install @ngneat/overview@6.0.0 @ngxpert/hot-toast

or yarn

1yarn add @ngneat/overview@6.0.0 @ngxpert/hot-toast

1ng add @ngneat/hot-toast

1# For Angular version >= 9.1.13 < 13
2npm install @ngneat/overview@2.0.2 @ngneat/hot-toast@3
3
4# For Angular version >= 13 < 15
5npm install @ngneat/overview@3.0.0 @ngneat/hot-toast@4
6
7# For Angular version >= 15 <16
8npm install @ngneat/overview@3.0.0 @ngneat/hot-toast@5
9
10# For Angular version >= 16 <17
11npm install @ngneat/overview@5.1.1 @ngneat/hot-toast@6

Setup

Styles

If you use SCSS add this line to your main styles.scss:

1@use 'node_modules/@ngxpert/hot-toast/src/styles/styles.scss';

or if you use CSS add this to your styles inside your angular.json:

1"styles": [
2     "node_modules/@ngxpert/hot-toast/src/styles/styles.css",
3],

Standalone Setup

1import { AppComponent } from './src/app.component';
2
3import { provideHotToastConfig } from '@ngxpert/hot-toast';
4
5bootstrapApplication(AppComponent, {
6  providers: [
7    provideHotToastConfig(), // @ngxpert/hot-toast providers
8  ]
9});

Module Setup

Add provideHotToastConfig() to your app.module.ts providers section. Toast options (Partial<ToastConfig>) here.:

1import { providerHotToastConfig } from '@ngxpert/hot-toast';
2
3@NgModule({
4  providers: [provideHotToastConfig()],
5})
6class AppModule {}

Stylings

if you use SCSS add this line to your main styles.scss:

1@use '@ngxpert/hot-toast/src/styles/styles.scss';

or if you use CSS add this to your styles inside your angular.json:

1"styles": [
2     "node_modules/@ngxpert/hot-toast/src/styles/styles.css",
3],

Basic Usage

1import { HotToastService } from '@ngxpert/hot-toast';
2
3@Component({})
4export class AppComponent {
5  constructor(private toast: HotToastService) {}
6
7  showToast() {
8    this.toast.show('Hello World!');
9    this.toast.loading('Lazyyy...');
10    this.toast.success('Yeah!!');
11    this.toast.warning('Boo!');
12    this.toast.error('Oh no!');
13    this.toast.info('Something...');
14  }
15
16  update() {
17    saveSettings
18      .pipe(
19        this.toast.observe({
20          loading: 'Saving...',
21          success: 'Settings saved!',
22          error: 'Could not save.',
23        })
24      )
25      .subscribe();
26  }
27}

You can pass ToastOptions while creating the toast to customize the look and behavior:

1import { HotToastService } from '@ngxpert/hot-toast';
2
3@Component({})
4export class AppComponent {
5  constructor(private toast: HotToastService) {}
6
7  customToast() {
8    this.toast.success('Look at my styles, and I also need more time!', {
9      duration: 5000,
10      style: {
11        border: '1px solid #713200',
12        padding: '16px',
13        color: '#713200',
14      },
15      iconTheme: {
16        primary: '#713200',
17        secondary: '#FFFAEE',
18      },
19    });
20  }
21}

You can also set global ToastConfig options while importing:

1import { provideHotToastConfig } from '@ngxpert/hot-toast';
2
3@NgModule({
4  providers: [
5    provideHotToastConfig({
6      reverseOrder: true,
7      dismissible: true,
8      autoClose: false,
9    }),
10  ],
11})
12class AppModule {}

Additionally, you have the option of using a standalone function to provide a global toast configuration within your app's configuration file:

1// app.config.ts
2import { provideHotToastConfig } from '@ngxpert/hot-toast';
3
4export const appConfig: ApplicationConfig = {
5  providers: [provideHotToastConfig({ ... })],
6};

Examples

You can checkout examples at: https://ngxpert.github.io/hot-toast#examples.

ToastConfig

All options, which are set Available in global config? from ToastOptions are supported. Below are extra configurable options:

ToastOptions

Configuration used when opening an hot-toast.

Supported Browsers

Latest versions of Chrome, Edge, Firefox and Safari are supported, with some known issues.

Accessibility

Hot-toast messages are announced via an aria-live region. By default, the polite setting is used. While polite is recommended, this can be customized by setting the ariaLive property of the ToastConfig or ToastOptions.

Focus is not, and should not be, moved to the hot-toast element. Moving the focus would be disruptive to a user in the middle of a workflow. It is recommended that, for any action offered in the hot-toast, the application offers the user an alternative way to perform the action. Alternative interactions are typically keyboard shortcuts or menu options. When the action is performed in this way, the hot-toast should be dismissed.

Hot-toasts that have an action available should be set autoClose: false, as to accommodate screen-reader users that want to navigate to the hot-toast element to activate the action.

Breaking Changes

v1 to v2

The <div> surrounding <ng-container> is removed from .hot-toast-message to better and easy structure of layout. User may need to check their templates after updating to v2.

v2 to v3

None

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Dharmen Shah 💻 🖋 🎨 📖 💡

Netanel Basal 🐛 💼 🤔 🚧 🧑‍🏫 📆 🔬 👀

Timo Lins 🎨 🤔

Patrick Miller 🚧 📦

Gili Yaniv 💻

Artur Androsovych 🚧

Luis Castro 💻

This project follows the all-contributors specification. Contributions of any kind welcome!