react-hot-toast ported to the
Octane renderer. The package tracks the
published [email protected] API and behavior: the callable toast API
and its success, error, loading, custom, promise, dismiss and
remove variants, Toaster, ToastBar, ToastIcon, the icon components,
multiple toasters, pausing on hover, and the headless useToaster hook.
npm install @octanejs/hot-toast
pnpm add @octanejs/hot-toastMount one toaster near the root of the application, then call toast from any
event handler or module:
import toast, { Toaster } from '@octanejs/hot-toast';
export function App() {
return (
<main>
<button onClick={() => toast.success('Saved')}>Save</button>
<Toaster position="top-right" />
</main>
);
}
toast.promise follows a promise through loading, success and error:
toast.promise(saveSettings(settings), {
loading: 'Saving…',
success: 'Settings saved',
error: (error) => `Could not save: ${error.message}`,
});Render your own toast UI with the Toaster render prop and ToastBar, or drop
the bundled UI entirely and build on the headless entry:
import { toast, useToaster } from '@octanejs/hot-toast/headless';- The
Toasterpauses its timers on the nativemouseenterandmouseleaveevents of its container. A real pointer behaves as in React. In tests, fire those events on the[data-rht-toaster]container rather than on a toast. - The port never calls goober's
setup(), so an application that also uses goober keeps its own pragma. - The root and
/headlessentries share one toast store. Upstream bundles them separately, each with its own store. - Renderables, styles and refs use Octane's types (
ElementDescriptor,CSSProperties, refs as props).
Class names and the injected stylesheet are the ones [email protected]
ships, so CSS that targets them keeps working.
Toaster renders on the server without browser globals, and toasts already in
the store render with it. goober collects the generated rules on the server;
inline them with extractCss() from goober. On the client, hydrateRoot
adopts the server markup.
See UPSTREAM.md. Ported code keeps the upstream MIT license
in LICENSE.upstream.