mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-09 17:22:00 +08:00
272 lines
10 KiB
Markdown
272 lines
10 KiB
Markdown
---
|
|
name: salesforce-webapp-ui-ux
|
|
description: Use when editing any UI code in the web application — styling, layout, design, appearance, Tailwind, shadcn, colors, typography, icons, or visual/UX changes. Comprehensive design guide and searchable database for React + Tailwind + shadcn/ui (styles, color palettes, font pairings, UX guidelines, chart types).
|
|
---
|
|
|
|
# Web App UI/UX
|
|
|
|
Use this skill whenever you are editing UI code in the web application — styling, layout, design, appearance, Tailwind, shadcn, colors, typography, icons, or any visual/UX change.
|
|
|
|
Comprehensive design guide for React + Tailwind + shadcn/ui. Contains 67 styles, 96 color palettes, 57 font pairings, 99 UX guidelines, and 25 chart types. Searchable database with priority-based recommendations.
|
|
|
|
## Prerequisites
|
|
|
|
Requires Node.js (included with any React/Tailwind project):
|
|
|
|
```bash
|
|
node --version
|
|
```
|
|
|
|
---
|
|
|
|
## How to Use This Skill
|
|
|
|
When user requests UI/UX work (design, build, create, implement, review, fix, improve), follow this workflow. **Always generate a design system first** — every time, no exceptions.
|
|
|
|
### Step 1: Analyze User Requirements
|
|
|
|
Extract key information from user request:
|
|
- **Product type**: SaaS, e-commerce, portfolio, dashboard, landing page, etc.
|
|
- **Style keywords**: minimal, playful, professional, elegant, dark mode, etc.
|
|
- **Industry**: healthcare, fintech, gaming, education, etc.
|
|
|
|
### Step 2: Generate Design System (REQUIRED)
|
|
|
|
**Always start with `--design-system`** to get comprehensive recommendations with reasoning:
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "<product_type> <industry> <keywords>" --design-system [-p "Project Name"]
|
|
```
|
|
|
|
This command:
|
|
1. Searches 5 domains in parallel (product, style, color, landing, typography)
|
|
2. Applies reasoning rules from `ui-reasoning.csv` to select best matches
|
|
3. Returns complete design system: pattern, style, colors, typography, effects
|
|
4. Includes anti-patterns to avoid
|
|
|
|
**Example:**
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "beauty spa wellness service" --design-system -p "Serenity Spa"
|
|
```
|
|
|
|
### Step 2b: Persist Design System (Master + Overrides Pattern)
|
|
|
|
To save the design system for hierarchical retrieval across sessions, add `--persist`:
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "<query>" --design-system --persist -p "Project Name"
|
|
```
|
|
|
|
This creates:
|
|
- `design-system/MASTER.md` — Global Source of Truth with all design rules
|
|
- `design-system/pages/` — Folder for page-specific overrides
|
|
|
|
**With page-specific override:**
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "<query>" --design-system --persist -p "Project Name" --page "dashboard"
|
|
```
|
|
|
|
This also creates:
|
|
- `design-system/pages/dashboard.md` — Page-specific deviations from Master
|
|
|
|
**How hierarchical retrieval works:**
|
|
1. When building a specific page (e.g., "Checkout"), first check `design-system/pages/checkout.md`
|
|
2. If the page file exists, its rules **override** the Master file
|
|
3. If not, use `design-system/MASTER.md` exclusively
|
|
|
|
### Step 3: Supplement with Detailed Searches (as needed)
|
|
|
|
After getting the design system, use domain searches to get additional details:
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "<keyword>" --domain <domain> [-n <max_results>]
|
|
```
|
|
|
|
**When to use detailed searches:**
|
|
|
|
| Need | Domain | Example |
|
|
|------|--------|---------|
|
|
| More style options | `style` | `--domain style "glassmorphism dark"` |
|
|
| Chart recommendations | `chart` | `--domain chart "real-time dashboard"` |
|
|
| UX best practices | `ux` | `--domain ux "animation accessibility"` |
|
|
| Alternative fonts | `typography` | `--domain typography "elegant luxury"` |
|
|
| Landing structure | `landing` | `--domain landing "hero social-proof"` |
|
|
|
|
### Step 4: Stack Guidelines
|
|
|
|
Get implementation-specific best practices for React, Tailwind, or shadcn/ui:
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "<keyword>" --stack shadcn
|
|
```
|
|
|
|
Available stacks: `html-tailwind`, `react`, `shadcn`
|
|
|
|
---
|
|
|
|
## Search Reference
|
|
|
|
### Available Domains
|
|
|
|
| Domain | Use For | Example Keywords |
|
|
|--------|---------|------------------|
|
|
| `product` | Product type recommendations | SaaS, e-commerce, portfolio, healthcare, beauty, service |
|
|
| `style` | UI styles, colors, effects | glassmorphism, minimalism, dark mode, brutalism |
|
|
| `typography` | Font pairings, Google Fonts | elegant, playful, professional, modern |
|
|
| `color` | Color palettes by product type | saas, ecommerce, healthcare, beauty, fintech, service |
|
|
| `landing` | Page structure, CTA strategies | hero, hero-centric, testimonial, pricing, social-proof |
|
|
| `chart` | Chart types, library recommendations | trend, comparison, timeline, funnel, pie |
|
|
| `ux` | Best practices, anti-patterns | animation, accessibility, z-index, loading |
|
|
| `react` | React performance | waterfall, bundle, suspense, memo, rerender, cache |
|
|
| `web` | Web interface guidelines | aria, focus, keyboard, semantic, virtualize |
|
|
| `prompt` | AI prompts, CSS keywords | (style name) |
|
|
|
|
### Available Stacks
|
|
|
|
| Stack | Focus |
|
|
|-------|-------|
|
|
| `html-tailwind` | Tailwind utilities, responsive, a11y |
|
|
| `react` | State, hooks, performance, patterns |
|
|
| `shadcn` | shadcn/ui components, theming, forms, patterns |
|
|
|
|
---
|
|
|
|
## Example Workflow
|
|
|
|
**User request:** "Build a landing page for a professional skincare service"
|
|
|
|
### Step 1: Analyze Requirements
|
|
- Product type: Beauty/Spa service
|
|
- Style keywords: elegant, professional, soft
|
|
- Industry: Beauty/Wellness
|
|
|
|
### Step 2: Generate Design System (REQUIRED)
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "beauty spa wellness service elegant" --design-system -p "Serenity Spa"
|
|
```
|
|
|
|
**Output:** Complete design system with pattern, style, colors, typography, effects, and anti-patterns.
|
|
|
|
### Step 3: Supplement with Detailed Searches (as needed)
|
|
|
|
```bash
|
|
# Get UX guidelines for animation and accessibility
|
|
node skills/ui-ux/scripts/search.js "animation accessibility" --domain ux
|
|
|
|
# Get alternative typography options if needed
|
|
node skills/ui-ux/scripts/search.js "elegant luxury serif" --domain typography
|
|
```
|
|
|
|
### Step 4: Stack Guidelines
|
|
|
|
```bash
|
|
node skills/ui-ux/scripts/search.js "layout responsive form" --stack html-tailwind
|
|
node skills/ui-ux/scripts/search.js "form dialog" --stack shadcn
|
|
```
|
|
|
|
**Then:** Synthesize design system + detailed searches and implement the design.
|
|
|
|
---
|
|
|
|
## Output Formats
|
|
|
|
The `--design-system` flag supports two output formats:
|
|
|
|
```bash
|
|
# ASCII box (default) - best for terminal display
|
|
node skills/ui-ux/scripts/search.js "fintech crypto" --design-system
|
|
|
|
# Markdown - best for documentation
|
|
node skills/ui-ux/scripts/search.js "fintech crypto" --design-system -f markdown
|
|
```
|
|
|
|
---
|
|
|
|
## Tips for Better Results
|
|
|
|
1. **Be specific with keywords** - "healthcare SaaS dashboard" > "app"
|
|
2. **Search multiple times** - Different keywords reveal different insights
|
|
3. **Combine domains** - Style + Typography + Color = Complete design system
|
|
4. **Always check UX** - Search "animation", "z-index", "accessibility" for common issues
|
|
5. **Use stack flag** - Get implementation-specific best practices
|
|
6. **Iterate** - If first search doesn't match, try different keywords
|
|
|
|
---
|
|
|
|
## Common Rules for Professional UI
|
|
|
|
These are frequently overlooked issues that make UI look unprofessional:
|
|
|
|
### Icons & Visual Elements
|
|
|
|
| Rule | Do | Don't |
|
|
|------|----|----- |
|
|
| **Icons: Lucide only** | Use **lucide-react** for all UI icons: `import { IconName } from 'lucide-react'` | Use Heroicons, react-icons, or other icon libraries; use emojis as icons |
|
|
| **No emojis ever** | Use words + Lucide icons for labels, empty states, tooltips, headings | Use emojis anywhere in UI or user-facing text (e.g. 🎨 🚀 ⚙️) |
|
|
| **Stable hover states** | Use color/opacity transitions on hover | Use scale transforms that shift layout |
|
|
| **Correct brand logos** | Research official SVG from Simple Icons (when needed outside Lucide) | Guess or use incorrect logo paths |
|
|
| **Consistent icon sizing** | Use fixed viewBox (24x24) with w-6 h-6 | Mix different icon sizes randomly |
|
|
|
|
### Interaction & Cursor
|
|
|
|
| Rule | Do | Don't |
|
|
|------|----|----- |
|
|
| **Cursor pointer** | Add `cursor-pointer` to all clickable/hoverable cards | Leave default cursor on interactive elements |
|
|
| **Hover feedback** | Provide visual feedback (color, shadow, border) | No indication element is interactive |
|
|
| **Smooth transitions** | Use `transition-colors duration-200` | Instant state changes or too slow (>500ms) |
|
|
|
|
### Light/Dark Mode Contrast
|
|
|
|
| Rule | Do | Don't |
|
|
|------|----|----- |
|
|
| **Glass card light mode** | Use `bg-white/80` or higher opacity | Use `bg-white/10` (too transparent) |
|
|
| **Text contrast light** | Use `#0F172A` (slate-900) for text | Use `#94A3B8` (slate-400) for body text |
|
|
| **Muted text light** | Use `#475569` (slate-600) minimum | Use gray-400 or lighter |
|
|
| **Border visibility** | Use `border-gray-200` in light mode | Use `border-white/10` (invisible) |
|
|
|
|
### Layout & Spacing
|
|
|
|
| Rule | Do | Don't |
|
|
|------|----|----- |
|
|
| **Floating navbar** | Add `top-4 left-4 right-4` spacing | Stick navbar to `top-0 left-0 right-0` |
|
|
| **Content padding** | Account for fixed navbar height | Let content hide behind fixed elements |
|
|
| **Consistent max-width** | Use same `max-w-6xl` or `max-w-7xl` | Mix different container widths |
|
|
|
|
---
|
|
|
|
## Pre-Delivery Checklist
|
|
|
|
Before delivering UI code, verify these items:
|
|
|
|
### Visual Quality
|
|
- [ ] No emojis anywhere (UI, labels, empty states, tooltips—use words + Lucide icons only)
|
|
- [ ] All icons from **lucide-react** only (no Heroicons, react-icons, or emojis)
|
|
- [ ] Brand logos are correct (verified from Simple Icons)
|
|
- [ ] Hover states don't cause layout shift
|
|
- [ ] Use theme colors directly (bg-primary) not var() wrapper
|
|
|
|
### Interaction
|
|
- [ ] All clickable elements have `cursor-pointer`
|
|
- [ ] Hover states provide clear visual feedback
|
|
- [ ] Transitions are smooth (150-300ms)
|
|
- [ ] Focus states visible for keyboard navigation
|
|
|
|
### Light/Dark Mode
|
|
- [ ] Light mode text has sufficient contrast (4.5:1 minimum)
|
|
- [ ] Glass/transparent elements visible in light mode
|
|
- [ ] Borders visible in both modes
|
|
- [ ] Test both modes before delivery
|
|
|
|
### Layout
|
|
- [ ] Floating elements have proper spacing from edges
|
|
- [ ] No content hidden behind fixed navbars
|
|
- [ ] Responsive at 375px, 768px, 1024px, 1440px
|
|
- [ ] No horizontal scroll on mobile
|
|
|
|
### Accessibility
|
|
- [ ] All images have alt text
|
|
- [ ] Form inputs have labels
|
|
- [ ] Color is not the only indicator
|
|
- [ ] `prefers-reduced-motion` respected
|