| name | ant-design-react |
| description | Provides comprehensive guidance for Ant Design React component library including components, design system, themes, and TypeScript support. Use when the user asks about Ant Design for React, needs to build React applications with Ant Design, or implement design system patterns. |
| license | Complete terms in LICENSE.txt |
When to use this skill
Use this skill whenever the user wants to:
- Build React applications with Ant Design components
- Use Ant Design UI components (Button, Form, Table, Input, Select, etc.)
- Customize Ant Design theme and styles
- Implement internationalization (i18n) with Ant Design
- Use Ant Design with TypeScript
- Create forms with validation
- Display data in tables and lists
- Implement navigation and layout
- Use Ant Design icons
- Handle user feedback (Modal, Message, Notification)
- Implement data visualization components
- Use Ant Design design tokens and design system
How to use this skill
This skill is organized to match the Ant Design React official documentation structure (https://4x-ant-design.antgroup.com/docs/react/introduce-cn, https://4x-ant-design.antgroup.com/components/overview-cn/). When working with Ant Design React:
-
Identify the topic from the user's request:
- Getting started/快速开始 →
examples/getting-started/installation.md or examples/getting-started/basic-usage.md
- Button/按钮 →
examples/components/button.md
- Form/表单 →
examples/components/form.md
- Table/表格 →
examples/components/table.md
- Input/输入框 →
examples/components/input.md
- Select/选择器 →
examples/components/select.md
- DatePicker/日期选择器 →
examples/components/date-picker.md
- Modal/对话框 →
examples/components/modal.md
- Layout/布局 →
examples/components/layout.md
- Menu/菜单 →
examples/components/menu.md
- Theme customization/主题定制 →
examples/advanced/theme-customization.md
- Internationalization/国际化 →
examples/advanced/internationalization.md
- TypeScript/类型支持 →
examples/advanced/typescript.md
-
Load the appropriate example file from the examples/ directory:
Getting Started (快速开始) - examples/getting-started/:
examples/getting-started/installation.md - Installing Ant Design and basic setupexamples/getting-started/basic-usage.md - Basic component usage
Components (组件) - examples/components/:
examples/components/button.md - Button componentexamples/components/input.md - Input componentexamples/components/form.md - Form component with validationexamples/components/table.md - Table componentexamples/components/select.md - Select componentexamples/components/date-picker.md - DatePicker componentexamples/components/modal.md - Modal componentexamples/components/layout.md - Layout componentexamples/components/menu.md - Menu componentexamples/components/icon.md - Icon componentexamples/components/typography.md - Typography componentexamples/components/grid.md - Grid componentexamples/components/space.md - Space componentexamples/components/card.md - Card componentexamples/components/tabs.md - Tabs componentexamples/components/pagination.md - Pagination componentexamples/components/upload.md - Upload componentexamples/components/upload.md - Upload componentexamples/components/message.md - Message componentexamples/components/notification.md - Notification componentexamples/components/alert.md - Alert componentexamples/components/spin.md - Spin componentexamples/components/progress.md - Progress component
Advanced (高级) - examples/advanced/:
-
Follow the specific instructions in that example file for syntax, structure, and best practices
Important Notes:
- All examples follow Ant Design React 4.x API
- Examples include both JavaScript and TypeScript versions where applicable
- Each example file includes key concepts, code examples, and key points
- Always check the example file for best practices and common patterns
-
Reference API documentation in the api/ directory when needed:
api/components.md - Component API referenceapi/config-provider.md - ConfigProvider APIapi/design-tokens.md - Design tokens API
-
Use templates from the templates/ directory:
templates/project-setup.md - Project setup templatestemplates/component-template.md - Component usage templates
Doc mapping (one-to-one with official documentation)
Guide (指南):
Components (组件):
Examples and Templates
This skill includes detailed examples organized to match the official documentation structure. All examples are in the examples/ directory (see mapping above).
To use examples:
- Identify the topic from the user's request
- Load the appropriate example file from the mapping above
- Follow the instructions, syntax, and best practices in that file
- Adapt the code examples to your specific use case
To use templates:
- Reference templates in
templates/ directory for common scaffolding
- Adapt templates to your specific needs and coding style
API Reference
Detailed API documentation is available in the api/ directory, organized to match the official Ant Design React API documentation structure:
Components API (api/components.md)
- All component props and APIs
- Component methods and events
- Component types and interfaces
ConfigProvider API (api/config-provider.md)
- ConfigProvider component API
- Global configuration options
- Locale configuration
Design Tokens API (api/design-tokens.md)
- Design tokens reference
- Theme customization tokens
- CSS variables
To use API reference:
- Identify the API you need help with
- Load the corresponding API file from the
api/ directory
- Find the API signature, parameters, return type, and examples
- Reference the linked example files for detailed usage patterns
- All API files include links to relevant example files in the
examples/ directory
Best Practices
- Import styles: Import Ant Design CSS in your entry file
- Use ConfigProvider: Wrap your app with ConfigProvider for global configuration
- Form validation: Use Form component with validation rules
- TypeScript: Use TypeScript for better type safety
- Theme customization: Use design tokens for consistent theming
- Internationalization: Use ConfigProvider with locale for i18n
- Component composition: Compose components for complex UIs
- Performance: Use React.memo and useMemo for optimization
- Accessibility: Follow Ant Design accessibility guidelines
- Responsive design: Use Grid and responsive utilities
Resources
Keywords
Ant Design, Ant Design React, antd, React UI library, components, Button, Form, Table, Input, Select, DatePicker, Modal, Layout, Menu, theme, customization, internationalization, i18n, TypeScript, design system, 组件库, 按钮, 表单, 表格, 输入框, 选择器, 日期选择器, 对话框, 布局, 菜单, 主题, 国际化, 类型支持
