ant-design-mini
npx skills add https://smithery.ai
Agent 安装分布
Skill 文档
When to use this skill
Use this skill whenever the user wants to:
- Install and set up Ant Design Mini in a mini-program project
- Use Ant Design Mini components in Alipay Mini Program
- Use Ant Design Mini components in WeChat Mini Program
- Configure Ant Design Mini (theme, i18n, etc.)
- Use form components (Button, Input, Form, etc.)
- Use data display components (List, Card, etc.)
- Use feedback components (Toast, Modal, etc.)
- Use navigation components (Tabs, NavBar, etc.)
- Customize component styles
- Handle component events
- Understand Ant Design Mini API and methods
- Troubleshoot Ant Design Mini issues
How to use this skill
This skill is organized to match the Ant Design Mini official documentation structure (https://ant-design-mini.antgroup.com/guide/quick-start, https://ant-design-mini.antgroup.com/components/overview). When working with Ant Design Mini:
-
Identify the topic from the user’s request:
- Getting started/å¿«éå¼å§ â
examples/getting-started.md - Components/ç»ä»¶ â
examples/components/ - API/API ææ¡£ â
api/
- Getting started/å¿«éå¼å§ â
-
Load the appropriate example file from the
examples/directory:Getting Started (å¿«éå¼å§):
examples/getting-started.md– Installation and setupexamples/quick-start.md– Quick start guide
Components (ç»ä»¶):
examples/components/overview.md– Components overviewexamples/components/button.md– Button componentexamples/components/input.md– Input componentexamples/components/form.md– Form componentexamples/components/list.md– List componentexamples/components/card.md– Card componentexamples/components/toast.md– Toast componentexamples/components/modal.md– Modal componentexamples/components/tabs.md– Tabs componentexamples/components/nav-bar.md– NavBar componentexamples/components/picker.md– Picker componentexamples/components/date-picker.md– DatePicker componentexamples/components/switch.md– Switch componentexamples/components/checkbox.md– Checkbox componentexamples/components/radio.md– Radio componentexamples/components/stepper.md– Stepper componentexamples/components/avatar.md– Avatar componentexamples/components/badge.md– Badge componentexamples/components/tag.md– Tag componentexamples/components/empty.md– Empty componentexamples/components/loading.md– Loading componentexamples/components/popup.md– Popup componentexamples/components/action-sheet.md– ActionSheet component
-
Follow the specific instructions in that example file for syntax, structure, and best practices
Important Notes:
- Ant Design Mini is for Alipay Mini Program and WeChat Mini Program
- Components use mini-program syntax (axml/json)
- Examples include both Alipay and WeChat syntax
- Each example file includes key concepts, code examples, and key points
-
Reference API documentation in the
api/directory when needed:api/component-api.md– Component API referenceapi/props-and-events.md– Props and events reference
-
Use templates from the
templates/directory:templates/installation.md– Installation templatestemplates/component-usage.md– Component usage templates
1. Understanding Ant Design Mini
Ant Design Mini is a UI component library for Alipay Mini Program and WeChat Mini Program, following Ant Design design specifications.
Key Concepts:
- Mini Program Support: Alipay and WeChat Mini Programs
- Design System: Follows Ant Design design language
- Rich Components: Button, Form, List, Modal, etc.
- Theme Customization: Support for theme customization
- i18n: Internationalization support
2. Installation
Using npm:
npm install antd-mini
Using yarn:
yarn add antd-mini
Using pnpm:
pnpm add antd-mini
3. Basic Setup
// app.json (Alipay Mini Program)
{
"usingComponents": {
"ant-button": "antd-mini/es/Button/index"
}
}
<!-- page.axml -->
<ant-button type="primary" onTap="handleTap">Button</ant-button>
Doc mapping (one-to-one with official documentation)
Guide (æå):
- See guide files in
examples/guide/orexamples/getting-started/â https://ant-design-mini.antgroup.com/guide/quick-start
Components (ç»ä»¶):
- See component files in
examples/components/â https://ant-design-mini.antgroup.com/components/overview
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 Mini API documentation structure:
Component API (api/component-api.md)
- Component props and events
- Component methods
- Component slots
Props and Events (api/props-and-events.md)
- Common props
- Common events
- Event handling
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
- Register components: Register components in app.json or page.json
- Use correct syntax: Use axml for Alipay, wxml for WeChat
- Handle events: Use onTap for Alipay, bindtap for WeChat
- Customize theme: Use theme variables for customization
- Follow design specs: Follow Ant Design design specifications
Resources
- Official Documentation: https://ant-design-mini.antgroup.com/
- Quick Start: https://ant-design-mini.antgroup.com/guide/quick-start
- Components: https://ant-design-mini.antgroup.com/components/overview
- GitHub Repository: https://github.com/ant-design/ant-design-mini
Keywords
Ant Design Mini, ant-design-mini, antd-mini, mini program, Alipay Mini Program, WeChat Mini Program, å°ç¨åº, æ¯ä»å®å°ç¨åº, 微信å°ç¨åº, ç»ä»¶åº, UI components, Button, Form, List, Modal, Toast, Tabs, NavBar, æé®, 表å, å表, å¼¹çª, æç¤º, æ ç¾é¡µ, å¯¼èªæ