cc-devflow 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/CLAUDE.md +83 -0
- package/.claude/agents/architecture-designer.md +443 -0
- package/.claude/agents/bug-analyzer.md +382 -0
- package/.claude/agents/checklist-agent.md +175 -0
- package/.claude/agents/clarify-analyst.md +50 -0
- package/.claude/agents/code-reviewer.md +71 -0
- package/.claude/agents/codex-analyzer.md +39 -0
- package/.claude/agents/compatibility-checker.md +580 -0
- package/.claude/agents/consistency-checker.md +532 -0
- package/.claude/agents/impact-analyzer.md +441 -0
- package/.claude/agents/planner.md +230 -0
- package/.claude/agents/prd-writer.md +320 -0
- package/.claude/agents/project-guidelines-generator.md +1329 -0
- package/.claude/agents/qa-tester.md +313 -0
- package/.claude/agents/release-manager.md +295 -0
- package/.claude/agents/security-reviewer.md +314 -0
- package/.claude/agents/style-guide-generator.md +458 -0
- package/.claude/agents/tech-architect.md +516 -0
- package/.claude/agents/ui-designer.md +485 -0
- package/.claude/commands/code-review-high.md +58 -0
- package/.claude/commands/core-architecture.md +429 -0
- package/.claude/commands/core-guidelines.md +486 -0
- package/.claude/commands/core-roadmap.md +439 -0
- package/.claude/commands/core-style.md +293 -0
- package/.claude/commands/flow-archive.md +245 -0
- package/.claude/commands/flow-checklist.md +260 -0
- package/.claude/commands/flow-clarify.md +136 -0
- package/.claude/commands/flow-constitution.md +82 -0
- package/.claude/commands/flow-dev.md +134 -0
- package/.claude/commands/flow-epic.md +150 -0
- package/.claude/commands/flow-fix.md +104 -0
- package/.claude/commands/flow-ideate.md +214 -0
- package/.claude/commands/flow-init.md +313 -0
- package/.claude/commands/flow-new.md +394 -0
- package/.claude/commands/flow-prd.md +131 -0
- package/.claude/commands/flow-qa.md +93 -0
- package/.claude/commands/flow-release.md +92 -0
- package/.claude/commands/flow-restart.md +98 -0
- package/.claude/commands/flow-status.md +64 -0
- package/.claude/commands/flow-tech.md +142 -0
- package/.claude/commands/flow-ui.md +189 -0
- package/.claude/commands/flow-update.md +111 -0
- package/.claude/commands/flow-upgrade.md +115 -0
- package/.claude/commands/flow-verify.md +96 -0
- package/.claude/commands/problem-analyzer.md +60 -0
- package/.claude/config/quality-rules.yml +161 -0
- package/.claude/docs/SPEC_KIT_CONSTITUTION_ANALYSIS.md +426 -0
- package/.claude/docs/design/consistency-conflict-detection-algorithms.md +658 -0
- package/.claude/docs/design/intent-driven-input-design.md +380 -0
- package/.claude/docs/design/prd-version-management-design.md +437 -0
- package/.claude/docs/guides/INIT_TROUBLESHOOTING.md +117 -0
- package/.claude/docs/guides/NEW_TROUBLESHOOTING.md +151 -0
- package/.claude/docs/guides/ROADMAP_TROUBLESHOOTING.md +188 -0
- package/.claude/docs/guides/TASK_COMPLETION_MARKING.md +338 -0
- package/.claude/docs/templates/ARCHITECTURE_TEMPLATE.md +633 -0
- package/.claude/docs/templates/BACKLOG_TEMPLATE.md +261 -0
- package/.claude/docs/templates/CHECKLIST_TEMPLATE.md +52 -0
- package/.claude/docs/templates/CLARIFICATION_REPORT_TEMPLATE.md +206 -0
- package/.claude/docs/templates/CODE_REVIEW_TEMPLATE.md +71 -0
- package/.claude/docs/templates/EPIC_TEMPLATE.md +805 -0
- package/.claude/docs/templates/INIT_FLOW_TEMPLATE.md +213 -0
- package/.claude/docs/templates/INTENT_CLARIFICATION_TEMPLATE.md +57 -0
- package/.claude/docs/templates/NEW_ORCHESTRATION_TEMPLATE.md +148 -0
- package/.claude/docs/templates/PRD_TEMPLATE.md +562 -0
- package/.claude/docs/templates/RESEARCH_TEMPLATE.md +276 -0
- package/.claude/docs/templates/REVIEW-HIGH.md +57 -0
- package/.claude/docs/templates/ROADMAP_DIALOGUE_TEMPLATE.md +198 -0
- package/.claude/docs/templates/ROADMAP_TEMPLATE.md +310 -0
- package/.claude/docs/templates/STYLE_TEMPLATE.md +1266 -0
- package/.claude/docs/templates/TASKS_TEMPLATE.md +523 -0
- package/.claude/docs/templates/TECH_DESIGN_TEMPLATE.md +1019 -0
- package/.claude/docs/templates/UI_PROTOTYPE_TEMPLATE.md +1436 -0
- package/.claude/guides/agent-guides/agent-coordination-guide.md +459 -0
- package/.claude/guides/project-guidelines-system.md +463 -0
- package/.claude/guides/technical-guides/datetime-handling-guide.md +563 -0
- package/.claude/guides/technical-guides/git-github-guide.md +642 -0
- package/.claude/guides/technical-guides/test-execution-guide.md +618 -0
- package/.claude/guides/workflow-guides/bug-fix-orchestrator.md +217 -0
- package/.claude/guides/workflow-guides/flow-orchestrator.md +282 -0
- package/.claude/hooks/checklist-gate.js +397 -0
- package/.claude/hooks/error-handling-reminder.sh +12 -0
- package/.claude/hooks/error-handling-reminder.ts +459 -0
- package/.claude/hooks/post-tool-use-tracker.sh +280 -0
- package/.claude/hooks/pre-tool-use-guardrail.sh +36 -0
- package/.claude/hooks/pre-tool-use-guardrail.ts +342 -0
- package/.claude/hooks/skill-activation-prompt.sh +36 -0
- package/.claude/hooks/skill-activation-prompt.ts +214 -0
- package/.claude/hooks/state/skills-used-test-guard.json +3 -0
- package/.claude/rules/devflow-conventions.md +305 -0
- package/.claude/rules/project-constitution.md +748 -0
- package/.claude/schemas/constitution.schema.json +43 -0
- package/.claude/scripts/analyze-upgrade-impact.sh +200 -0
- package/.claude/scripts/archive-requirement.sh +351 -0
- package/.claude/scripts/calculate-checklist-completion.sh +243 -0
- package/.claude/scripts/calculate-quarter.sh +206 -0
- package/.claude/scripts/check-dependencies.sh +409 -0
- package/.claude/scripts/check-prerequisites.sh +232 -0
- package/.claude/scripts/check-task-status.sh +264 -0
- package/.claude/scripts/checklist-errors.sh +131 -0
- package/.claude/scripts/common.sh +570 -0
- package/.claude/scripts/consolidate-research.sh +182 -0
- package/.claude/scripts/create-requirement.sh +426 -0
- package/.claude/scripts/export-contracts.sh +117 -0
- package/.claude/scripts/extract-data-model.sh +78 -0
- package/.claude/scripts/generate-clarification-questions.sh +377 -0
- package/.claude/scripts/generate-clarification-report.sh +463 -0
- package/.claude/scripts/generate-quickstart.sh +146 -0
- package/.claude/scripts/generate-research-tasks.sh +157 -0
- package/.claude/scripts/generate-status-report.sh +523 -0
- package/.claude/scripts/generate-tech-analysis.sh +46 -0
- package/.claude/scripts/locate-requirement-in-roadmap.sh +233 -0
- package/.claude/scripts/manage-constitution.sh +602 -0
- package/.claude/scripts/mark-task-complete.sh +198 -0
- package/.claude/scripts/populate-research-tasks.sh +259 -0
- package/.claude/scripts/recover-workflow.sh +460 -0
- package/.claude/scripts/run-clarify-scan.sh +601 -0
- package/.claude/scripts/run-high-review.sh +62 -0
- package/.claude/scripts/run-problem-analysis.sh +68 -0
- package/.claude/scripts/setup-epic.sh +173 -0
- package/.claude/scripts/sync-roadmap-progress.sh +300 -0
- package/.claude/scripts/sync-task-marks.sh +199 -0
- package/.claude/scripts/test-clarify-scan.sh +515 -0
- package/.claude/scripts/update-agent-context.sh +806 -0
- package/.claude/scripts/validate-constitution.sh +567 -0
- package/.claude/scripts/validate-hooks.sh +487 -0
- package/.claude/scripts/validate-research.sh +332 -0
- package/.claude/scripts/validate-scope-boundary.sh +493 -0
- package/.claude/scripts/verify-setup.sh +37 -0
- package/.claude/settings.json +76 -0
- package/.claude/skills/_reference-implementations/README.md +96 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/SKILL.md +302 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/architecture-overview.md +451 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/async-and-errors.md +307 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/complete-examples.md +638 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/configuration.md +275 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/database-patterns.md +224 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/middleware-guide.md +213 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/routing-and-controllers.md +756 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/sentry-and-monitoring.md +336 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/services-and-repositories.md +789 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/testing-guide.md +235 -0
- package/.claude/skills/_reference-implementations/backend-express-prisma/resources/validation-patterns.md +754 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/SKILL.md +399 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/common-patterns.md +331 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/complete-examples.md +872 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/component-patterns.md +502 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/data-fetching.md +767 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/file-organization.md +502 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/loading-and-error-states.md +501 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/performance.md +406 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/routing-guide.md +364 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/styling-guide.md +428 -0
- package/.claude/skills/_reference-implementations/frontend-react-mui/resources/typescript-standards.md +418 -0
- package/.claude/skills/cc-devflow-orchestrator/SKILL.md +229 -0
- package/.claude/skills/constitution-guardian/SKILL.md +306 -0
- package/.claude/skills/devflow-constitution-quick-ref/SKILL.md +374 -0
- package/.claude/skills/devflow-file-standards/SKILL.md +353 -0
- package/.claude/skills/devflow-tdd-enforcer/SKILL.md +192 -0
- package/.claude/skills/skill-developer/ADVANCED.md +197 -0
- package/.claude/skills/skill-developer/HOOK_MECHANISMS.md +306 -0
- package/.claude/skills/skill-developer/PATTERNS_LIBRARY.md +152 -0
- package/.claude/skills/skill-developer/SKILL.md +426 -0
- package/.claude/skills/skill-developer/SKILL_RULES_REFERENCE.md +315 -0
- package/.claude/skills/skill-developer/TRIGGER_TYPES.md +305 -0
- package/.claude/skills/skill-developer/TROUBLESHOOTING.md +514 -0
- package/.claude/skills/skill-rules.json +213 -0
- package/.claude/tests/README.md +300 -0
- package/.claude/tests/TODO.md +69 -0
- package/.claude/tests/__pycache__/test_analyze_upgrade_impact.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_consolidate_research.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_export_contracts.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_extract_data_model.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_generate_quickstart.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/__pycache__/test_generate_research_tasks.cpython-311-pytest-7.2.2.pyc +0 -0
- package/.claude/tests/constitution/run_all_constitution_tests.sh +111 -0
- package/.claude/tests/constitution/test_agent_assignment.sh +207 -0
- package/.claude/tests/constitution/test_article_coverage.sh +201 -0
- package/.claude/tests/constitution/test_template_completeness.sh +150 -0
- package/.claude/tests/constitution/test_version_consistency.sh +120 -0
- package/.claude/tests/fixtures/spec_delta_full.md +16 -0
- package/.claude/tests/fixtures/tasks_progress_sample.md +5 -0
- package/.claude/tests/run-all-tests.sh +229 -0
- package/.claude/tests/scripts/run.sh +30 -0
- package/.claude/tests/scripts/test-framework.sh +128 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh +511 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak +504 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak2 +505 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak3 +506 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak4 +507 -0
- package/.claude/tests/scripts/test_check_prerequisites.sh.bak5 +508 -0
- package/.claude/tests/scripts/test_check_task_status.sh +499 -0
- package/.claude/tests/scripts/test_common.sh +244 -0
- package/.claude/tests/scripts/test_generate_status_report.sh +71 -0
- package/.claude/tests/scripts/test_mark_task_complete.sh +441 -0
- package/.claude/tests/scripts/test_mark_task_complete.sh.backup +410 -0
- package/.claude/tests/scripts/test_recover_workflow.sh +304 -0
- package/.claude/tests/scripts/test_setup_epic.sh +437 -0
- package/.claude/tests/scripts/test_sync_task_marks.sh +196 -0
- package/.claude/tests/scripts/test_validate_constitution.sh +74 -0
- package/.claude/tests/scripts/test_validate_research.sh +462 -0
- package/.claude/tests/slugify.bats +82 -0
- package/.claude/tests/test-framework.sh +732 -0
- package/.claude/tests/test_analyze_upgrade_impact.py +34 -0
- package/.claude/tests/test_consolidate_research.py +48 -0
- package/.claude/tests/test_export_contracts.py +43 -0
- package/.claude/tests/test_extract_data_model.py +33 -0
- package/.claude/tests/test_generate_quickstart.py +50 -0
- package/.claude/tests/test_generate_research_tasks.py +52 -0
- package/.claude/tsc-cache/6e64f818-6398-49ca-8623-581a9af85c44/edited-files.log +1 -0
- package/.claude/tsc-cache/795ba6e3-b98a-423b-bab2-51aa62812569/affected-repos.txt +1 -0
- package/.claude/tsc-cache/795ba6e3-b98a-423b-bab2-51aa62812569/edited-files.log +1 -0
- package/.claude/tsc-cache/ae335694-be5a-4ba4-a1a0-b676c09a7906/affected-repos.txt +1 -0
- package/.claude/tsc-cache/ae335694-be5a-4ba4-a1a0-b676c09a7906/edited-files.log +1 -0
- package/CHANGELOG.md +507 -0
- package/LICENSE +21 -0
- package/README.md +534 -0
- package/README.zh-CN.md +530 -0
- package/bin/adapt.js +240 -0
- package/bin/cc-devflow-cli.js +185 -0
- package/bin/cc-devflow.js +78 -0
- package/config/adapters.yml +5 -0
- package/config/schema/adapters.schema.json +44 -0
- package/docs/CLAUDE.md +26 -0
- package/docs/commands/README.md +61 -0
- package/docs/commands/README.zh-CN.md +55 -0
- package/docs/commands/core-roadmap.md +106 -0
- package/docs/commands/core-roadmap.zh-CN.md +102 -0
- package/docs/commands/core-style.md +405 -0
- package/docs/commands/core-style.zh-CN.md +405 -0
- package/docs/commands/flow-init.md +134 -0
- package/docs/commands/flow-init.zh-CN.md +163 -0
- package/docs/commands/flow-new.md +274 -0
- package/docs/commands/flow-new.zh-CN.md +270 -0
- package/docs/guides/getting-started.md +204 -0
- package/docs/guides/getting-started.zh-CN.md +152 -0
- package/lib/adapters/adapter-interface.js +57 -0
- package/lib/adapters/claude-adapter.js +74 -0
- package/lib/adapters/codex-adapter.js +40 -0
- package/lib/adapters/config-validator.js +68 -0
- package/lib/adapters/logger.js +42 -0
- package/lib/adapters/registry.js +153 -0
- package/lib/compiler/CLAUDE.md +92 -0
- package/lib/compiler/__tests__/drift.test.js +215 -0
- package/lib/compiler/__tests__/errors.test.js +184 -0
- package/lib/compiler/__tests__/incremental.test.js +174 -0
- package/lib/compiler/__tests__/integration.test.js +174 -0
- package/lib/compiler/__tests__/manifest.test.js +233 -0
- package/lib/compiler/__tests__/parser.test.js +456 -0
- package/lib/compiler/__tests__/schemas.test.js +301 -0
- package/lib/compiler/__tests__/skills-registry.test.js +125 -0
- package/lib/compiler/__tests__/transformer.test.js +286 -0
- package/lib/compiler/emitters/antigravity-emitter.js +171 -0
- package/lib/compiler/emitters/base-emitter.js +73 -0
- package/lib/compiler/emitters/codex-emitter.js +52 -0
- package/lib/compiler/emitters/cursor-emitter.js +31 -0
- package/lib/compiler/emitters/index.js +50 -0
- package/lib/compiler/emitters/qwen-emitter.js +39 -0
- package/lib/compiler/errors.js +119 -0
- package/lib/compiler/index.js +256 -0
- package/lib/compiler/manifest.js +242 -0
- package/lib/compiler/parser.js +258 -0
- package/lib/compiler/platforms.js +113 -0
- package/lib/compiler/resource-copier.js +320 -0
- package/lib/compiler/rules-emitters/__tests__/antigravity-rules-emitter.test.js +191 -0
- package/lib/compiler/rules-emitters/__tests__/codex-rules-emitter.test.js +109 -0
- package/lib/compiler/rules-emitters/__tests__/cursor-rules-emitter.test.js +123 -0
- package/lib/compiler/rules-emitters/__tests__/qwen-rules-emitter.test.js +123 -0
- package/lib/compiler/rules-emitters/antigravity-rules-emitter.js +253 -0
- package/lib/compiler/rules-emitters/base-rules-emitter.js +83 -0
- package/lib/compiler/rules-emitters/codex-rules-emitter.js +116 -0
- package/lib/compiler/rules-emitters/cursor-rules-emitter.js +98 -0
- package/lib/compiler/rules-emitters/index.js +71 -0
- package/lib/compiler/rules-emitters/qwen-rules-emitter.js +70 -0
- package/lib/compiler/schemas.js +144 -0
- package/lib/compiler/skills-registry.js +225 -0
- package/lib/compiler/transformer.js +236 -0
- package/package.json +50 -0
package/.claude/skills/_reference-implementations/frontend-react-mui/resources/styling-guide.md
ADDED
|
@@ -0,0 +1,428 @@
|
|
|
1
|
+
# Styling Guide
|
|
2
|
+
|
|
3
|
+
Modern styling patterns for using MUI v7 sx prop, inline styles, and theme integration.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Inline vs Separate Styles
|
|
8
|
+
|
|
9
|
+
### Decision Threshold
|
|
10
|
+
|
|
11
|
+
**<100 lines: Inline styles at top of component**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
15
|
+
|
|
16
|
+
const componentStyles: Record<string, SxProps<Theme>> = {
|
|
17
|
+
container: {
|
|
18
|
+
p: 2,
|
|
19
|
+
display: 'flex',
|
|
20
|
+
flexDirection: 'column',
|
|
21
|
+
},
|
|
22
|
+
header: {
|
|
23
|
+
mb: 2,
|
|
24
|
+
borderBottom: '1px solid',
|
|
25
|
+
borderColor: 'divider',
|
|
26
|
+
},
|
|
27
|
+
// ... more styles
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
export const MyComponent: React.FC = () => {
|
|
31
|
+
return (
|
|
32
|
+
<Box sx={componentStyles.container}>
|
|
33
|
+
<Box sx={componentStyles.header}>
|
|
34
|
+
<h2>Title</h2>
|
|
35
|
+
</Box>
|
|
36
|
+
</Box>
|
|
37
|
+
);
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**>100 lines: Separate `.styles.ts` file**
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
// MyComponent.styles.ts
|
|
45
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
46
|
+
|
|
47
|
+
export const componentStyles: Record<string, SxProps<Theme>> = {
|
|
48
|
+
container: { ... },
|
|
49
|
+
header: { ... },
|
|
50
|
+
// ... 100+ lines of styles
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
// MyComponent.tsx
|
|
54
|
+
import { componentStyles } from './MyComponent.styles';
|
|
55
|
+
|
|
56
|
+
export const MyComponent: React.FC = () => {
|
|
57
|
+
return <Box sx={componentStyles.container}>...</Box>;
|
|
58
|
+
};
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Real Example: UnifiedForm.tsx
|
|
62
|
+
|
|
63
|
+
**Lines 48-126**: 78 lines of inline styles (acceptable)
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
const formStyles: Record<string, SxProps<Theme>> = {
|
|
67
|
+
gridContainer: {
|
|
68
|
+
height: '100%',
|
|
69
|
+
maxHeight: 'calc(100vh - 220px)',
|
|
70
|
+
},
|
|
71
|
+
section: {
|
|
72
|
+
height: '100%',
|
|
73
|
+
maxHeight: 'calc(100vh - 220px)',
|
|
74
|
+
overflow: 'auto',
|
|
75
|
+
p: 4,
|
|
76
|
+
},
|
|
77
|
+
// ... 15 more style objects
|
|
78
|
+
};
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**Guideline**: User is comfortable with ~80 lines inline. Use your judgment around 100 lines.
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## sx Prop Patterns
|
|
86
|
+
|
|
87
|
+
### Basic Usage
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
<Box sx={{ p: 2, mb: 3, display: 'flex' }}>
|
|
91
|
+
Content
|
|
92
|
+
</Box>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### With Theme Access
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
<Box
|
|
99
|
+
sx={{
|
|
100
|
+
p: 2,
|
|
101
|
+
backgroundColor: (theme) => theme.palette.primary.main,
|
|
102
|
+
color: (theme) => theme.palette.primary.contrastText,
|
|
103
|
+
borderRadius: (theme) => theme.shape.borderRadius,
|
|
104
|
+
}}
|
|
105
|
+
>
|
|
106
|
+
Themed Box
|
|
107
|
+
</Box>
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Responsive Styles
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
<Box
|
|
114
|
+
sx={{
|
|
115
|
+
p: { xs: 1, sm: 2, md: 3 },
|
|
116
|
+
width: { xs: '100%', md: '50%' },
|
|
117
|
+
flexDirection: { xs: 'column', md: 'row' },
|
|
118
|
+
}}
|
|
119
|
+
>
|
|
120
|
+
Responsive Layout
|
|
121
|
+
</Box>
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Pseudo-Selectors
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
<Box
|
|
128
|
+
sx={{
|
|
129
|
+
p: 2,
|
|
130
|
+
'&:hover': {
|
|
131
|
+
backgroundColor: 'rgba(0,0,0,0.05)',
|
|
132
|
+
},
|
|
133
|
+
'&:active': {
|
|
134
|
+
backgroundColor: 'rgba(0,0,0,0.1)',
|
|
135
|
+
},
|
|
136
|
+
'& .child-class': {
|
|
137
|
+
color: 'primary.main',
|
|
138
|
+
},
|
|
139
|
+
}}
|
|
140
|
+
>
|
|
141
|
+
Interactive Box
|
|
142
|
+
</Box>
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## MUI v7 Patterns
|
|
148
|
+
|
|
149
|
+
### Grid Component (v7 Syntax)
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
import { Grid } from '@mui/material';
|
|
153
|
+
|
|
154
|
+
// ✅ CORRECT - v7 syntax with size prop
|
|
155
|
+
<Grid container spacing={2}>
|
|
156
|
+
<Grid size={{ xs: 12, md: 6 }}>
|
|
157
|
+
Left Column
|
|
158
|
+
</Grid>
|
|
159
|
+
<Grid size={{ xs: 12, md: 6 }}>
|
|
160
|
+
Right Column
|
|
161
|
+
</Grid>
|
|
162
|
+
</Grid>
|
|
163
|
+
|
|
164
|
+
// ❌ WRONG - Old v6 syntax
|
|
165
|
+
<Grid container spacing={2}>
|
|
166
|
+
<Grid xs={12} md={6}> {/* OLD - Don't use */}
|
|
167
|
+
Content
|
|
168
|
+
</Grid>
|
|
169
|
+
</Grid>
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
**Key Change**: `size={{ xs: 12, md: 6 }}` instead of `xs={12} md={6}`
|
|
173
|
+
|
|
174
|
+
### Responsive Grid
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
<Grid container spacing={3}>
|
|
178
|
+
<Grid size={{ xs: 12, sm: 6, md: 4, lg: 3 }}>
|
|
179
|
+
Responsive Column
|
|
180
|
+
</Grid>
|
|
181
|
+
</Grid>
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Nested Grids
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
<Grid container spacing={2}>
|
|
188
|
+
<Grid size={{ xs: 12, md: 8 }}>
|
|
189
|
+
<Grid container spacing={1}>
|
|
190
|
+
<Grid size={{ xs: 12, sm: 6 }}>
|
|
191
|
+
Nested 1
|
|
192
|
+
</Grid>
|
|
193
|
+
<Grid size={{ xs: 12, sm: 6 }}>
|
|
194
|
+
Nested 2
|
|
195
|
+
</Grid>
|
|
196
|
+
</Grid>
|
|
197
|
+
</Grid>
|
|
198
|
+
|
|
199
|
+
<Grid size={{ xs: 12, md: 4 }}>
|
|
200
|
+
Sidebar
|
|
201
|
+
</Grid>
|
|
202
|
+
</Grid>
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Type-Safe Styles
|
|
208
|
+
|
|
209
|
+
### Style Object Type
|
|
210
|
+
|
|
211
|
+
```typescript
|
|
212
|
+
import type { SxProps, Theme } from '@mui/material';
|
|
213
|
+
|
|
214
|
+
// Type-safe styles
|
|
215
|
+
const styles: Record<string, SxProps<Theme>> = {
|
|
216
|
+
container: {
|
|
217
|
+
p: 2,
|
|
218
|
+
// Autocomplete and type checking work here
|
|
219
|
+
},
|
|
220
|
+
};
|
|
221
|
+
|
|
222
|
+
// Or individual style
|
|
223
|
+
const containerStyle: SxProps<Theme> = {
|
|
224
|
+
p: 2,
|
|
225
|
+
display: 'flex',
|
|
226
|
+
};
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Theme-Aware Styles
|
|
230
|
+
|
|
231
|
+
```typescript
|
|
232
|
+
const styles: Record<string, SxProps<Theme>> = {
|
|
233
|
+
primary: {
|
|
234
|
+
color: (theme) => theme.palette.primary.main,
|
|
235
|
+
backgroundColor: (theme) => theme.palette.primary.light,
|
|
236
|
+
'&:hover': {
|
|
237
|
+
backgroundColor: (theme) => theme.palette.primary.dark,
|
|
238
|
+
},
|
|
239
|
+
},
|
|
240
|
+
customSpacing: {
|
|
241
|
+
padding: (theme) => theme.spacing(2),
|
|
242
|
+
margin: (theme) => theme.spacing(1, 2), // top/bottom: 1, left/right: 2
|
|
243
|
+
},
|
|
244
|
+
};
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## What NOT to Use
|
|
250
|
+
|
|
251
|
+
### ❌ makeStyles (MUI v4 pattern)
|
|
252
|
+
|
|
253
|
+
```typescript
|
|
254
|
+
// ❌ AVOID - Old Material-UI v4 pattern
|
|
255
|
+
import { makeStyles } from '@mui/styles';
|
|
256
|
+
|
|
257
|
+
const useStyles = makeStyles((theme) => ({
|
|
258
|
+
root: {
|
|
259
|
+
padding: theme.spacing(2),
|
|
260
|
+
},
|
|
261
|
+
}));
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
**Why avoid**: Deprecated, v7 doesn't support it well
|
|
265
|
+
|
|
266
|
+
### ❌ styled() Components
|
|
267
|
+
|
|
268
|
+
```typescript
|
|
269
|
+
// ❌ AVOID - styled-components pattern
|
|
270
|
+
import { styled } from '@mui/material/styles';
|
|
271
|
+
|
|
272
|
+
const StyledBox = styled(Box)(({ theme }) => ({
|
|
273
|
+
padding: theme.spacing(2),
|
|
274
|
+
}));
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
**Why avoid**: sx prop is more flexible and doesn't create new components
|
|
278
|
+
|
|
279
|
+
### ✅ Use sx Prop Instead
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
// ✅ PREFERRED
|
|
283
|
+
<Box
|
|
284
|
+
sx={{
|
|
285
|
+
p: 2,
|
|
286
|
+
backgroundColor: 'primary.main',
|
|
287
|
+
}}
|
|
288
|
+
>
|
|
289
|
+
Content
|
|
290
|
+
</Box>
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## Code Style Standards
|
|
296
|
+
|
|
297
|
+
### Indentation
|
|
298
|
+
|
|
299
|
+
**4 spaces** (not 2, not tabs)
|
|
300
|
+
|
|
301
|
+
```typescript
|
|
302
|
+
const styles: Record<string, SxProps<Theme>> = {
|
|
303
|
+
container: {
|
|
304
|
+
p: 2,
|
|
305
|
+
display: 'flex',
|
|
306
|
+
flexDirection: 'column',
|
|
307
|
+
},
|
|
308
|
+
};
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Quotes
|
|
312
|
+
|
|
313
|
+
**Single quotes** for strings (project standard)
|
|
314
|
+
|
|
315
|
+
```typescript
|
|
316
|
+
// ✅ CORRECT
|
|
317
|
+
const color = 'primary.main';
|
|
318
|
+
import { Box } from '@mui/material';
|
|
319
|
+
|
|
320
|
+
// ❌ WRONG
|
|
321
|
+
const color = "primary.main";
|
|
322
|
+
import { Box } from "@mui/material";
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### Trailing Commas
|
|
326
|
+
|
|
327
|
+
**Always use trailing commas** in objects and arrays
|
|
328
|
+
|
|
329
|
+
```typescript
|
|
330
|
+
// ✅ CORRECT
|
|
331
|
+
const styles = {
|
|
332
|
+
container: { p: 2 },
|
|
333
|
+
header: { mb: 1 }, // Trailing comma
|
|
334
|
+
};
|
|
335
|
+
|
|
336
|
+
const items = [
|
|
337
|
+
'item1',
|
|
338
|
+
'item2', // Trailing comma
|
|
339
|
+
];
|
|
340
|
+
|
|
341
|
+
// ❌ WRONG - No trailing comma
|
|
342
|
+
const styles = {
|
|
343
|
+
container: { p: 2 },
|
|
344
|
+
header: { mb: 1 } // Missing comma
|
|
345
|
+
};
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## Common Style Patterns
|
|
351
|
+
|
|
352
|
+
### Flexbox Layout
|
|
353
|
+
|
|
354
|
+
```typescript
|
|
355
|
+
const styles = {
|
|
356
|
+
flexRow: {
|
|
357
|
+
display: 'flex',
|
|
358
|
+
flexDirection: 'row',
|
|
359
|
+
alignItems: 'center',
|
|
360
|
+
gap: 2,
|
|
361
|
+
},
|
|
362
|
+
flexColumn: {
|
|
363
|
+
display: 'flex',
|
|
364
|
+
flexDirection: 'column',
|
|
365
|
+
gap: 1,
|
|
366
|
+
},
|
|
367
|
+
spaceBetween: {
|
|
368
|
+
display: 'flex',
|
|
369
|
+
justifyContent: 'space-between',
|
|
370
|
+
alignItems: 'center',
|
|
371
|
+
},
|
|
372
|
+
};
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Spacing
|
|
376
|
+
|
|
377
|
+
```typescript
|
|
378
|
+
// Padding
|
|
379
|
+
p: 2 // All sides
|
|
380
|
+
px: 2 // Horizontal (left + right)
|
|
381
|
+
py: 2 // Vertical (top + bottom)
|
|
382
|
+
pt: 2, pr: 1 // Specific sides
|
|
383
|
+
|
|
384
|
+
// Margin
|
|
385
|
+
m: 2, mx: 2, my: 2, mt: 2, mr: 1
|
|
386
|
+
|
|
387
|
+
// Units: 1 = 8px (theme.spacing(1))
|
|
388
|
+
p: 2 // = 16px
|
|
389
|
+
p: 0.5 // = 4px
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Positioning
|
|
393
|
+
|
|
394
|
+
```typescript
|
|
395
|
+
const styles = {
|
|
396
|
+
relative: {
|
|
397
|
+
position: 'relative',
|
|
398
|
+
},
|
|
399
|
+
absolute: {
|
|
400
|
+
position: 'absolute',
|
|
401
|
+
top: 0,
|
|
402
|
+
right: 0,
|
|
403
|
+
},
|
|
404
|
+
sticky: {
|
|
405
|
+
position: 'sticky',
|
|
406
|
+
top: 0,
|
|
407
|
+
zIndex: 1000,
|
|
408
|
+
},
|
|
409
|
+
};
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
## Summary
|
|
415
|
+
|
|
416
|
+
**Styling Checklist:**
|
|
417
|
+
- ✅ Use `sx` prop for MUI styling
|
|
418
|
+
- ✅ Type-safe with `SxProps<Theme>`
|
|
419
|
+
- ✅ <100 lines: inline; >100 lines: separate file
|
|
420
|
+
- ✅ MUI v7 Grid: `size={{ xs: 12 }}`
|
|
421
|
+
- ✅ 4 space indentation
|
|
422
|
+
- ✅ Single quotes
|
|
423
|
+
- ✅ Trailing commas
|
|
424
|
+
- ❌ No makeStyles or styled()
|
|
425
|
+
|
|
426
|
+
**See Also:**
|
|
427
|
+
- [component-patterns.md](component-patterns.md) - Component structure
|
|
428
|
+
- [complete-examples.md](complete-examples.md) - Full styling examples
|