Skip to content

Public API Reference

Mekphen edited this page Jan 4, 2026 · 1 revision

Provider & Hooks

<CakeProvider> (src/context.tsx)

  • Provides tiering state via React context.
  • Automatically detects signals and updates state (unless autoDetect is false).
  • Accepts an optional server bootstrap for SSR consistency.

Key props:

  • config?: Partial<CakeConfig>
  • bootstrap?: CakeBootstrap
  • initialSignals?: CakeSignals
  • initialTier?: CakeTier
  • autoDetect?: boolean
  • onChange?: (state: CakeState) => void

Clone this wiki locally