ChrisMingay.BlazorTailwindToast 1.1.0

Blazor Tailwind Toast

This is a JavaScript free toast implementation for Blazor and Razor Components applications using tailwindcss for styling.

This project is a fork of Blazored.Toast with some minor differences.

Differences from Blazored Toast

• Uses tailwind for styling rules
• Removed icons
• Removed progress bar
• Ability to select which position a toast instance appears on screen.
• Hover pauses the timeout
• Toast content has to be a string (for now), whereas Blazored Toast lets you send a RenderFragment

Change Log

You can view the change log HERE.

Getting Setup

You can install the package via the NuGet package manager just search for ChrisMingay.BlazorTailwindToast. You can also install via powershell using the following command.

Install-Package ChrisMingay.BlazorTailwindToast

Or via the dotnet CLI

dotnet add package ChrisMingay.BlazorTailwindToast

1. Register Services

You will need to register the Toast service in your application

Blazor Server

Add the following line to your applications Startup.ConfigureServices method.

public void ConfigureServices(IServiceCollection services)
{
    services.AddBlazorTailwindToast();
}

Blazor WebAssembly

Add the following line to your applications Program.Main method.

builder.Services.AddBlazorTailwindToast();

2. Add Imports

Add the following to your _Imports.razor

@using BlazorTailwindToast
@using BlazorTailwindToast.Services
@using BlazorTailwindToast.Enums
@using BlazorTailwindToast.Configuration

3. Register Toasts Component

Add the <Toaster /> tag into your applications MainLayout.razor.

4. Add reference to style sheet

Add the following line to the head tag of your _Host.cshtml (Blazor Server app) or index.html (Blazor WebAssembly).

For minifed use:

<link href="_content/ChrisMingay.BlazorTailwindToast/app.min.css" rel="stylesheet" />

The stylesheet app.min.css contains only the tailwind styles defined in the build process. It is not required that you reference tailwind in your host project, all styles are self contained.

Usage

Toast instances are configured with the ToastOptions class:

public class ToastOptions
{
    // The theme to use for this instance
    public ToastLevel Level { get; set; } = ToastLevel.Info;

    // The position of this instance
    public ToastPosition Position { get; set; } = ToastPosition.TopRight;

    // An optional heading
    public string Heading { get; set; }

    // The message body
    public string Message { get; set; }

    // How long the instance stays on screen in millisends
    public int Timeout { get; set; } = 5000; // i.e. 5 secods

    // An option on click event can be run
    public Action? OnClick { get; set; }

    // When an action is provided this is used for the button text.
    public string ButtonLabel { get; set; }

}

Code Example

@page "/toastdemo"
@inject IToastService toastService

<h1>Toast Demo</h1>

<button style="padding: 10px; margin: 10px; border: 1px solid #ccc" type="button" @onclick='() => toastService.ShowToast("Message","Heading")'>
    Inline message and heading
</button>

<button style="padding: 10px; margin: 10px; border: 1px solid #ccc" type="button" @onclick='() => toastService.ShowToast(new ToastOptions(){
    Message = " Toast option based message",
        Heading=null,
        Timeout=10000,
        Level=ToastLevel.Error,
        Position=ToastPosition.BottomCenter
        })'>
    ToastOption based
</button>

Full examples for client and server-side Blazor are included in the samples.

Remove Toasts When Navigating

If you wish to clear any visible toasts when the user navigates to a new page you can enable the RemoveToastsOnNavigation parameter. Setting this to true will remove any visible toasts whenever the LocationChanged event fires.