user-settings-context.tsx 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. import {
  2. createContext,
  3. useContext,
  4. useMemo,
  5. Dispatch,
  6. SetStateAction,
  7. FC,
  8. useState,
  9. useEffect,
  10. } from 'react'
  11. import { UserSettings } from '../../../../types/user-settings'
  12. import getMeta from '@/utils/meta'
  13. import customLocalStorage from '@/infrastructure/local-storage'
  14. import { getLegacyWriteAndCiteMigration } from '../utils/write-and-cite-settings-migration'
  15. import { saveUserSettings } from '@/features/editor-left-menu/utils/api'
  16. export const defaultSettings: UserSettings = {
  17. pdfViewer: 'pdfjs',
  18. autoComplete: true,
  19. autoPairDelimiters: true,
  20. syntaxValidation: false,
  21. previewTabs: false,
  22. editorTheme: 'textmate',
  23. editorDarkTheme: 'overleaf_dark',
  24. editorLightTheme: 'textmate',
  25. overallTheme: '',
  26. mode: 'default',
  27. fontSize: 12,
  28. fontFamily: 'monaco',
  29. lineHeight: 'normal',
  30. mathPreview: true,
  31. referencesSearchMode: 'advanced',
  32. breadcrumbs: true,
  33. nonBlinkingCursor: false,
  34. darkModePdf: false,
  35. zotero: {
  36. enabled: true,
  37. groups: [],
  38. disablePersonalLibrary: false,
  39. },
  40. mendeley: {
  41. enabled: true,
  42. groups: [],
  43. disablePersonalLibrary: false,
  44. },
  45. papers: {
  46. enabled: true,
  47. groups: [],
  48. disablePersonalLibrary: false,
  49. },
  50. }
  51. type UserSettingsContextValue = {
  52. userSettings: UserSettings
  53. setUserSettings: Dispatch<
  54. SetStateAction<UserSettingsContextValue['userSettings']>
  55. >
  56. }
  57. export const UserSettingsContext = createContext<
  58. UserSettingsContextValue | undefined
  59. >(undefined)
  60. export const UserSettingsProvider: FC<React.PropsWithChildren> = ({
  61. children,
  62. }) => {
  63. const [userSettings, setUserSettings] = useState<UserSettings>(
  64. () => getMeta('ol-userSettings') || defaultSettings
  65. )
  66. useEffect(() => {
  67. const { patch, keysToRemove } = getLegacyWriteAndCiteMigration(userSettings)
  68. if (Object.keys(patch).length === 0) {
  69. keysToRemove.forEach(customLocalStorage.removeItem)
  70. return
  71. }
  72. Promise.all(
  73. Object.entries(patch).map(([key, value]) =>
  74. saveUserSettings(
  75. key as keyof Pick<UserSettings, 'mendeley' | 'zotero' | 'papers'>,
  76. value
  77. )
  78. )
  79. ).then(() => {
  80. setUserSettings(currentSettings => ({
  81. ...currentSettings,
  82. ...patch,
  83. }))
  84. keysToRemove.forEach(customLocalStorage.removeItem)
  85. })
  86. // Only run once when the provider mounts
  87. // eslint-disable-next-line react-hooks/exhaustive-deps
  88. }, [])
  89. const value = useMemo<UserSettingsContextValue>(
  90. () => ({
  91. userSettings,
  92. setUserSettings,
  93. }),
  94. [userSettings, setUserSettings]
  95. )
  96. return (
  97. <UserSettingsContext.Provider value={value}>
  98. {children}
  99. </UserSettingsContext.Provider>
  100. )
  101. }
  102. export function useUserSettingsContext() {
  103. const context = useContext(UserSettingsContext)
  104. if (!context) {
  105. throw new Error(
  106. 'useUserSettingsContext is only available inside UserSettingsProvider'
  107. )
  108. }
  109. return context
  110. }