Use Toast

Open-code aq-ui React hook for Use Toast.

Installation

pnpm dlx aq-ui@alpha add use-toast

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useToast } from "@/hooks/use-toast"

const result = useToast()

ToastController

interfaceSource L16

Type contract for ToastController.

interface ToastController<Data extends object>

Members

Name	Type
`show`	`(options: ToastManagerAddOptions<Data>) => string`
`success`	`(input: ToastInput<Data>) => string`
`info`	`(input: ToastInput<Data>) => string`
`warning`	`(input: ToastInput<Data>) => string`
`error`	`(input: ToastInput<Data>) => string`
`loading`	`(input: ToastInput<Data>) => string`
`update`	`(id: string, options: ToastManagerUpdateOptions<Data>) => void`
`dismiss`	`(id?: string) => void`
`promise`	`<Value>( promise: Promise<Value>, options: ToastManagerPromiseOptions<Value, Data> ) => Promise<Value>`

ToastInput

typeSource L13

Type contract for ToastInput.

type ToastInput<Data extends object> = React.ReactNode | ToastManagerAddOptions<Data>

useToast

functionSource L45

Open-code aq-ui React hook for Use Toast.

function useToast<Data extends object = Record<string, unknown>>(manager: ToastManager<Data> = defaultToastManager as ToastManager<Data>): ToastController<Data>

Returns: ToastController<Data>

Parameters

Name	Type	Default
`manager?`	`ToastManager<Data>`	`defaultToastManager as ToastManager<Data>`

const result = useToast()

Registry dependencies

toast

Package dependencies

@base-ui/react@^1.7.0

Files

hooks/use-toast.ts