global-toasts.tsx 3.4 KB

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