signal-desktop/ts/components/Toast.tsx

// Copyright 2021-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only

import type { KeyboardEvent, MouseEvent, ReactNode } from 'react';
import React, { memo, useEffect } from 'react';
import classNames from 'classnames';
import { createPortal } from 'react-dom';
import { useRestoreFocus } from '../hooks/useRestoreFocus';
import { clearTimeoutIfNecessary } from '../util/clearTimeoutIfNecessary';

export type PropsType = {
  autoDismissDisabled?: boolean;
  children: ReactNode;
  className?: string;
  disableCloseOnClick?: boolean;
  onClose: () => unknown;
  timeout?: number;
  toastAction?: {
    label: string;
    onClick: () => unknown;
  };
  style?: React.CSSProperties;
};

export const Toast = memo(
  ({
    autoDismissDisabled = false,
    children,
    className,
    disableCloseOnClick = false,
    onClose,
    style,
    timeout = 8000,
    toastAction,
  }: PropsType): JSX.Element | null => {
    const [root, setRoot] = React.useState<HTMLElement | null>(null);
    const [focusRef] = useRestoreFocus();

    useEffect(() => {
      const div = document.createElement('div');
      document.body.appendChild(div);
      setRoot(div);

      return () => {
        document.body.removeChild(div);
        setRoot(null);
      };
    }, []);

    useEffect(() => {
      if (!root || autoDismissDisabled) {
        return;
      }

      const timeoutId = setTimeout(onClose, timeout);

      return () => {
        clearTimeoutIfNecessary(timeoutId);
      };
    }, [autoDismissDisabled, onClose, root, timeout]);

    return root
      ? createPortal(
          <div
            aria-live="assertive"
            className={classNames('Toast', className)}
            onClick={() => {
              if (!disableCloseOnClick) {
                onClose();
              }
            }}
            onKeyDown={(ev: KeyboardEvent<HTMLDivElement>) => {
              if (ev.key === 'Enter' || ev.key === ' ') {
                if (!disableCloseOnClick) {
                  onClose();
                }
              }
            }}
            role="button"
            tabIndex={0}
            style={style}
          >
            <div className="Toast__content">{children}</div>
            {toastAction && (
              <div
                className="Toast__button"
                onClick={(ev: MouseEvent<HTMLDivElement>) => {
                  ev.stopPropagation();
                  ev.preventDefault();
                  toastAction.onClick();
                  onClose();
                }}
                onKeyDown={(ev: KeyboardEvent<HTMLDivElement>) => {
                  if (ev.key === 'Enter' || ev.key === ' ') {
                    ev.stopPropagation();
                    ev.preventDefault();
                    toastAction.onClick();
                    onClose();
                  }
                }}
                ref={focusRef}
                role="button"
                tabIndex={0}
              >
                {toastAction.label}
              </div>
            )}
          </div>,
          root
        )
      : null;
  }
);