Toast - Documentation | www.HtmlElements.com

Overview

The smart-toast represents an element which displays an unobtrusive notification to the user. Multiple instances of the same toast can be shown at the same time. In case with multiple instances, they are stacked vertically into special containers positioned 'top-left', 'top-right', 'bottom-left', 'bottom-right', in center(in modal mode) or in custom container, defined by the user.

Getting Started

Getting Started with Toast Web Component

Smart UI for Web Components is distributed as smart-webcomponents NPM package. You can also get the full download from our website with all demos from the Download page.

Setup the Toast

Smart UI for Web Components is distributed as smart-webcomponents NPM package

  1. Download and install the package.

    npm install smart-webcomponents

  2. Once installed, import the Toast module in your application.

    <script type="module" src="node_modules/smart-webcomponents/source/modules/smart.toast.js"></script>

  3. Adding CSS reference

    The smart.default.css CSS file should be referenced using following code.

    <link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />

  4. Add the Toast tag to your Web Page

    <smart-toast id="toast"></smart-toast>

  5. Create the Toast Component

    	<script type="module">
		Smart('#toast', class {
			get properties() {
				return { position: "top-left" }
			}
		});
	</script>

    Another option is to create the Toast is by using the traditional Javascript way:
    	const toast = document.createElement('smart-toast');

	toast.disabled = true;
	document.body.appendChild(toast);

    Smart framework provides a way to dynamically create a web component on demand from a DIV tag which is used as a host. The following imports the web component's module and creates it on demand, when the document is ready. The #toast is the ID of a DIV tag.

    	import "../../source/modules/smart.toast.js";

	document.readyState === 'complete' ? init() : window.onload = init;

	function init() { 
		const toast = new Smart.Toast('#toast', { position: "top-left" });
	}

  6. Open the page in your web server.

Appearance

By default smartToast's instance has text(set by value property), icon(set via CSS) and close button( it's visibility is controlled by showCloseButton property). This may be changed by applying custom template via itemTemplate property

By default newly opened toast instances are opened in the browsers top-right corner. This can be changed by setting the position property. There are four available options:

  • 'top-left' - renders newly opened toasts in the top-left browser's corner
  • 'top-right' - renders newly opened toasts in the top-right browser's corner
  • 'bottom-left' - renders newly opened toasts in the bottom-left browser's corner
  • 'bottom-right' - renders newly opened toasts in the bottom-right browser's corner

Demo

All toast instances are stored vertically in these common containers. The vertical order corresponds to the order of opening.

Another property, responsible about toast's positioning is appendTo. It allows toast rendering in custom container chosen by the user. If appendTo is set, then the position settings are disregarded. 

 <smart-toast id="toast1" auto-open show-close-button class="animation blink">Alert!</smart-toast>
 <div class="toast-container" id="toastContainer2"></div>

Demo

The different toast type styling cane be set via set type property. Allowed values are 'info', 'warning', 'success', 'error', 'mail', 'time'. 

 <smart-toast auto-open append-to="toastContainer" type="info">Alert!</smart-toast>
 <smart-toast auto-open append-to="toastContainer" type="warning">Alert!</smart-toast>
 <smart-toast auto-open append-to="toastContainer" type="success">Alert!</smart-toast>
 <smart-toast auto-open append-to="toastContainer" type="error">Alert!</smart-toast>
 <smart-toast auto-open append-to="toastContainer" type="mail">Alert!</smart-toast>
 <smart-toast auto-open append-to="toastContainer" type="time">Alert!</smart-toast>
 <div class="toast-container" id="toastContainer"></div>

Demo

Behavior

smartToast could be modal. It's controlled by "modal" boolean property.

 <smart-toast modal type="success">Alert!</smart-toast>

Demo



The animation class added in smartToast, produces smooth animation on open/close.

 <smart-toast auto-open class="animation">Alert!</smart-toast>

Demo



The blink class added in smartToast, produces blinking effect when an instance is opened.

 <smart-toast auto-open type="error" class="blink">Alert!</smart-toast>

Demo

Manipulating the content

smartToast allows updating the content of the last opened item by changing toast's value 

 <script>
     window.onload = function () {
         var toast = document.getElementById('toast');
         toast.value = 'Toast\'s value is updated !!!';
     }
 </script>

Methods

open - opens a new toast instance

 <script>
     window.onload = function () {
         var toast = document.getElementById('toast');
         toast.open();
     }
 </script>

closeAll - closes all opened toast instances

 <script>
     window.onload = function () {
         var toast = document.getElementById('toast');
         toast.closeAll();
     }
 </script>

closeItem - closes particular toast instance

 <script>
     window.onload = function () {
         var toast = document.getElementById('toast');
         toast.closeItem('itemId');
     }
 </script>

