ide-context.tsx 1.8 KB

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