@sanity/ui-workshop/src/core/WorkshopContext.ts

An environment for designing, reviewing, and quality-testing React components.

import {ThemeColorSchemeKey} from '@sanity/ui'
import {createContext} from 'react'

import {WorkshopCollection, WorkshopPlugin, WorkshopScope, WorkshopStory} from './config'
import {Pubsub} from './lib/pubsub'
import {WorkshopMsg} from './types'

/** @public */
export interface WorkshopContextValue<CustomMsg = never> {
  plugins: WorkshopPlugin[]
  broadcast: (msg: WorkshopMsg | CustomMsg) => void
  channel: Pubsub<WorkshopMsg | CustomMsg>
  collections: WorkshopCollection[]
  frameReady: boolean
  frameUrl: string
  origin: 'frame' | 'main'
  path: string
  payload: Record<string, unknown>
  scheme: ThemeColorSchemeKey
  scope: WorkshopScope | null
  scopes: WorkshopScope[]
  story: WorkshopStory | null
  title: string
  viewport: string
  zoom: number
}

/** @internal */
export const WorkshopContext = createContext<WorkshopContextValue | null>(null)