useToast() — ui Function Reference

Architecture documentation for the useToast() function in use-toast.ts from the ui codebase.

Function typescript ComponentRegistry ChartRegistry calls 1

Entity Profile

ComponentRegistry→ ChartRegistry→ useToast() — ui Function Reference

Dependency Diagram

graph TD
  433da4aa_9c7c_eb9c_bd33_bb9dbb7c4d28["useToast()"]
  bba373ff_472d_b9de_12be_a7a606cb2977["use-toast.ts"]
  433da4aa_9c7c_eb9c_bd33_bb9dbb7c4d28 -->|defined in| bba373ff_472d_b9de_12be_a7a606cb2977
  23a8ce30_00a5_617f_ac96_6badbe20ecf5["dispatch()"]
  433da4aa_9c7c_eb9c_bd33_bb9dbb7c4d28 -->|calls| 23a8ce30_00a5_617f_ac96_6badbe20ecf5
  style 433da4aa_9c7c_eb9c_bd33_bb9dbb7c4d28 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

deprecated/www/registry/new-york/hooks/use-toast.ts lines 174–192

function useToast() {
  const [state, setState] = React.useState<State>(memoryState)

  React.useEffect(() => {
    listeners.push(setState)
    return () => {
      const index = listeners.indexOf(setState)
      if (index > -1) {
        listeners.splice(index, 1)
      }
    }
  }, [state])

  return {
    ...state,
    toast,
    dismiss: (toastId?: string) => dispatch({ type: "DISMISS_TOAST", toastId }),
  }
}