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
  2d897442_53b3_81ef_0f85_c25209dee57d["useToast()"]
  0ac37ef4_ee03_7234_1fa3_be05404864ce["use-toast.ts"]
  2d897442_53b3_81ef_0f85_c25209dee57d -->|defined in| 0ac37ef4_ee03_7234_1fa3_be05404864ce
  4cadcb11_5cb9_1eed_a20f_6444ac24ea81["dispatch()"]
  2d897442_53b3_81ef_0f85_c25209dee57d -->|calls| 4cadcb11_5cb9_1eed_a20f_6444ac24ea81
  style 2d897442_53b3_81ef_0f85_c25209dee57d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

deprecated/www/registry/default/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 }),
  }
}