Files
copilotkit__copilotkit/.claude/docs/hooks.md
Tyler Slaton 96885b5959 refactor: consolidate V1/V2 packages into flat @copilotkit/* structure
Flatten all packages from packages/v1/* and packages/v2/* into packages/* —
every package now lives directly under the @copilotkit/ scope with no v1/v2
subdirectories.

- Move all v1 packages (react-core, react-ui, runtime, shared, etc.) from
  packages/v1/* to packages/*
- Absorb v2 react code into packages/react-core/src/v2/ (exported via /v2 subpath)
- Absorb v2 agent code into packages/runtime/src/agent/ (exported via /v2 subpath)
- Move v2 packages (core, angular, demo-agents, etc.) to packages/*
- Replace all @copilotkitnext/* imports with @copilotkit/* equivalents
- Keep @copilotkitnext/angular as the sole exception (angular remains on next)
- Update CI workflows, renovate config, release scripts for flat structure
- No public API surface changes — all exports fields are preserved

Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com>
Signed-off-by: Tyler Slaton <tyler@copilotkit.ai>
2026-03-28 16:45:10 -07:00

580 B

Hook Development

When creating a new hook, always complete all of the following:

  1. Implementation: Create the hook in @copilotkit/react-core. If backward compatibility shims are needed, add them in the package's v1/ directory.
  2. JSDoc: Add JSDoc on top of the hook implementation, including usage examples.
  3. Tests: Write extensive tests covering behavior, edge cases, and lifecycle (mount/unmount/re-render).
  4. Documentation: Add a dedicated docs page under /docs and update the relevant docs metadata file(s) so the page appears in navigation.