Developing Frontend

Only include folders needed for the feature. Don't create empty folders.

Naming Conventions

• Folders: kebab-case (e.g., user-profile/)
• Components: PascalCase.tsx (e.g., UserCard.tsx)
• Hooks: use-kebab-case.ts (e.g., use-user-data.ts)
• Types: kebab-case.ts (e.g., user-types.ts)

No Barrel Files

Avoid index.ts files that re-export everything. They hurt Vite tree-shaking.

// Bad - barrel file
export * from './UserCard';
export * from './UserList';

// Good - direct imports
import { UserCard } from '@/features/user-profile/components/UserCard';

Route Modules

React Router v7 route modules export three main pieces:

Basic Structure

import type { Route } from "./+types/my-route";

// Server-side data loading
export async function loader({ params, request }: Route.LoaderArgs) {
  const data = await fetchData(params.id);
  return { data };
}

// Server-side mutations
export async function action({ request }: Route.ActionArgs) {
  const formData = await request.formData();
  await saveData(formData);
  return { success: true };
}

// Component receives loader data as props
export default function MyRoute({ loaderData }: Route.ComponentProps) {
  return <div>{loaderData.data.title}</div>;
}

Deferred Data with Suspense

For non-critical data, return promises without awaiting:

export async function loader({ params }: Route.LoaderArgs) {
  // Critical - await this
  const user = await getUser(params.id);

  // Non-critical - don't await, stream later
  const activity = getRecentActivity(params.id);

  return { user, activity };
}

export default function Profile({ loaderData }: Route.ComponentProps) {
  const { user, activity } = loaderData;

  return (
    <div>
      <h1>{user.name}</h1>

      <Suspense fallback={<ActivitySkeleton />}>
        <Await resolve={activity}>
          {(data) => <ActivityList items={data} />}
        </Await>
      </Suspense>
    </div>
  );
}

Error Boundaries

Handle route errors gracefully:

import { isRouteErrorResponse, useRouteError } from "react-router";

export function ErrorBoundary() {
  const error = useRouteError();

  if (isRouteErrorResponse(error)) {
    return <div>{error.status}: {error.statusText}</div>;
  }

  return <div>Something went wrong</div>;
}

File-Based Routing

Use flatRoutes from @react-router/fs-routes for file-based routing:

// app/routes.ts
import { type RouteConfig } from "@react-router/dev/routes";
import { flatRoutes } from "@react-router/fs-routes";

export default flatRoutes() satisfies RouteConfig;

Flat Routes Conventions

Dynamic Segments

Use $ prefix for dynamic parameters:

app/routes/
├── users.$userId.tsx        → /users/:userId
├── posts.$postId.edit.tsx   → /posts/:postId/edit
└── files.$.tsx              → /files/* (splat)

Access params in loader:

export async function loader({ params }: Route.LoaderArgs) {
  const user = await getUser(params.userId);
  return { user };
}

Nested Routes with Dot Notation

Dots create nesting. The parent renders children via <Outlet />:

app/routes/
├── concerts.tsx           → Layout for /concerts/*
├── concerts._index.tsx    → /concerts
├── concerts.$city.tsx     → /concerts/:city
└── concerts.trending.tsx  → /concerts/trending

Pathless Layouts

Underscore prefix creates layouts without URL segments:

app/routes/
├── _auth.tsx              → Layout (no URL segment)
├── _auth.login.tsx        → /login
└── _auth.register.tsx     → /register

Components

TypeScript Props

Always define explicit prop types:

type UserCardProps = {
  user: User;
  onSelect?: (id: string) => void;
  variant?: 'compact' | 'full';
};

export function UserCard({ user, onSelect, variant = 'full' }: UserCardProps) {
  return (
    <div className="rounded-lg border p-4">
      <h3 className="font-semibold">{user.name}</h3>
      {variant === 'full' && <p className="text-gray-600">{user.email}</p>}
    </div>
  );
}

Tailwind CSS Patterns

Use utility classes directly. Compose with template literals for conditionals:

type ButtonProps = {
  variant?: 'primary' | 'secondary';
  size?: 'sm' | 'md' | 'lg';
  children: React.ReactNode;
} & React.ButtonHTMLAttributes<HTMLButtonElement>;

export function Button({
  variant = 'primary',
  size = 'md',
  children,
  className,
  ...props
}: ButtonProps) {
  const baseStyles = 'rounded font-medium transition-colors';

  const variants = {
    primary: 'bg-blue-600 text-white hover:bg-blue-700',
    secondary: 'bg-gray-200 text-gray-900 hover:bg-gray-300',
  };

  const sizes = {
    sm: 'px-3 py-1.5 text-sm',
    md: 'px-4 py-2 text-base',
    lg: 'px-6 py-3 text-lg',
  };

  return (
    <button
      className={`${baseStyles} ${variants[variant]} ${sizes[size]} ${className ?? ''}`}
      {...props}
    >
      {children}
    </button>
  );
}

Loading States

Create skeleton components for loading states:

export function UserCardSkeleton() {
  return (
    <div className="animate-pulse rounded-lg border p-4">
      <div className="h-5 w-32 rounded bg-gray-200" />
      <div className="mt-2 h-4 w-48 rounded bg-gray-200" />
    </div>
  );
}

// Usage with Suspense
<Suspense fallback={<UserCardSkeleton />}>
  <Await resolve={userData}>
    {(user) => <UserCard user={user} />}
  </Await>
</Suspense>

Component Placement

Import Rules

Enforce unidirectional dependencies to keep features independent:

shared → features → app

What Can Import What

Rules

1. Features never import from other features

   // Bad - cross-feature import
   import { UserCard } from '@/features/users/components/UserCard';
   // in features/dashboard/...
   
   // Good - use shared components or lift to app layer
   import { UserCard } from '@/components/UserCard';
   

2. Features never import from app

   // Bad - importing from app layer
   import { router } from '@/app/router';
   
   // Good - pass dependencies via props or context
   

3. Compose features at app layer

   // app/routes/dashboard.tsx
   import { UserStats } from '@/features/users/components/UserStats';
   import { RecentActivity } from '@/features/activity/components/RecentActivity';
   
   export default function Dashboard() {
     return (
       <div>
         <UserStats />
         <RecentActivity />
       </div>
     );
   }
   

ESLint Enforcement

Use eslint-plugin-import to enforce boundaries:

// .eslintrc.js