All files / client/src/hooks use-toast.ts

95.71% Statements 67/70
75% Branches 27/36
85.71% Functions 18/21
95.52% Lines 64/67

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239        14x   14x   14x   14x   14x                           14x             14x     15x 15x                                                     14x   14x 7x 1x     6x 3x 3x           6x     14x 26x   15x           1x     1x         7x       7x 5x   2x 2x       7x     7x                   3x           3x   3x         14x   14x     26x 26x 26x                             15x       15x     15x 1x       15x     15x 15x 15x 15x 15x 3x 1x   2x 2x               15x               1x         15x               40x   40x 40x       40x 40x 40x 40x 40x         40x         2x          
import * as React from "react";
 
import type { ToastActionElement, ToastProps } from "@/components/ui/toast";
 
const TOAST_LIMIT = 1;
// Default visible duration for toasts (ms)
const DEFAULT_TOAST_DURATION = 1000;
// Delay before actually removing toast from state (allow animations) (ms)
const TOAST_REMOVE_DELAY = 3500;
 
const ARE_TOASTS_DISABLED = import.meta.env.VITE_DISABLE_TOASTS === "true";
 
const noopToastResponse = {
  id: "",
  dismiss: () => {},
  update: (_props: Toast) => {},
};
 
type ToasterToast = ToastProps & {
  id: string;
  title?: React.ReactNode;
  description?: React.ReactNode;
  action?: ToastActionElement;
};
 
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- used via typeof in ActionType
const actionTypes = {
  ADD_TOAST: "ADD_TOAST",
  UPDATE_TOAST: "UPDATE_TOAST",
  DISMISS_TOAST: "DISMISS_TOAST",
  REMOVE_TOAST: "REMOVE_TOAST",
} as const;
 
let count = 0;
 
function genId() {
  count = (count + 1) % Number.MAX_SAFE_INTEGER;
  return count.toString();
}
 
type ActionType = typeof actionTypes;
 
type Action =
  | {
      type: ActionType["ADD_TOAST"];
      toast: ToasterToast;
    }
  | {
      type: ActionType["UPDATE_TOAST"];
      toast: Partial<ToasterToast>;
    }
  | {
      type: ActionType["DISMISS_TOAST"];
      toastId?: ToasterToast["id"];
    }
  | {
      type: ActionType["REMOVE_TOAST"];
      toastId?: ToasterToast["id"];
    };
 
interface State {
  toasts: ToasterToast[];
}
 
const toastTimeouts = new Map<string, ReturnType<typeof setTimeout>>();
 
const addToRemoveQueue = (toastId: string) => {
  if (toastTimeouts.has(toastId)) {
    return;
  }
 
  const timeout = setTimeout(() => {
    toastTimeouts.delete(toastId);
    dispatch({
      type: "REMOVE_TOAST",
      toastId: toastId,
    });
  }, TOAST_REMOVE_DELAY);
 
  toastTimeouts.set(toastId, timeout);
};
 
const reducer = (state: State, action: Action): State => {
  switch (action.type) {
    case "ADD_TOAST":
      return {
        ...state,
        toasts: [action.toast, ...state.toasts].slice(0, TOAST_LIMIT),
      };
 
    case "UPDATE_TOAST":
      return {
        ...state,
        toasts: state.toasts.map((t) =>
          t.id === action.toast.id ? { ...t, ...action.toast } : t,
        ),
      };
 
    case "DISMISS_TOAST": {
      const { toastId } = action;
 
      // ! Side effects ! - This could be extracted into a dismissToast() action,
      // but I'll keep it here for simplicity
      if (toastId) {
        addToRemoveQueue(toastId);
      } else {
        state.toasts.forEach((toast) => {
          addToRemoveQueue(toast.id);
        });
      }
 
      return {
        ...state,
        toasts: state.toasts.map((t) =>
          t.id === toastId || toastId === undefined
            ? {
                ...t,
                open: false,
              }
            : t,
        ),
      };
    }
    case "REMOVE_TOAST":
      Iif (action.toastId === undefined) {
        return {
          ...state,
          toasts: [],
        };
      }
      return {
        ...state,
        toasts: state.toasts.filter((t) => t.id !== action.toastId),
      };
  }
};
 
const listeners: Array<(state: State) => void> = [];
 
let memoryState: State = { toasts: [] };
 
function dispatch(action: Action) {
  memoryState = reducer(memoryState, action);
  listeners.forEach((listener) => {
    listener(memoryState);
  });
}
 
type Toast = Omit<ToasterToast, "id">;
 
// exported types used by consumers (eg. editor commands hook)
export type { Toast };
export type ToastFn = (props: Toast) => {
  id: string;
  dismiss: () => void;
  update: (props: Toast) => void;
};
 
function toast({ ...props }: Toast) {
  Iif (ARE_TOASTS_DISABLED) {
    return noopToastResponse;
  }
 
  const id = genId();
 
  // expose a simpler `update` that accepts toast options (without id)
  const update = (props: Toast) =>
    dispatch({
      type: "UPDATE_TOAST",
      toast: { ...props, id },
    });
  const dismiss = () => dispatch({ type: "DISMISS_TOAST", toastId: id });
 
  // Allow overriding the default via localStorage (set by Settings dialog)
  let duration = (props as any).duration ?? DEFAULT_TOAST_DURATION;
  try {
    Eif (globalThis.window !== undefined) {
      const stored = globalThis.localStorage.getItem("unoToastDuration");
      if (stored !== null) {
        if (stored === "infinite") {
          duration = Infinity;
        } else {
          const ms = Number.parseInt(stored, 10);
          if (!Number.isNaN(ms)) duration = ms;
        }
      }
    }
  } catch {
    // ignore localStorage errors
  }
 
  dispatch({
    type: "ADD_TOAST",
    toast: {
      ...props,
      id,
      duration,
      open: true,
      onOpenChange: (open) => {
        Eif (!open) dismiss();
      },
    },
  });
 
  return {
    id: id,
    dismiss,
    update,
  };
}
 
function useToast() {
  const [state, setState] = React.useState<State>(memoryState);
 
  React.useEffect(() => {
    Iif (ARE_TOASTS_DISABLED) {
      return;
    }
 
    listeners.push(setState);
    return () => {
      const index = listeners.indexOf(setState);
      Eif (index > -1) {
        listeners.splice(index, 1);
      }
    };
  }, [state]);
 
  return {
    ...state,
    toast,
    dismiss: ARE_TOASTS_DISABLED
      ? () => {}
      : (toastId?: string) => dispatch({ type: "DISMISS_TOAST", toastId }),
  };
}
 
export { useToast };