---
name: opik-frontend
description: React frontend patterns for Opik. Use when working in apps/opik-frontend, on components, state, or data fetching.
title: opik-frontend
canonical_url: https://skilld.dev/gh/comet-ml/opik/opik-frontend
last_updated: 2026-10-14T20:31:59.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [code-quality.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/code-quality.md), [forms.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/forms.md), [performance.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/performance.md), [permissions.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/permissions.md), [responsive-design.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/responsive-design.md), [testing.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/testing.md), [ui-components.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/ui-components.md).
>
> If the user asked to install this Skill, run `npx skilld install comet-ml/opik/opik-frontend`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/opik-frontend`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/comet-ml/opik/opik-frontend) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/opik-frontend`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/opik-frontend --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/opik-frontend --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Opik Frontend

## Architecture Decisions
- **Routing**: TanStack Router (file-based)
- **Data fetching**: TanStack Query (never raw fetch/useEffect)
- **State**: Zustand for global, React state for local
- **Components**: shadcn/ui + Radix UI base
- **Forms**: React Hook Form + Zod validation

## Critical Gotchas

### Never useEffect for Data Fetching
```typescript
// ❌ BAD
useEffect(() => {
  fetch('/api/data').then(setData);
}, []);

// ✅ GOOD
const { data } = useQuery({
  queryKey: ['data'],
  queryFn: fetchData,
});
```

### Selective Memoization
```typescript
// ✅ USE useMemo for: complex computations, large data transforms
const filtered = useMemo(() =>
  data.filter(x => x.status === 'active').map(transform),
  [data]
);

// ✅ USE useCallback for: functions passed to children
const handleClick = useCallback(() => doSomething(id), [id]);

// ❌ DON'T memoize: simple values, primitives, local functions
const name = data?.name ?? '';  // No useMemo needed
```

### Zustand Selectors
```typescript
// ✅ GOOD - specific selector
const selectedEntity = useEntityStore(state => state.selectedEntity);

// ❌ BAD - selecting entire store causes re-renders
const { selectedEntity, filters } = useEntityStore();
```

### Browser Translation Safety (Google Translate)
Many users auto-translate the page; the translator wraps text nodes in `<font>` elements, so React throws `NotFoundError: removeChild` when it reconciles a **bare dynamic text node** it re-parented. Wrap dynamic/conditional strings in their own element instead of rendering bare text.
```typescript
// ❌ bare dynamic text → crash under translation
<button>{icon}{label}</button>
// ✅ wrap it → React swaps a stable element, stays translatable
<button>{icon}<span>{label}</span></button>
```
For timer-driven text (typewriter/counter), also avoid per-tick `setState` — write into a ref'd node's `textContent` (React never reconciles it), or mark a decorative node `translate="no"`. Ref: [facebook/react#11538](https://github.com/facebook/react/issues/11538) (OPIK-7428, OPIK-7435).

## Layer Architecture

### Shared layers (used by all versions)
`ui → shared` (one-way only)

### Per-version layers
`ui → shared → v1/pages-shared → v1/pages` (one-way only)
`ui → shared → v2/pages-shared → v2/pages` (one-way only)

### Module boundaries
- v1/ CANNOT import from v2/
- v2/ CANNOT import from v1/
- `src/components/` is BLOCKED (old structure, no longer exists)
- After modifying imports: `npm run deps:validate`

### Shared component rules
- Backward-compatible changes only
- Must not be version-aware (use `showProjectSelector={true}` not `isV2={true}`)
- If behavior needs to change, create a new component instead

## State Location Decisions
- **URL state**: filters, pagination, selected items
- **Zustand**: user preferences, cross-component state
- **React state**: form inputs, UI toggles

## Component Structure
```typescript
const Component: React.FC<Props> = ({ prop }) => {
  // 1. State hooks
  // 2. Queries/mutations
  // 3. Memoization (only when needed)
  // 4. Event handlers

  if (isLoading) return <Loader />;
  if (error) return <ErrorComponent />;

  return <div>...</div>;
};
```

## Query Patterns
```typescript
// Query with params
const { data } = useQuery({
  queryKey: [ENTITY_KEY, params],
  queryFn: (context) => fetchEntity(context, params),
});

// Mutation with invalidation
const mutation = useMutation({
  mutationFn: updateEntity,
  onSuccess: () => {
    queryClient.invalidateQueries({ queryKey: [ENTITY_KEY] });
  },
});
```

## Reference Files
- [forms.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/forms.md) - React Hook Form + Zod patterns
- [ui-components.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/ui-components.md) - Button variants, typography, dark theme
- [responsive-design.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/responsive-design.md) - Tailwind breakpoints vs useIsPhone
- [testing.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/testing.md) - When to test, Vitest patterns
- [code-quality.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/code-quality.md) - Lodash imports, naming, deps:validate
- [performance.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/performance.md) - Bundle optimization, rendering, memoization
- [permissions.md](https://skilld.dev/api/skills-raw/comet-ml/opik/opik-frontend/permissions.md) - `usePermissions()` guard guidance for UI actions
