Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

1.8 KB
Raw Blame
/**
 * Browser Notification API wrapper.
 *
 * Requests permission on first call to `requestNotificationPermission()`
 * and shows native notifications via `showBrowserNotification()`.
 *
 * Falls back to a no-op when:
 * - The Notification API is unavailable (e.g. SSR / insecure context).
 * - The user has denied permission.
 * - The tab is currently focused (the in-app toast handles that case).
 */

/**
 * Ask for Notification permission. Should be called early (e.g.
 * dashboard mount) so that subsequent notifications can fire.
 *
 * Resolves to the resulting `NotificationPermission` string.
 */
export const requestNotificationPermission =
  async (): Promise<NotificationPermission> => {
    if (typeof Notification === "undefined") {
      return "denied";
    }
    if (Notification.permission === "granted") {
      return "granted";
    }
    if (Notification.permission === "denied") {
      return "denied";
    }
    // "default" — ask the user.
    return Notification.requestPermission();
  };

/**
 * Show a native browser notification.
 *
 * Will silently no-op when:
 * - Permission hasn't been granted.
 * - The tab is currently focused, unless `showWhenFocused` is true.
 */
export const showBrowserNotification = (
  title: string,
  options?: NotificationOptions & { showWhenFocused?: boolean }
) => {
  if (typeof Notification === "undefined") {
    return;
  }
  if (Notification.permission !== "granted") {
    return;
  }
  // Skip when the user is already looking at the page — the in-app
  // toast handles that case.
  if (options?.showWhenFocused !== true && document.hasFocus()) {
    return;
  }
  const { showWhenFocused, ...notificationOptions } = options ?? {};
  void showWhenFocused;
  const notification = new Notification(title, notificationOptions);
  notification.onclick = () => {
    window.focus();
    notification.close();
  };
};