Advanced
API Reference
Complete reference for all properties and options available in the DevConsole component and providers.
DebugToolkit Props
| Prop / Option | Type | Default | Description |
|---|---|---|---|
| initialTab | DebugTab | 'Auth' | The tab to show when the toolkit is first opened. |
| defaultOpen | boolean | false | Whether the toolkit overlay should be open by default. |
| theme | 'dark' | 'light' | 'dark' | The UI theme for the toolkit. |
| godMode | boolean | true | Enable or disable God Mode capabilities globally. |
| initialUser | UserDetails | null | Seed data for the User Simulation tab. |
| initialAuth | AuthData | null | Seed data for the Auth & Identity tab. |
| initialOnboardingSteps | OnboardingStep[] | [] | Custom steps for the Onboarding Simulation tab. |
| initialConfig | ThemeConfig | {...} | Custom branding colors for the toolkit UI. |
| position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | 'bottom-right' | Position of the trigger button and toolkit panel on the screen. The trigger button stays sticky in the configured corner. |
Core Functions
| Function | Returns | Description |
|---|---|---|
| registerStore(adapter) | void | Registers a custom state manager (Zustand, Redux, etc.) with the toolkit. |
| unregisterStore(name) | void | Removes a previously registered store by its name. |
| createZustandAdapter(name, useStore) | StoreAdapter | Utility to quickly wrap a Zustand store for DevConsole. |
| createReduxAdapter(name, store) | StoreAdapter | Utility to quickly wrap a Redux store for DevConsole. |
| mountDebugToolkit(options) | void | Imperatively inject the toolkit into any non-React application. |