@payfit/unity-components/README.md

# Unity components

<!-- Release verification note: Unity v3 documentation is kept alongside the package. -->

The Unity component library exports the complete set of reusable components defined in PayFit's new Unity Design system.

## Version 3 migration

Unity Components v3 removes the React Hook Form integration and deprecated component APIs. Read the [2.x to 3.x migration guide](./src/docs/guides/migration/Migrating%20from%202.x%20to%203.x.mdx) before upgrading. All `@payfit/unity-*` packages use the shared Unity v3 major version.

See the [changelog](./CHANGELOG.md) for a summary of breaking changes.

## 🤖 Using an AI coding agent

If you use an AI coding agent (Claude Code, Cursor, Copilot, etc.), run:

```shell
npx @tanstack/intent@latest install
```

This wires the agent's config so it discovers and loads the per-package skills under `libs/shared/unity/<pkg>/skills/`. See `_artifacts/domain_map.yaml` for the full skill index.

## How to release manually

Add an emoji below:

- 🦄
- 🏰
- 🐧
- 🦉
- 🤸
- 🏔️
- 🍌
- 🦤
- 🫯
- 🐆
- 🎐

In some cases, the library is not published properly, which fails publish for payslip-template.