user-settings-context.tsx 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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. darkModePdf: false,
  34. zotero: {
  35. enabled: true,
  36. groups: [],
  37. disablePersonalLibrary: false,
  38. },
  39. mendeley: {
  40. enabled: true,
  41. groups: [],
  42. disablePersonalLibrary: false,
  43. },
  44. papers: {
  45. enabled: true,
  46. groups: [],
  47. disablePersonalLibrary: false,
  48. },
  49. }
  50. type UserSettingsContextValue = {
  51. userSettings: UserSettings
  52. setUserSettings: Dispatch<
  53. SetStateAction<UserSettingsContextValue['userSettings']>
  54. >
  55. }
  56. export const UserSettingsContext = createContext<
  57. UserSettingsContextValue | undefined
  58. >(undefined)
  59. export const UserSettingsProvider: FC<React.PropsWithChildren> = ({
  60. children,
  61. }) => {
  62. const [userSettings, setUserSettings] = useState<UserSettings>(
  63. () => getMeta('ol-userSettings') || defaultSettings
  64. )
  65. useEffect(() => {
  66. const { patch, keysToRemove } = getLegacyWriteAndCiteMigration(userSettings)
  67. if (Object.keys(patch).length === 0) {
  68. keysToRemove.forEach(customLocalStorage.removeItem)
  69. return
  70. }
  71. Promise.all(
  72. Object.entries(patch).map(([key, value]) =>
  73. saveUserSettings(
  74. key as keyof Pick<UserSettings, 'mendeley' | 'zotero' | 'papers'>,
  75. value
  76. )
  77. )
  78. ).then(() => {
  79. setUserSettings(currentSettings => ({
  80. ...currentSettings,
  81. ...patch,
  82. }))
  83. keysToRemove.forEach(customLocalStorage.removeItem)
  84. })
  85. // Only run once when the provider mounts
  86. // eslint-disable-next-line react-hooks/exhaustive-deps
  87. }, [])
  88. const value = useMemo<UserSettingsContextValue>(
  89. () => ({
  90. userSettings,
  91. setUserSettings,
  92. }),
  93. [userSettings, setUserSettings]
  94. )
  95. return (
  96. <UserSettingsContext.Provider value={value}>
  97. {children}
  98. </UserSettingsContext.Provider>
  99. )
  100. }
  101. export function useUserSettingsContext() {
  102. const context = useContext(UserSettingsContext)
  103. if (!context) {
  104. throw new Error(
  105. 'useUserSettingsContext is only available inside UserSettingsProvider'
  106. )
  107. }
  108. return context
  109. }