toast

The toast object is the primary API for interacting with NativeToast. Import it once and use it anywhere.

import { toast } from '@ncrft/native-toast';

Methods

toast(message, options?)

Generic blank toast — no built-in icon.

Returns: string — the toast ID

const id = toast('Hello world');

toast.success(message, options?)

Success toast with animated green checkmark SVG.

Returns: string — the toast ID

toast.error(message, options?)

Error toast with animated red X-mark SVG.

Returns: string — the toast ID

toast.loading(message, options?)

Loading toast with native ActivityIndicator spinner. Never auto-dismisses.

Returns: string — the toast ID

const id = toast.loading('Uploading…');
// later:
toast.dismiss(id);

toast.custom(message, options?)

Custom toast — no built-in icon. Message can be any ReactNode.

Returns: string — the toast ID

toast.dismiss(toastId?)

Triggers exit animation, then removes the toast after the cleanup delay.

Returns: void

toast.dismiss('t_3');   // dismiss specific toast
toast.dismiss();        // dismiss all

toast.remove(toastId?)

Immediately removes a toast with no exit animation.

Returns: void

toast.promise(promise, messages, options?)

Shows a loading toast, then transitions to success or error based on promise resolution.

Returns: void

toast.promise(
  fetch('/api/data'),
  {
    loading: 'Fetching…',
    success: 'Data loaded!',
    error: 'Fetch failed',
  },
  { id: 'fetch-toast' }
);

Toast IDs

• Auto-incrementing: t_1, t_2, t_3, …
• Custom: pass id in options → toast.loading('…', { id: 'my-id' })

Upsert Behavior

Creating a toast with an existing id updates the existing toast instead of creating a duplicate. This is useful for promise flows:

const id = 'upload';

toast.loading('Uploading…', { id });
// Later, same ID → updates the existing toast:
toast.success('Upload complete!', { id });