global-toasts.tsx 3.1 KB

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