global-toasts.tsx 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. import { OLToast, OLToastProps } from '@/shared/components/ol/ol-toast'
  2. import useEventListener from '@/shared/hooks/use-event-listener'
  3. import { Fragment, memo, ReactElement, useCallback, useState } from 'react'
  4. import { debugConsole } from '@/utils/debugging'
  5. import importOverleafModules from '../../../../macros/import-overleaf-module.macro'
  6. import { OLToastContainer } from '@/shared/components/ol/ol-toast-container'
  7. const moduleGeneratorsImport = importOverleafModules('toastGenerators') as {
  8. import: { default: GlobalToastGeneratorEntry[] }
  9. }[]
  10. const moduleGenerators = moduleGeneratorsImport.map(
  11. ({ import: { default: listEntry } }) => listEntry
  12. )
  13. export type GlobalToastGeneratorEntry = {
  14. key: string
  15. generator: GlobalToastGenerator
  16. }
  17. type GlobalToastGenerator = (
  18. args: Record<string, any>
  19. ) => Omit<OLToastProps, 'onDismiss'>
  20. const GENERATOR_LIST: GlobalToastGeneratorEntry[] = moduleGenerators.flat()
  21. const GENERATOR_MAP: Map<string, GlobalToastGenerator> = new Map(
  22. GENERATOR_LIST.map(({ key, generator }) => [key, generator])
  23. )
  24. let toastCounter = 1
  25. export const GlobalToasts = memo(function GlobalToasts() {
  26. const [toasts, setToasts] = useState<
  27. { component: ReactElement; id: string }[]
  28. >([])
  29. const removeToast = useCallback((id: string) => {
  30. setToasts(current => current.filter(toast => toast.id !== id))
  31. }, [])
  32. const createToast = useCallback(
  33. (id: string, key: string, data: any): ReactElement | null => {
  34. const generator = GENERATOR_MAP.get(key)
  35. if (!generator) {
  36. debugConsole.error('No toast generator found for key:', key)
  37. return null
  38. }
  39. const props = generator(data)
  40. if (!props.autoHide && !props.isDismissible) {
  41. // We don't want any toasts that are not dismissible and don't auto-hide
  42. props.isDismissible = true
  43. }
  44. if (props.autoHide && !props.isDismissible && props.delay !== undefined) {
  45. // If the toast is auto-hiding but not dismissible, we need to make sure the delay is not too long
  46. props.delay = Math.min(props.delay, 60_000)
  47. }
  48. return <OLToast {...props} onDismiss={() => removeToast(id)} />
  49. },
  50. [removeToast]
  51. )
  52. const addToast = useCallback(
  53. (key: string, data?: any) => {
  54. const id = `toast-${toastCounter++}`
  55. const component = createToast(id, key, data)
  56. if (!component) {
  57. return
  58. }
  59. setToasts(current => [...current, { id, component }])
  60. },
  61. [createToast]
  62. )
  63. const showToastListener = useCallback(
  64. (event: CustomEvent) => {
  65. if (!event.detail?.key) {
  66. debugConsole.error('No key provided for toast')
  67. return
  68. }
  69. const { key, ...rest } = event.detail
  70. addToast(key, rest)
  71. },
  72. [addToast]
  73. )
  74. useEventListener('ide:show-toast', showToastListener)
  75. return (
  76. <OLToastContainer className="global-toasts">
  77. {toasts.map(({ component, id }) => (
  78. <Fragment key={id}>{component}</Fragment>
  79. ))}
  80. </OLToastContainer>
  81. )
  82. })