closeLast - closes last opened instance

 <script>
     window.onload = function () {
         var toast = document.getElementById('toast');
         toast.closeLast();
     }
 </script>

Create, Append, Remove, Get/Set Property, Invoke Method, Bind to Event


Create a new element:
	const toast = document.createElement('smart-toast');

Append it to the DOM: 
	document.body.appendChild(toast);

Remove it from the DOM: 
	toast.parentNode.removeChild(toast);

Set a property: 
	toast.propertyName = propertyValue;

Get a property value: 
	const propertyValue = toast.propertyName;

Invoke a method: 
	toast.methodName(argument1, argument2);

Add Event Listener: 
	const eventHandler = (event) => {
	   // your code here.
	};

	toast.addEventListener(eventName, eventHandler);

Remove Event Listener: 
	toast.removeEventListener(eventName, eventHandler, true);

Using with Typescript

Smart Web Components package includes TypeScript definitions which enables strongly-typed access to the Smart UI Components and their configuration.

Inside the download package, the typescript directory contains .d.ts file for each web component and a smart.elements.d.ts typescript definitions file for all web components. Copy the typescript definitions file to your project and in your TypeScript file add a reference to smart.elements.d.ts

Read more about using Smart UI with Typescript.

Getting Started with Angular Toast Component

Setup Angular Environment

Angular provides the easiest way to set angular CLI projects using Angular CLI tool.

Install the CLI application globally to your machine. 

npm install -g @angular/cli

Create a new Application

ng new smart-angular-toast

Navigate to the created project folder 

cd smart-angular-toast

Setup the Toast

Smart UI for Angular is distributed as smart-webcomponents-angular NPM package

  1. Download and install the package.
    npm install smart-webcomponents-angular
  2. Adding CSS reference

    The following CSS file is available in ../node_modules/smart-webcomponents-angular/ package folder. This can be referenced in [src/styles.css] using following code. 

    @import 'smart-webcomponents-angular/source/styles/smart.default.css';

    Another way to achieve the same is to edit the angular.json file and in the styles add the style. 

    "styles": [
		"node_modules/smart-webcomponents-angular/source/styles/smart.default.css"
	]
    If you want to use Bootstrap, Fluent or other themes available in the package, you need to add them after 'smart.default.css'.
  3. Example with Angular Standalone Components


    app.component.html

     <smart-toast #toast [position]="'top-left'" [autoOpen]="true" [showCloseButton]="true" [type]="'mail'" class="blink">You
    have 2 new messages.</smart-toast>

    app.component.ts

     import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
import { ToastComponent } from 'smart-webcomponents-angular/toast';


import { CommonModule } from '@angular/common';
import { RouterOutlet } from '@angular/router';
import { ToastModule } from 'smart-webcomponents-angular/toast';

@Component({
    selector: 'app-root',
	standalone: true,
	imports: [CommonModule, ToastModule, RouterOutlet],
    templateUrl: './app.component.html',
	styleUrls: ['./app.component.css']
})

export class AppComponent implements AfterViewInit, OnInit {	
	@ViewChild('toast', { read: ToastComponent, static: false }) toast!: ToastComponent;
	
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
		this.init();
    }
		
	init(): void {
		// init code.
	    

	}	
}

  4. Example with Angular NGModule


    app.component.html

     <smart-toast #toast [position]="'top-left'" [autoOpen]="true" [showCloseButton]="true" [type]="'mail'" class="blink">You
    have 2 new messages.</smart-toast>

    app.component.ts

     import { Component, ViewChild, OnInit, AfterViewInit } from '@angular/core';
import { ToastComponent } from 'smart-webcomponents-angular/toast';


@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
	styleUrls: ['./app.component.css']
})

export class AppComponent implements AfterViewInit, OnInit {	
	@ViewChild('toast', { read: ToastComponent, static: false }) toast!: ToastComponent;
	
 
	ngOnInit(): void {
		// onInit code.
	}

	ngAfterViewInit(): void {
		// afterViewInit code.
		this.init();
    }
		
	init(): void {
		// init code.
	    

	}	
}

    app.module.ts

     import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { ToastModule } from 'smart-webcomponents-angular/toast';

import { AppComponent } from './app.component';

@NgModule({
    declarations: [ AppComponent ],
    imports: [ BrowserModule, ToastModule ],
    bootstrap: [ AppComponent ]
})

export class AppModule { }


Running the Angular application

After completing the steps required to render a Toast, run the following command to display the output in your web browser

ng serve
and open localhost:4200 in your favorite web browser.

Read more about using Smart UI for Angular: https://www.htmlelements.com/docs/angular-cli/.

Getting Started with React Toast Component

Setup React Environment

The easiest way to start with React is to use NextJS Next.js is a full-stack React framework. It’s versatile and lets you create React apps of any size—from a mostly static blog to a complex dynamic application.

