Skip to content

Package Overview

b3hr4d edited this page Mar 11, 2026 · 1 revision

Package Overview

Runtime Packages

Package Purpose Use it when
@ic-reactor/react React bindings, hook factories, auth hooks, query helpers You are building a React app
@ic-reactor/core Framework-agnostic runtime primitives You want the reactor runtime without React
@ic-reactor/candid Dynamic Candid fetching and runtime reactors You need runtime canister discovery or metadata-driven forms
@ic-reactor/parser WASM Candid parser You need local Candid compilation

Tooling Packages

Package Purpose Use it when
@ic-reactor/cli Manual code generation You want explicit generation or a non-Vite flow
@ic-reactor/vite-plugin Vite-integrated code generation and environment injection You want the best .did edit loop in Vite
@ic-reactor/codegen Shared generation pipeline You are building custom tooling around IC Reactor generation

How They Fit Together

  • @ic-reactor/react depends on @ic-reactor/core and re-exports the runtime classes.
  • @ic-reactor/candid builds on @ic-reactor/core.
  • @ic-reactor/candid can optionally load @ic-reactor/parser for local compilation.
  • @ic-reactor/cli and @ic-reactor/vite-plugin both use @ic-reactor/codegen.

Default Recommendations

  • Start with @ic-reactor/react for React apps.
  • Add @ic-reactor/vite-plugin if you use Vite.
  • Use @ic-reactor/core directly for framework-agnostic or service-side code.
  • Add @ic-reactor/candid only when you need runtime canister exploration or metadata features.

Clone this wiki locally