mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:43:26 +08:00
The "building" prefix caused skill selection confusion with building-ui-bundle-app when the intent classifier tagged requests as "app". Renaming to "editing" clearly distinguishes modify-existing-app from create-new-app workflows. Also expanded trigger words in the description for better matching. Updated cross-references in building-ui-bundle-app and generating-ui-bundle-metadata.
3.4 KiB
3.4 KiB
Implementation — Component
Rules
- Always use shadcn components from
@/components/ui— never build raw HTML equivalents for buttons, inputs, cards, alerts, tabs, tables, or labels. - All styling via Tailwind — utility classes only. No inline
style={{}}, CSS Modules, or other styling systems. - Use design tokens — prefer
bg-background,text-foreground,text-muted-foreground,border,bg-primary,text-destructive,rounded-lgover hardcoded colors. - Use
cn()from@/lib/utilsfor conditional or composable class names. - TypeScript — functional components with typed props interface; always accept
className?: string.
File Location — Component
| Component type | Location | Export |
|---|---|---|
| Shared UI primitive (reusable across features) | src/components/ui/ — add to index.ts |
Named export |
| Feature-specific (e.g., dashboard widget) | src/components/<feature>/ |
Named export, import directly where used |
| Page-level layout element | src/components/layout/ |
Named export |
Component Structure
import { Card, CardHeader, CardTitle, CardContent } from "@/components/ui";
import { cn } from "@/lib/utils";
interface MyComponentProps {
title: string;
value: string;
className?: string;
}
export function MyComponent({ title, value, className }: MyComponentProps) {
return (
<Card className={cn("border", className)}>
<CardHeader>
<CardTitle className="text-sm font-medium">{title}</CardTitle>
</CardHeader>
<CardContent>
<p className="text-2xl font-semibold text-foreground">{value}</p>
</CardContent>
</Card>
);
}
State and Hooks
- Local state only: keep
useState,useReducer,useRefinside the component. - Shared or complex state: extract to a custom hook in
src/hooks/(prefix withuse, e.g.useFormData). Do this when more than one component needs the state, or when multiple hooks are composed together.
Adding the Component to a Page
// In the target page file, e.g. src/pages/HomePage.tsx
import { MyComponent } from "@/components/<feature>/MyComponent";
export default function HomePage() {
return (
<div className="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
<MyComponent title="Status" value="Active" />
</div>
);
}
Useful Patterns — Component
- Programmatic navigation: use
useNavigatefromreact-router; callnavigate(path)— consistent with GlobalSearchInput, SearchResultCard, MaintenanceTable, and other components in the UI bundle. - Page container:
max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-12 - Icons:
lucide-react; addaria-hidden="true"on decorative icons - Focus styles: use
focus-visible:variants - Multiple visual variants: use CVA (
cva) andVariantProps - shadcn import barrel:
import { Button, Card, Input } from "@/components/ui"
Confirm — Component
- Imports use path aliases (
@/, not deep relative paths) - No raw
<button>,<input>, or styled<div>where shadcn equivalents exist - No inline
style={{}}— Tailwind only