a27e3b8e43
Optimized the root .gitignore to exclude virtual environments, node modules, and temp folders to ensure clean and lightweight version tracking. Co-authored-by: Cursor <cursoragent@cursor.com>
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
---
|
|
name: ant-design
|
|
description: Single-file decision guide for antd 6.x, Ant Design Pro 5/ProComponents, and Ant Design X v2. Use for component selection, theming/tokens, SSR, a11y, performance, routing/access/CRUD, and AI/chat UI patterns.
|
|
---
|
|
|
|
# Ant Design
|
|
|
|
## S - Scope
|
|
- Target: `antd@^6` + React 18-19, with `ant-design-pro@^5` / `@ant-design/pro-components` and `@ant-design/x@^2` when needed.
|
|
- Focus: decision guidance only; no end-user tutorials.
|
|
- Source policy: official docs only; no undocumented APIs or internal `.ant-*` coupling.
|
|
|
|
### Default assumptions
|
|
- Language: TypeScript.
|
|
- Styling: tokens first, then `classNames`/`styles`; avoid global overrides.
|
|
- Provider: one root `ConfigProvider` unless strict isolation is required.
|
|
|
|
### Mandatory rules
|
|
- For component questions, first map the component name to the official route slug `{components}` (lowercase kebab-case, e.g. `TreeSelect -> tree-select`, `Button -> button`), then request docs in this order (CN first, EN fallback):
|
|
1. `https://ant.design/components/{components}-cn`
|
|
2. `https://ant.design/components/{components}`
|
|
- Examples: `tree-select-cn -> tree-select`, `button-cn -> button`.
|
|
- Use only documented antd/Pro/X APIs.
|
|
- Do not invent props/events/component names.
|
|
- Do not rely on internal DOM or `.ant-*` selectors.
|
|
- Theme priority: global tokens -> component tokens -> alias tokens.
|
|
|
|
## P - Process
|
|
### 1) Classify
|
|
- Identify layer: core antd, Pro, or X.
|
|
- Confirm version, rendering mode (CSR/SSR/streaming), and data scale.
|
|
|
|
### 2) Request docs
|
|
- For each component, request `-cn.md` first, then `.md` fallback.
|
|
- If multiple components are involved, request each component page before deciding.
|
|
|
|
### 3) Decide
|
|
- Provider baseline: CSR -> `ConfigProvider`; SSR -> `ConfigProvider` + `StyleProvider`.
|
|
- Theming baseline: global tokens -> component tokens -> `classNames`/`styles`.
|
|
- Output recommendation + risk + verification points (SSR/a11y/perf).
|
|
|
|
## O - Output
|
|
- Provide short decision rationale (1-3 sentences).
|
|
- Include minimal provider/theming strategy.
|
|
- Include concrete SSR/a11y/perf checks.
|
|
- For Pro: include route/menu/access and CRUD schema direction.
|
|
- For X: include message/tool schema and streaming state direction.
|
|
|
|
## Regression checklist
|
|
- [ ] One root `ConfigProvider`; SSR style order/hydration verified.
|
|
- [ ] Tokens first; no broad global `.ant-*` overrides.
|
|
- [ ] Table has stable `rowKey`; sort/filter/pagination entry is unified.
|
|
- [ ] Select remote mode disables local filter when using remote search.
|
|
- [ ] Upload controlled/uncontrolled mode is explicit with failure/retry path.
|
|
- [ ] Pro route/menu/access remain consistent with backend enforcement.
|
|
- [ ] X streaming supports stop/retry and deterministic tool rendering.
|