Svelte-DaisyUI-Toast

A simple toast component for Svelte with DaisyUI styling.

Installation

npm i svelte-daisyui-toast

Quick Start

You'll need a Svelte project with DaisyUI installed.

1. Add the styles to your tailwind.config.js file:

/** @type {import('tailwindcss').Config} */
module.exports = {
    content: [
        './src/**/*.{html,js,svelte,ts}',
+        './node_modules/svelte-daisyui-toast/dist/**/*.{js,svelte}',
    ]
    // ...
};

2. Add the <Toaster /> component to your +layout.svelte file.
3. Set the default toast options using toast.defaults.set()
4. Add new toasts using the methods on the toast store.

<script>
  import { Toaster, toast } from "svelte-daisyui-toast";

  toast.defaults.set({ clear_on_navigate: true })
</script>

<slot />

<button on:click={() => toast.info("Hello, world!")}> Add Toast </button>

<Toaster />

Types

Some types used in the API.

/** Represents an individual toast in the store */
type Toast = {
  /** Random nanoid generated when adding a new toast. Used to remove toast later */
  id: string;

  /** Type of toast. Affects which DaisyUI styles are applied */
  type: "success" | "info" | "warning" | "error";

  /** Message to display in the toast */
  message: string;
  /** Whether to render the message as HTML. Defaults to false */
  html?: boolean;

  /** How many milliseconds to show for before removing.
   * If not set, toast will not be removed automatically.
   */
  duration_ms?: number;

  /** Show an icon on the left side of the toast.
   * Can be a component or a string.
   */
  icon?: ComponentType | string;

  /** Remove toast when navigating away from the current route.
   * By default, toast will not be removed when navigating away
   */
  clear_on_navigate?: boolean;
};

export type AddToastOptions = {
  /** Only add if queue is empty */
  if_empty?: boolean;
  /** Clear queue before adding */
  clear_queue?: boolean;
};

API

Adding a toast

The base method to add new toasts to the store is toast.add:

function add(
  toast: Omit<Toast, "id">,
  options?: AddToastOptions,
): Toast;

There are also shorthand methods to add each type of toast (each with the same function signature):

function TYPE(
  message: string,
  input?: Omit<Toast, "id" | "type" | "message">,
  options?: AddToastOptions;
): Toast;

The full list of shorthands is:

• toast.success
• toast.info
• toast.warning
• toast.error

For example, toast.success('Hello, world!') is equivalent to toast.add({ type: 'success', message: 'Hello, world!' }).

Removing a toast

To remove a toast, use toast.remove, passing in the id of the toast to remove:

function remove(id: string): void;

Toaster Component

The <Toaster /> component is used to render the toasts in the store. It should be placed in your +layout.svelte file.

It accepts the following props:

alignment

Determines where the toasts are rendered on the screen. Defaults to bottom-right

{
    x?: 'start' | 'center' | 'end';
    y?: 'top' | 'middle' | 'bottom';
}

These values align (👀) with the DaisyUI classes for the Toast component.