# @fusion/tui
Terminal UI components for fn, built with [Ink](https://github.com/vadimdemedes/ink) (React for the command line).
## Status
This package is under active development and not yet published.
## Installation
This package is part of the fn workspace and is not installed separately. It is available as a private workspace package.
## API Reference
### FusionProvider
The `FusionProvider` component initializes a `TaskStore` and provides it via React context.
```tsx
import { FusionProvider } from "@fusion/tui";
function App() {
return (
);
}
```
#### Props
| Prop | Type | Description |
|------|------|-------------|
| `projectDir` | `string` (optional) | Explicit project directory override. When provided, skips auto-detection. |
| `children` | `React.ReactNode` | Child components that will have access to the Fusion context. |
#### Behavior
- On mount, auto-detects the Fusion project by walking up from `process.cwd()` looking for `.fusion/fusion.db`
- If no project is found, renders a red error message
- On unmount, calls `store.close()` to cleanly shut down the SQLite connection
### useFusion
Hook to access the Fusion context. Must be used within a `FusionProvider`.
```tsx
import { useFusion } from "@fusion/tui";
function TaskList() {
const { store, projectPath } = useFusion();
useEffect(() => {
store.listTasks().then((tasks) => {
// Render tasks...
});
}, [store]);
return Project: {projectPath};
}
```
#### Returns
| Property | Type | Description |
|----------|------|-------------|
| `store` | `TaskStore` | The initialized TaskStore instance |
| `projectPath` | `string` | Absolute path to the project directory |
#### Throws
`Error` if used outside of a `FusionProvider`.
### detectProjectDir
Detect the Fusion project root directory by walking up from a starting path.
```typescript
import { detectProjectDir } from "@fusion/tui";
// Find project from current directory
const projectPath = detectProjectDir();
// Find project from a specific directory
const projectPath = detectProjectDir("/Users/me/code/my-project/src");
```
#### Parameters
| Parameter | Type | Description |
|-----------|------|-------------|
| `startPath` | `string` (optional) | Starting directory for the search (defaults to `process.cwd()`) |
#### Returns
The absolute path to the project root, or `null` if no project directory is detected.
### ScreenRouter
The `ScreenRouter` component provides a keyboard-navigable tab bar for switching between application screens.
```tsx
import { ScreenRouter } from "@fusion/tui";
function App() {
return (
{({ activeScreen }) => (
<>
{activeScreen === "board" && }
{activeScreen === "detail" && }
{activeScreen === "activity" && }
{activeScreen === "agents" && }
{activeScreen === "settings" && }
>
)}
);
}
```
#### Available Screens
The router manages five screens in this order:
| Index | Screen ID | Label | Shortcut |
|-------|-----------|-------|----------|
| 1 | `board` | Board | `1` |
| 2 | `detail` | Detail | `2` |
| 3 | `activity` | Activity | `3` |
| 4 | `agents` | Agents | `4` |
| 5 | `settings` | Settings | `5` |
#### Keyboard Navigation
| Key | Action |
|-----|--------|
| `1` - `5` | Jump directly to the corresponding tab |
| `Tab` | Cycle forward through tabs (wraps from end to start) |
| `Shift+Tab` | Cycle backward through tabs (wraps from start to end) |
#### Tab Bar Rendering
The tab bar displays all five tabs horizontally with:
- Active tab highlighted with bold text, cyan background, and black text
- Inactive tabs shown in white text
- A border line below the tab bar
#### Props
| Prop | Type | Description |
|------|------|-------------|
| `children` | `(props: ScreenComponentProps) => React.ReactNode` | Render function that receives `activeScreen` and returns the screen content |
#### ScreenComponentProps
| Property | Type | Description |
|----------|------|-------------|
| `activeScreen` | `ScreenId` | The currently active screen ID (`"board"` \| `"detail"` \| `"activity"` \| `"agents"` \| `"settings"`) |
#### Exports
The following are exported from `@fusion/tui`:
- `ScreenRouter` — The main router component
- `SCREENS` — Array of screen definitions with `id`, `label`, and `shortcut`
- `getScreenById(id)` — Get screen definition by ID
- `getScreenIndex(id)` — Get screen index by ID
- `type ScreenId` — Type for screen identifiers
## Example
```tsx
import React from "react";
import { render, Box, Text } from "ink";
import { FusionProvider, useFusion, ScreenRouter } from "@fusion/tui";
function ProjectInfo() {
const { store, projectPath } = useFusion();
const [tasks, setTasks] = React.useState([]);
React.useEffect(() => {
store.listTasks().then(setTasks);
}, [store]);
return (
Project: {projectPath}
Tasks: {tasks.length}
);
}
render(
{({ activeScreen }) => (
Fusion TUI
{activeScreen === "board" && (
Board Screen - Use 1-5 to switch tabs
)}
{activeScreen === "detail" && (
Detail Screen
)}
)}
);
```