npx create-next-app my-app
cd my-app
npm run dev
or 
yarn create next-app my-app
cd my-app
yarn run dev

Preparation

Setup the Toast

Smart UI for React is distributed as smart-webcomponents-react package

  1. Download and install the package.

    In your React Next.js project, run one of the following commands to install Smart UI Toast for React

    With NPM: 

    npm install smart-webcomponents-react
    With Yarn: 
    yarn add smart-webcomponents-react

  2. Once installed, import the React Toast Component and CSS files in your application and render it. app.js

    import 'smart-webcomponents-react/source/styles/smart.default.css';
import React from "react";
import ReactDOM from 'react-dom/client';
import { Toast } from 'smart-webcomponents-react/toast';

class App extends React.Component {

	componentDidMount() {

	}

	render() {
		return (
			<div>
			    <Toast  position="top-left" autoOpen showCloseButton type="mail"
			    className="blink">You have 2 new messages.</Toast>
			</div>
		);
	}
}



export default App;

Running the React application

Start the app with 
npm run dev
or 
yarn run dev
and open localhost:3000 in your favorite web browser to see the output.

Setup with Vite

Vite (French word for "quick", pronounced /vit/, like "veet") is a build tool that aims to provide a faster and leaner development experience for modern web projects
With NPM: 
npm create vite@latest
With Yarn: 
yarn create vite
Then follow the prompts and choose React as a project.

Navigate to your project's directory. By default it is 'vite-project' and install Smart UI for React

In your Vite project, run one of the following commands to install Smart UI Toast for React

With NPM: 

npm install smart-webcomponents-react
With Yarn: 
yarn add smart-webcomponents-react

Open src/App.tsx App.tsx

import 'smart-webcomponents-react/source/styles/smart.default.css';
import React from "react";
import ReactDOM from 'react-dom/client';
import { Toast } from 'smart-webcomponents-react/toast';

class App extends React.Component {

	componentDidMount() {

	}

	render() {
		return (
			<div>
			    <Toast  position="top-left" autoOpen showCloseButton type="mail"
			    className="blink">You have 2 new messages.</Toast>
			</div>
		);
	}
}



export default App;

Read more about using Smart UI for React: https://www.htmlelements.com/docs/react/.

Getting Started with Vue Toast Component


Setup Vue with Vite

In this section we will introduce how to scaffold a Vue Single Page Application on your local machine. The created project will be using a build setup based on Vite and allow us to use Vue Single-File Components (SFCs). Run the following command in your command line 
npm create vue@latest
This command will install and execute create-vue, the official Vue project scaffolding tool. You will be presented with prompts for several optional features such as TypeScript and testing support: 
✔ Project name: … 
✔ Add TypeScript? … No / Yes
✔ Add JSX Support? … No / Yes
✔ Add Vue Router for Single Page Application development? … No / Yes
✔ Add Pinia for state management? … No / Yes
✔ Add Vitest for Unit testing? … No / Yes
✔ Add an End-to-End Testing Solution? … No / Cypress / Playwright
✔ Add ESLint for code quality? … No / Yes
✔ Add Prettier for code formatting? … No / Yes

Scaffolding project in ./...
Done.
If you are unsure about an option, simply choose No by hitting enter for now. Once the project is created, follow the instructions to install dependencies and start the dev server: 
cd 
npm install
npm install smart-webcomponents
npm run dev

  • Make Vue ignore custom elements defined outside of Vue (e.g., using the Web Components APIs). Otherwise, it will throw a warning about an Unknown custom element, assuming that you forgot to register a global component or misspelled a component name.

    Open vite.config.js in your favorite text editor and change its contents to the following:

    vite.config.js

    import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: tag => tag.startsWith('smart-')
        }
      }
    })
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  }
})
  • Open src/App.vue in your favorite text editor and change its contents to the following:

    App.vue 

    <template>
  <div class="vue-root">
    <smart-toast
      position="top-left"
      auto-open
      show-close-button
      type="mail"
      class="blink"
    >You have 2 new messages.</smart-toast>
  </div>
</template>

<script>
import { onMounted } from "vue";
import "smart-webcomponents/source/styles/smart.default.css";
import "smart-webcomponents/source/modules/smart.toast.js";

export default {
  name: "app",
  setup() {
    onMounted(() => {});
  }
};
</script>

<style>
</style>
    We can now use the smart-toast with Vue 3. Data binding and event handlers will just work right out of the box.

Running the Vue application

Start the app with 
npm run dev
and open http://localhost:5173/ in your favorite web browser to see the output below:
When you are ready to ship your app to production, run the following: 
npm run build
This will create a production-ready build of your app in the project's ./dist directory.

Read more about using Smart UI for Vue: https://www.htmlelements.com/docs/vue/.