mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:19:27 +08:00
* Rename webapplication skills to ui-bundle
Rename all 7 webapplication skill directories and their content to use
the "ui-bundle" / "UIBundle" naming convention, aligning with the
New++ (TDX) naming strategy.
Directory renames:
- deploying-webapplication → deploying-ui-bundle
- generating-webapplication-{features,metadata,ui} → generating-ui-bundle-*
- implementing-webapplication-{agentforce-conversation-client,file-upload} → implementing-ui-bundle-*
- using-webapplication-salesforce-data → using-ui-bundle-salesforce-data
Content updates across all skills:
- Frontmatter name fields
- Prose: "web application" → "UI bundle"
- Metadata refs: WebApplication → UIBundle, webapplications/ → uiBundles/
- CLI: sf webapp → sf ui-bundle
- NPM packages per rename table
- Cross-skill references and generating-experience-react-site refs
* Rename generating-ui-bundle-ui skill to building-ui-bundle-frontend
The "ui-bundle-ui" name was confusing. "building-ui-bundle-frontend"
better conveys that this skill handles the React frontend layer
within a UI bundle.
---------
Co-authored-by: gbockus-sf <76090802+gbockus-sf@users.noreply.github.com>
4.4 KiB
4.4 KiB
Implementation — Page
Rules
- Edit the component that owns the UI, never output raw HTML — When editing the home page or any page content, modify the actual
.tsxfile that renders the target. If the target is inside a child component (e.g.<GlobalSearchInput />inHome.tsx), edit the child's file (e.g.GlobalSearchInput.tsx), not the parent. Do not wrap the component with extra elements in the parent; go into the component and change its JSX. Do not paste or generate raw HTML. routes.tsxis the only route registry — never add routes inapp.tsxor inside page files.- All pages are children of the AppLayout route — do not create top-level routes that bypass the layout shell.
- Default export per page — each page file has exactly one default-export component.
- Path aliases in all imports — use
@/pages/...,@/components/...; no deep relative paths. - No inline styles — Tailwind utility classes and design tokens only.
- Catch-all last —
path: '*'(NotFound) must always remain the last child in the layout route. - Never modify
appLayout.tsxwhen adding a page — layout changes are a separate concern.
Step 1 — Create the page file
Create src/pages/MyPage.tsx with a default export and the standard page container:
export default function MyPage() {
return (
<div className="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
<h1 className="text-3xl font-bold text-foreground">My Page</h1>
<p className="mt-4 text-muted-foreground">Page content goes here.</p>
</div>
);
}
Use shadcn components from @/components/ui for UI elements. All styling via Tailwind — no inline style={{}}.
Step 2 — Register the route in routes.tsx
Open src/routes.tsx. Import the page and add it inside the layout route's children array:
import MyPage from "@/pages/MyPage";
// Inside the layout route's children array (before the catch-all):
{
path: "my-page",
element: <MyPage />,
handle: { showInNavigation: true, label: "My Page" },
},
pathis a relative segment (e.g.,"contacts"), not an absolute path.- Include
handle: { showInNavigation: true, label: "Label" }only if the page should appear in the navigation menu. - The catch-all
path: '*'must stay last.
Step 3 — Apply an auth guard (if needed)
| Access type | Guard | Behavior |
|---|---|---|
| Public | None | Direct child of layout |
| Authenticated only | <PrivateRoute> |
Redirects to login if not authenticated |
| Unauthenticated only (e.g., login) | <AuthenticationRoute> |
Redirects away if already authenticated |
Example — private page:
import { PrivateRoute } from "@/components/auth/private-route";
{
path: "settings",
element: <PrivateRoute><SettingsPage /></PrivateRoute>,
handle: { showInNavigation: true, label: "Settings" },
},
Use ROUTES.* constants from @/utils/authenticationConfig for auth-related paths — do not hardcode /login, /profile, etc.
File Conventions — Page
| Concern | Location |
|---|---|
| Page component | src/pages/<PageName>.tsx (default export) |
| Route definition | src/routes.tsx only |
| Layout shell | src/appLayout.tsx — do not modify for page additions |
| Auth config paths | ROUTES.* from @/utils/authenticationConfig |
State and Data
- Local state:
useState,useReducer,useRefinside the page component - Shared or complex state: extract to
src/hooks/with auseprefix (e.g.,useContacts) - Data fetching: prefer GraphQL (
executeGraphQL) or REST utilities insrc/api/; place shared data logic insrc/hooks/ - Auth context:
useAuth()from@/context/AuthContextwhen current user is needed — only valid underAuthProvider
Confirm — Page
- The page renders inside the app shell (header/nav visible)
- If
showInNavigation: true, the link appears in the navigation menu - No TypeScript errors; no broken imports; no missing exports
- Imports use path aliases (
@/, not deep relative paths)