toasterhea 🍞

Promises with UI.

About

toasterhea lets you render React components as toast-like UI elements that behave like Promises.

This makes it easy to implement async flows such as modals, confirmation dialogs, or multi-step wizards — all using your own components and styling.

---

Why

React doesn’t have a built-in way to tie UI directly to promise resolution. If you want something like:

const confirmed = await confirmDialog('Are you sure?')

...you’re left building your own state machine. toasterhea handles that for you, using components as promise interfaces.

---

Installation

npm install toasterhea

Note: react and eventemitter3 are required peer dependencies.

---

Example

import { toaster } from 'toasterhea'

const Foo = toaster()

// Step 1: Create a component that accepts resolve/reject
function Confirm({ resolve }: { resolve: (value: boolean) => void }) {
    return (
        <div className="toast">
            <p>Are you sure?</p>
            <button onClick={() => resolve(true)}>Yes</button>
            <button onClick={() => resolve(false)}>Cancel</button>
        </div>
    )
}

// Step 2: Wrap it with create
const confirm = Foo.create(Confirm).pop

// Step 3: Use it like a promise. Anywhere!
const result = await confirm()

---

Rendering

Render the toast container in your app:

function App() {
    return (
        <>
            <Foo.Container />
        </>
    )
}

The container supports inline rendering:

<Foo.Container inline />

---

Toast Component Requirements

Your toastable component must:

• Be a function component
• Accept resolve(value?) and/or reject(reason?) props
• Call one of them to settle

Additional props can be passed through .pop(props).

function ExampleToast({
    resolve,
    reject,
    name,
}: {
    resolve: (result: string) => void
    reject: () => void
    name: string
}) {
    /* ... */
}

---

API

toaster()

Creates a new toaster instance.

const t = toaster()

Returns:

• Container: React component to render active toasts
• create(component): wraps a component into { pop, discard }
• hasActive(component?): check if any toast is active
• on(), off(): subscribe to update events

---

.create(component)

Wraps a component and returns { pop, discard }:

• pop(props?): shows the component and returns a promise
• discard(): programmatically cancel the toast

The props passed to pop() will be merged with { resolve, reject }.

---

useDisposeEffect

Allows components to delay disposal for animation or async work:

useDisposeEffect((finish) => {
    animateOut().then(finish)
})

Must call finish() when done.

---

ToastCancelled

An error class representing user cancellation. Useful for flow control.

import { isCancelledByHost } from 'toasterhea'

try {
    await toast.pop()
} catch (e) {
    if (isCancelledByHost(e)) {
        // user cancelled
    }
}

---

Wizard Pattern Example

Chain multiple steps:

const confirmName = Foo.create(NameStep)
const confirmAvatar = Foo.create(AvatarStep)

try {
    const name = await confirmName.pop()
    const avatar = await confirmAvatar.pop()
    // done
} catch (e) {
    if (isCancelledByHost(e)) {
        // user bailed
    }
}

---

License

MIT. Use responsibly. Don’t forget to resolve your promises.