codemirror-toolbar.tsx 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. import {
  2. ElementType,
  3. memo,
  4. useCallback,
  5. useEffect,
  6. useRef,
  7. useState,
  8. } from 'react'
  9. import { createPortal } from 'react-dom'
  10. import {
  11. useCodeMirrorStateContext,
  12. useCodeMirrorViewContext,
  13. } from './codemirror-context'
  14. import { useResizeObserver } from '@/shared/hooks/use-resize-observer'
  15. import { ToolbarItems } from './toolbar/toolbar-items'
  16. import { ToolbarOverflow } from './toolbar/overflow'
  17. import useDropdown from '../../../shared/hooks/use-dropdown'
  18. import { getPanel } from '@codemirror/view'
  19. import { createToolbarPanel } from '../extensions/toolbar/toolbar-panel'
  20. import EditorSwitch from './editor-switch'
  21. import ReviewModeSwitcher from '@/features/review-panel/components/review-mode-switcher'
  22. import SwitchToPDFButton from './switch-to-pdf-button'
  23. import { DetacherSynctexControl } from '../../pdf-preview/components/detach-synctex-control'
  24. import DetachCompileButtonWrapper from '../../pdf-preview/components/detach-compile-button-wrapper'
  25. import { isVisual } from '../extensions/visual/visual'
  26. import { language } from '@codemirror/language'
  27. import { minimumListDepthForSelection } from '../utils/tree-operations/ancestors'
  28. import { debugConsole } from '@/utils/debugging'
  29. import { useTranslation } from 'react-i18next'
  30. import { ToggleSearchButton } from '@/features/source-editor/components/toolbar/toggle-search-button'
  31. import ReviewPanelHeader from '@/features/review-panel/components/review-panel-header'
  32. import useReviewPanelLayout from '@/features/review-panel/hooks/use-review-panel-layout'
  33. import Breadcrumbs from '@/features/source-editor/extensions/breadcrumbs'
  34. import classNames from 'classnames'
  35. import { useUserSettingsContext } from '@/shared/context/user-settings-context'
  36. import { useFeatureFlag } from '@/shared/context/split-test-context'
  37. import { useProjectContext } from '@/shared/context/project-context'
  38. import importOverleafModules from '../../../../macros/import-overleaf-module.macro'
  39. const sourceEditorToolbarComponents = importOverleafModules(
  40. 'sourceEditorToolbarComponents'
  41. ) as { import: { default: ElementType }; path: string }[]
  42. const sourceEditorToolbarEndButtons = importOverleafModules(
  43. 'sourceEditorToolbarEndButtons'
  44. ) as { import: { default: ElementType }; path: string }[]
  45. export const CodeMirrorToolbar = () => {
  46. const view = useCodeMirrorViewContext()
  47. const panel = getPanel(view, createToolbarPanel)
  48. if (!panel) {
  49. return null
  50. }
  51. return createPortal(<Toolbar />, panel.dom)
  52. }
  53. const Toolbar = memo(function Toolbar() {
  54. const { t } = useTranslation()
  55. const state = useCodeMirrorStateContext()
  56. const view = useCodeMirrorViewContext()
  57. const {
  58. userSettings: { breadcrumbs },
  59. } = useUserSettingsContext()
  60. const visualPreviewEnabled = useFeatureFlag('visual-preview')
  61. const { features } = useProjectContext()
  62. const [overflowed, setOverflowed] = useState(false)
  63. const overflowedItemsRef = useRef<Set<string>>(new Set())
  64. const languageName = state.facet(language)?.name
  65. const visual = isVisual(view)
  66. const listDepth = minimumListDepthForSelection(state)
  67. const { showHeader: showReviewPanelHeader } = useReviewPanelLayout()
  68. const {
  69. open: overflowOpen,
  70. onToggle: setOverflowOpen,
  71. ref: overflowRef,
  72. } = useDropdown()
  73. const buildOverflow = useCallback(
  74. (element: Element) => {
  75. debugConsole.log('recalculating toolbar overflow')
  76. setOverflowOpen(false)
  77. setOverflowed(true)
  78. overflowedItemsRef.current = new Set()
  79. const buttonGroups = [
  80. ...element.querySelectorAll<HTMLDivElement>('[data-overflow]'),
  81. ].reverse()
  82. // restore all the overflowed items
  83. for (const buttonGroup of buttonGroups) {
  84. buttonGroup.classList.remove('overflow-hidden')
  85. }
  86. // find all the available items
  87. for (const buttonGroup of buttonGroups) {
  88. if (element.scrollWidth <= element.clientWidth) {
  89. break
  90. }
  91. // add this item to the overflow
  92. overflowedItemsRef.current.add(buttonGroup.dataset.overflow!)
  93. buttonGroup.classList.add('overflow-hidden')
  94. }
  95. setOverflowed(overflowedItemsRef.current.size > 0)
  96. },
  97. [setOverflowOpen]
  98. )
  99. // calculate overflow when the container resizes
  100. const { elementRef, resizeRef } = useResizeObserver(buildOverflow)
  101. // calculate overflow when `languageName` or `visual` change
  102. useEffect(() => {
  103. if (resizeRef.current) {
  104. buildOverflow(resizeRef.current.element)
  105. }
  106. }, [buildOverflow, languageName, resizeRef, visual])
  107. // calculate overflow when buttons change
  108. const observerRef = useRef<MutationObserver | null>(null)
  109. const handleButtons = useCallback(
  110. (node: HTMLDivElement) => {
  111. if (!('MutationObserver' in window)) {
  112. return
  113. }
  114. if (node) {
  115. observerRef.current = new MutationObserver(() => {
  116. if (resizeRef.current) {
  117. buildOverflow(resizeRef.current.element)
  118. }
  119. })
  120. observerRef.current.observe(node, { childList: true })
  121. } else if (observerRef.current) {
  122. observerRef.current.disconnect()
  123. }
  124. },
  125. [buildOverflow, resizeRef]
  126. )
  127. // calculate overflow when active element changes to/from inside a table
  128. const insideTable = document.activeElement?.closest(
  129. '.table-generator-help-modal,.table-generator,.table-generator-width-modal'
  130. )
  131. useEffect(() => {
  132. if (resizeRef.current) {
  133. buildOverflow(resizeRef.current.element)
  134. }
  135. }, [buildOverflow, insideTable, resizeRef])
  136. const showActions = !state.readOnly && !insideTable
  137. return (
  138. <>
  139. {showReviewPanelHeader && <ReviewPanelHeader />}
  140. <div
  141. id="ol-cm-toolbar-wrapper"
  142. className={classNames('ol-cm-toolbar-wrapper', {
  143. 'ol-cm-toolbar-wrapper-indented': showReviewPanelHeader,
  144. })}
  145. >
  146. <div
  147. role="toolbar"
  148. aria-label={t('toolbar_editor')}
  149. className="ol-cm-toolbar toolbar-editor"
  150. ref={elementRef}
  151. >
  152. {showActions && (
  153. <ToolbarItems
  154. state={state}
  155. languageName={languageName}
  156. visual={visual}
  157. listDepth={listDepth}
  158. />
  159. )}
  160. <div className="ol-cm-toolbar-button-group ol-cm-toolbar-stretch">
  161. {showActions && (
  162. <ToolbarOverflow
  163. overflowed={overflowed}
  164. overflowOpen={overflowOpen}
  165. setOverflowOpen={setOverflowOpen}
  166. overflowRef={overflowRef}
  167. >
  168. <ToolbarItems
  169. state={state}
  170. overflowed={overflowedItemsRef.current}
  171. languageName={languageName}
  172. visual={visual}
  173. listDepth={listDepth}
  174. />
  175. </ToolbarOverflow>
  176. )}
  177. </div>
  178. <div
  179. className="ol-cm-toolbar-button-group ol-cm-toolbar-end"
  180. ref={handleButtons}
  181. >
  182. {!visualPreviewEnabled && <EditorSwitch />}
  183. {features.trackChangesVisible && <ReviewModeSwitcher />}
  184. {sourceEditorToolbarEndButtons.map(
  185. ({ import: { default: Component }, path }) => (
  186. <Component key={path} />
  187. )
  188. )}
  189. <ToggleSearchButton state={state} />
  190. <SwitchToPDFButton />
  191. <DetacherSynctexControl />
  192. <DetachCompileButtonWrapper />
  193. </div>
  194. </div>
  195. {sourceEditorToolbarComponents.map(
  196. ({ import: { default: Component }, path }) => (
  197. <Component key={path} />
  198. )
  199. )}
  200. {breadcrumbs && <Breadcrumbs />}
  201. </div>
  202. </>
  203. )
  204. })