@significa/svelte-toaster

Svelte Toaster

Svelte Toaster is a complete solution for toast notifications on Svelte. It allows you to bring your own toast component and schema.

Installation

npm install svelte-toaster

Usage

Create your toaster in a centralized file (e.g.: /lib/toaster.ts)

import { createToaster } from 'svelte-toaster';

// can be whatever type. you can even decide which "types" your toasts have
export type MyToast = {
  type?: 'loading' | 'success' | 'error' | 'info' | 'warning';
  title: string;
  description?: string;
  onUndo?: () => void;
};

export const toaster = createToaster<MyToast>({
  // can be a number or a function that receives the toast data and ID. you can override in individual toasts.
  duration: ({ data }) => (data.type === 'error' ? 5000 : 2000)
});

Create your toast component

<script lang="ts">
  import type { Toast } from 'svelte-toaster';
  import type { MyToast } from '$lib/toaster';

  export let toast: Toast<ToastType>;
</script>

<div>
  {toast.title}
</div>

Render the Toaster

<script lang="ts">
  import { Toaster } from 'svelte-toaster'
  import { toaster } from '$lib/toaster'
  import Toast from './my-project/toast.svelte'
</script>

<Toaster {toaster} let:toast>
  <Toast {toast}>
</Toaster>

Call the toaster methods to render notifications

<script lang="ts">
  import { toaster } from '$lib/toaster';

  toaster({ title: 'Hello' });
  toaster({ title: 'Hello' }, { duration: 10000 });
  toaster({ title: 'Hello' }, { id: 'hello' }); // if the toast already present, it will re-occur
  toaster.promise(myPromise, {
    loading: { type: 'loading', title: 'loading your data' },
    success: { type: 'success', title: 'hooray' },
    error: { type: 'error', title: 'Oops' }
  });

  // manage your toaster
  toaster.replace(id, data, params);
  toaster.clear(id);
  toaster.clearAll();

  // manage timers
  toaster.pause();
  toaster.resume();
</script>

Talk about

• flexibility of defining your own toast type

• creating your own component

• toaster methods

• toaster positions

• creating your own transitions

  • turn off default transitions
  • [data-reocurring-toast]
  • use:reoccurrence
  • transition:appear

• creating your own Toaster (use only store)

Everything you need to build a Svelte library, powered by create-svelte.

Read more about creating a library in the docs.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

Building

To build your library:

npm run package

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish