settings-modal-context.tsx 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. import { createContext, FC, useContext, useMemo, useState } from 'react'
  2. import { useLayoutContext } from '@/shared/context/layout-context'
  3. import AutoCloseBracketsSetting from '@/features/settings/components/editor-settings/auto-close-brackets-setting'
  4. import AutoCompleteSetting from '@/features/settings/components/editor-settings/auto-complete-setting'
  5. import CodeCheckSetting from '@/features/settings/components/editor-settings/code-check-setting'
  6. import PreviewTabsSetting from '@/features/settings/components/editor-settings/preview-tabs-setting'
  7. import KeybindingSetting from '@/features/settings/components/editor-settings/keybinding-setting'
  8. import PDFViewerSetting from '@/features/settings/components/editor-settings/pdf-viewer-setting'
  9. import importOverleafModules from '../../../../macros/import-overleaf-module.macro'
  10. import SpellCheckSetting from '@/features/settings/components/editor-settings/spell-check-setting'
  11. import DictionarySetting from '@/features/settings/components/editor-settings/dictionary-setting'
  12. import { useTranslation } from 'react-i18next'
  13. import BreadcrumbsSetting from '@/features/settings/components/editor-settings/breadcrumbs-setting'
  14. import MathPreviewSetting from '@/features/settings/components/editor-settings/math-preview-setting'
  15. import RootDocumentSetting from '@/features/settings/components/compiler-settings/root-document-setting'
  16. import CompilerSetting from '@/features/settings/components/compiler-settings/compiler-setting'
  17. import ImageNameSetting from '@/features/settings/components/compiler-settings/image-name-setting'
  18. import DraftSetting from '@/features/settings/components/compiler-settings/draft-setting'
  19. import StopOnFirstErrorSetting from '@/features/settings/components/compiler-settings/stop-on-first-error-setting'
  20. import AutoCompileSetting from '@/features/settings/components/compiler-settings/auto-compile-setting'
  21. import OverallThemeSetting from '@/features/settings/components/appearance-settings/overall-theme-setting'
  22. import EditorThemeSetting from '@/features/settings/components/appearance-settings/editor-theme-setting'
  23. import FontSizeSetting from '@/features/settings/components/appearance-settings/font-size-setting'
  24. import LineHeightSetting from '@/features/settings/components/appearance-settings/line-height-setting'
  25. import FontFamilySetting from '@/features/settings/components/appearance-settings/font-family-setting'
  26. import { AvailableUnfilledIcon } from '@/shared/components/material-icon'
  27. import { EditorLeftMenuProvider } from '@/features/editor-left-menu/components/editor-left-menu-context'
  28. import DarkModePdfSetting from '@/features/settings/components/appearance-settings/dark-mode-pdf-setting'
  29. import { useProjectSettingsContext } from '@/features/editor-left-menu/context/project-settings-context'
  30. import { useFeatureFlag } from '@/shared/context/split-test-context'
  31. import ProjectNotificationsSetting from '@/features/settings/components/editor-settings/project-notifications-setting'
  32. import getMeta from '@/utils/meta'
  33. const [referenceSearchSettingModule] = importOverleafModules(
  34. 'referenceSearchSetting'
  35. )
  36. const ReferenceSearchSetting = referenceSearchSettingModule?.import.default
  37. type Setting = {
  38. key: string
  39. component: React.ReactNode
  40. hidden?: boolean
  41. }
  42. type SettingsSection = {
  43. title?: string
  44. key: string
  45. settings: Setting[]
  46. }
  47. export type SettingsTab = {
  48. key: string
  49. icon: AvailableUnfilledIcon
  50. sections: SettingsSection[]
  51. title: string
  52. hidden?: boolean
  53. }
  54. type SettingsLink = {
  55. key: string
  56. icon: AvailableUnfilledIcon
  57. href: string
  58. title: string
  59. hidden?: boolean
  60. }
  61. export type SettingsEntry = SettingsLink | SettingsTab
  62. type SettingsModalState = {
  63. show: boolean
  64. setShow: (shown: boolean) => void
  65. activeTab: string | null | undefined
  66. setActiveTab: (tab: string | null | undefined) => void
  67. settingsTabs: SettingsEntry[]
  68. settingToTabMap: Map<string, string>
  69. }
  70. export const SettingsModalContext = createContext<
  71. SettingsModalState | undefined
  72. >(undefined)
  73. export const SettingsModalProvider: FC<React.PropsWithChildren> = ({
  74. children,
  75. }) => {
  76. const { t } = useTranslation()
  77. const { isOverleaf } = getMeta('ol-ExposedSettings')
  78. const { overallTheme } = useProjectSettingsContext()
  79. // TODO ide-redesign-cleanup: Rename this field and move it directly into this context
  80. const { leftMenuShown, setLeftMenuShown } = useLayoutContext()
  81. const hasEmailNotifications = useFeatureFlag('email-notifications')
  82. const hasEditorTabs = useFeatureFlag('editor-tabs')
  83. const allSettingsTabs: SettingsEntry[] = useMemo(
  84. () => [
  85. {
  86. key: 'editor',
  87. title: t('editor'),
  88. icon: 'code',
  89. sections: [
  90. {
  91. key: 'general',
  92. settings: [
  93. {
  94. key: 'autoComplete',
  95. component: <AutoCompleteSetting />,
  96. },
  97. {
  98. key: 'autoPairDelimiters',
  99. component: <AutoCloseBracketsSetting />,
  100. },
  101. {
  102. key: 'syntaxValidation',
  103. component: <CodeCheckSetting />,
  104. },
  105. {
  106. key: 'previewTabs',
  107. component: <PreviewTabsSetting />,
  108. hidden: !hasEditorTabs,
  109. },
  110. {
  111. key: 'mode',
  112. component: <KeybindingSetting />,
  113. },
  114. {
  115. key: 'pdfViewer',
  116. component: <PDFViewerSetting />,
  117. },
  118. {
  119. key: 'write-and-cite-settings',
  120. component: <ReferenceSearchSetting />,
  121. hidden: !ReferenceSearchSetting,
  122. },
  123. ],
  124. },
  125. {
  126. key: 'spellcheck',
  127. title: t('spellcheck'),
  128. settings: [
  129. {
  130. key: 'spellCheckLanguage',
  131. component: <SpellCheckSetting />,
  132. },
  133. {
  134. key: 'dictionary-settings',
  135. component: <DictionarySetting />,
  136. },
  137. ],
  138. },
  139. {
  140. key: 'tools',
  141. title: t('tools'),
  142. settings: [
  143. {
  144. key: 'breadcrumbs-setting',
  145. component: <BreadcrumbsSetting />,
  146. },
  147. {
  148. key: 'mathPreview',
  149. component: <MathPreviewSetting />,
  150. },
  151. ],
  152. },
  153. ],
  154. },
  155. {
  156. key: 'compiler',
  157. title: t('compiler'),
  158. icon: 'picture_as_pdf',
  159. sections: [
  160. {
  161. key: 'general',
  162. settings: [
  163. {
  164. key: 'rootDocId',
  165. component: <RootDocumentSetting />,
  166. },
  167. {
  168. key: 'compiler',
  169. component: <CompilerSetting />,
  170. },
  171. {
  172. key: 'imageName',
  173. component: <ImageNameSetting />,
  174. },
  175. {
  176. key: 'draft',
  177. component: <DraftSetting />,
  178. },
  179. {
  180. key: 'stopOnFirstError',
  181. component: <StopOnFirstErrorSetting />,
  182. },
  183. {
  184. key: 'autoCompile',
  185. component: <AutoCompileSetting />,
  186. },
  187. ],
  188. },
  189. ],
  190. },
  191. {
  192. key: 'appearance',
  193. title: t('appearance'),
  194. icon: 'brush',
  195. sections: [
  196. {
  197. key: 'general',
  198. settings: [
  199. {
  200. key: 'overallTheme',
  201. component: <OverallThemeSetting />,
  202. },
  203. {
  204. key: 'editorTheme',
  205. component: <EditorThemeSetting />,
  206. },
  207. {
  208. key: 'pdfDarkMode',
  209. component: <DarkModePdfSetting />,
  210. hidden: overallTheme === 'light-',
  211. },
  212. {
  213. key: 'fontSize',
  214. component: <FontSizeSetting />,
  215. },
  216. {
  217. key: 'fontFamily',
  218. component: <FontFamilySetting />,
  219. },
  220. {
  221. key: 'lineHeight',
  222. component: <LineHeightSetting />,
  223. },
  224. ],
  225. },
  226. ],
  227. },
  228. {
  229. key: 'project_notifications',
  230. title: t('project_notifications'),
  231. icon: 'notifications' as const,
  232. sections: [
  233. {
  234. key: 'general',
  235. settings: [
  236. {
  237. key: 'projectNotifications',
  238. component: <ProjectNotificationsSetting />,
  239. },
  240. ],
  241. },
  242. ],
  243. hidden: !hasEmailNotifications,
  244. },
  245. {
  246. key: 'account_settings',
  247. title: t('account_settings'),
  248. icon: 'settings',
  249. href: '/user/settings',
  250. },
  251. {
  252. key: 'subscription',
  253. title: t('subscription'),
  254. icon: 'account_balance',
  255. href: '/user/subscription',
  256. hidden: !isOverleaf,
  257. },
  258. ],
  259. [t, overallTheme, hasEmailNotifications, isOverleaf, hasEditorTabs]
  260. )
  261. const settingsTabs = useMemo(
  262. () => allSettingsTabs.filter(tab => !tab.hidden),
  263. [allSettingsTabs]
  264. )
  265. const settingToTabMap = useMemo(() => {
  266. const map = new Map<string, string>()
  267. settingsTabs
  268. .filter(t => 'sections' in t)
  269. .forEach(tab => {
  270. tab.sections.forEach(section => {
  271. section.settings.forEach(setting => {
  272. map.set(setting.key, tab.key)
  273. })
  274. })
  275. })
  276. return map
  277. }, [settingsTabs])
  278. const [activeTab, setActiveTab] = useState<string | null | undefined>(
  279. settingsTabs[0]?.key
  280. )
  281. const value = useMemo(
  282. () => ({
  283. show: leftMenuShown,
  284. setShow: setLeftMenuShown,
  285. activeTab,
  286. setActiveTab,
  287. settingsTabs,
  288. settingToTabMap,
  289. }),
  290. [
  291. leftMenuShown,
  292. setLeftMenuShown,
  293. activeTab,
  294. setActiveTab,
  295. settingsTabs,
  296. settingToTabMap,
  297. ]
  298. )
  299. return (
  300. // TODO ide-redesign-cleanup: Merge <EditorLeftMenuProvider> into <SettingsModalProvider>
  301. <EditorLeftMenuProvider>
  302. <SettingsModalContext.Provider value={value}>
  303. {children}
  304. </SettingsModalContext.Provider>
  305. </EditorLeftMenuProvider>
  306. )
  307. }
  308. export const useSettingsModalContext = () => {
  309. const value = useContext(SettingsModalContext)
  310. if (!value) {
  311. throw new Error(
  312. `useSettingsModalContext is only available inside SettingsModalProvider`
  313. )
  314. }
  315. return value
  316. }