ide-context.tsx 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. import { createContext, FC, useContext, useEffect, useMemo } from 'react'
  2. import { ScopeValueStore } from '../../../../types/ide/scope-value-store'
  3. import { ScopeEventEmitter } from '../../../../types/ide/scope-event-emitter'
  4. import { Socket } from '@/features/ide-react/connection/types/socket'
  5. export type Ide = {
  6. $scope: Record<string, any>
  7. socket: Socket
  8. }
  9. type IdeContextValue = Ide & {
  10. scopeStore: ScopeValueStore
  11. scopeEventEmitter: ScopeEventEmitter
  12. }
  13. export const IdeContext = createContext<IdeContextValue | undefined>(undefined)
  14. export const IdeProvider: FC<
  15. React.PropsWithChildren<{
  16. ide: Ide
  17. scopeStore: ScopeValueStore
  18. scopeEventEmitter: ScopeEventEmitter
  19. }>
  20. > = ({ ide, scopeStore, scopeEventEmitter, children }) => {
  21. /**
  22. * Expose scopeStore via `window.overleaf.unstable.store`, so it can be accessed by external extensions.
  23. *
  24. * These properties are expected to be available:
  25. * - `editor.view`
  26. * - `project.spellcheckLanguage`
  27. * - `editor.open_doc_name`,
  28. * - `editor.open_doc_id`,
  29. * - `settings.theme`
  30. * - `settings.keybindings`
  31. * - `settings.fontSize`
  32. * - `settings.fontFamily`
  33. * - `settings.lineHeight`
  34. */
  35. useEffect(() => {
  36. window.overleaf = {
  37. ...window.overleaf,
  38. unstable: {
  39. ...window.overleaf?.unstable,
  40. store: scopeStore,
  41. },
  42. }
  43. }, [scopeStore])
  44. const value = useMemo<IdeContextValue>(() => {
  45. return {
  46. ...ide,
  47. scopeStore,
  48. scopeEventEmitter,
  49. }
  50. }, [ide, scopeStore, scopeEventEmitter])
  51. return <IdeContext.Provider value={value}>{children}</IdeContext.Provider>
  52. }
  53. export function useIdeContext(): IdeContextValue {
  54. const context = useContext(IdeContext)
  55. if (!context) {
  56. throw new Error('useIdeContext is only available inside IdeProvider')
  57. }
  58. return context
  59. }