When to use this skill
Use this skill whenever the user wants to:
- Build management systems with Avue
- Use Avue table and form components
- Implement data-driven views
- Use Avue global APIs ($DialogForm, $Clipboard, $ImagePreview, etc.)
- Configure Avue forms and tables
- Use Avue components (Tree, Upload, Select, etc.)
- Implement CRUD operations with Avue
- Customize Avue components
- Configure internationalization
- Use Avue plugins and extensions
How to use this skill
This skill is organized to match the Avue official documentation structure (https://avuejs.com/). When working with Avue:
Identify the topic from the user's request:
- Getting started/快速开始 →
examples/getting-started/installation.md or examples/getting-started/quick-start.md
- Form/表单 →
examples/forms/basic-form.md or examples/forms/form-config.md
- Table/表格 →
examples/components/table.md
- Tree/树形 →
examples/components/tree.md
- Upload/上传 →
examples/components/upload.md
- Global API/全局 API →
api/global-api.md
Load the appropriate example file from the examples/ directory:
Getting Started (快速开始) - examples/getting-started/:
examples/getting-started/installation.md - Installing Avue and basic setup
examples/getting-started/quick-start.md - Quick start tutorial
examples/getting-started/global-config.md - Global configuration
Forms (表单) - examples/forms/:
examples/forms/basic-form.md - Basic form usage
examples/forms/form-config.md - Form configuration
examples/forms/form-validation.md - Form validation
examples/forms/form-table.md - Form with table selector
Components (组件) - examples/components/:
examples/components/table.md - Table component
examples/components/tree.md - Tree component
examples/components/upload.md - Upload component
examples/components/select.md - Select component
examples/components/input.md - Input component
Advanced (高级) - examples/advanced/:
examples/advanced/crud.md - CRUD operations
examples/advanced/internationalization.md - Internationalization
examples/advanced/plugins.md - Plugins and extensions
Follow the specific instructions in that example file for syntax, structure, and best practices
Important Notes:
- All examples follow Avue API
- Examples use Vue 2.x syntax
- Each example file includes key concepts, code examples, and key points
- Always check the example file for best practices and common patterns
- Avue is based on Vue and Element UI
Reference API documentation in the api/ directory when needed:
api/global-api.md - Global API reference
api/components.md - Component API reference
Use templates from the templates/ directory:
templates/form-template.md - Form template
templates/table-template.md - Table template
templates/crud-template.md - CRUD template
Doc mapping (one-to-one with official documentation)
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 Avue API documentation structure:
Global API (api/global-api.md)
- $DialogForm - Dialog form
- $Clipboard - Clipboard operations
- $ImagePreview - Image preview
- $Print - Print functionality
- $Export - Export functionality
- $Log - Logging
- findObject, findArray, findNode - Utility functions
- watermark - Watermark
- downFile - File download
- randomId - Random ID generation
- loadScript - Script loading
- deepClone - Deep clone
- setPx - Pixel conversion
- validatenull - Validation
- vaildData - Data validation
Components API (api/components.md)
- Component props and APIs
- Component events and methods
- Component configuration
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
- Install Avue: Install @smallwei/avue package
- Import styles: Import Avue CSS styles
- Use Vue.use(): Register Avue with Vue.use(Avue)
- Data-driven: Use data-driven approach for forms and tables
- Configuration: Configure forms and tables via option objects
- Global API: Use Avue global APIs for common operations
- Internationalization: Configure i18n for multi-language support
- Plugins: Use Avue plugins for extended functionality
- Component composition: Compose components for complex UIs
- Performance: Optimize for performance with large datasets
Resources
Keywords
Avue, Vue, Element UI, data-driven, form, table, CRUD, $DialogForm, $Clipboard, $ImagePreview, $Print, $Export, tree, upload, select, 数据驱动, 表单, 表格, CRUD, 树形, 上传, 选择器
1---
2name: avue
3description: Provides comprehensive guidance for Avue framework including CRUD operations, form components, and data management. Use when the user asks about Avue, needs to build admin interfaces, implement CRUD operations, or work with Avue components.
4license: Complete terms in LICENSE.txt
5metadata:
6 source: https://skillmd.com/skills/majiayu000/avue
7---
8
9## When to use this skill
10
11Use this skill whenever the user wants to:
12- Build management systems with Avue
13- Use Avue table and form components
14- Implement data-driven views
15- Use Avue global APIs ($DialogForm, $Clipboard, $ImagePreview, etc.)
16- Configure Avue forms and tables
17- Use Avue components (Tree, Upload, Select, etc.)
18- Implement CRUD operations with Avue
19- Customize Avue components
20- Configure internationalization
21- Use Avue plugins and extensions
22
23## How to use this skill
24
25This skill is organized to match the Avue official documentation structure (https://avuejs.com/). When working with Avue:
26
271. **Identify the topic** from the user's request:
28 - Getting started/快速开始 → `examples/getting-started/installation.md` or `examples/getting-started/quick-start.md`
29 - Form/表单 → `examples/forms/basic-form.md` or `examples/forms/form-config.md`
30 - Table/表格 → `examples/components/table.md`
31 - Tree/树形 → `examples/components/tree.md`
32 - Upload/上传 → `examples/components/upload.md`
33 - Global API/全局 API → `api/global-api.md`
34
352. **Load the appropriate example file** from the `examples/` directory:
36
37 **Getting Started (快速开始) - `examples/getting-started/`**:
38 - `examples/getting-started/installation.md` - Installing Avue and basic setup
39 - `examples/getting-started/quick-start.md` - Quick start tutorial
40 - `examples/getting-started/global-config.md` - Global configuration
41
42 **Forms (表单) - `examples/forms/`**:
43 - `examples/forms/basic-form.md` - Basic form usage
44 - `examples/forms/form-config.md` - Form configuration
45 - `examples/forms/form-validation.md` - Form validation
46 - `examples/forms/form-table.md` - Form with table selector
47
48 **Components (组件) - `examples/components/`**:
49 - `examples/components/table.md` - Table component
50 - `examples/components/tree.md` - Tree component
51 - `examples/components/upload.md` - Upload component
52 - `examples/components/select.md` - Select component
53 - `examples/components/input.md` - Input component
54
55 **Advanced (高级) - `examples/advanced/`**:
56 - `examples/advanced/crud.md` - CRUD operations
57 - `examples/advanced/internationalization.md` - Internationalization
58 - `examples/advanced/plugins.md` - Plugins and extensions
59
603. **Follow the specific instructions** in that example file for syntax, structure, and best practices
61
62 **Important Notes**:
63 - All examples follow Avue API
64 - Examples use Vue 2.x syntax
65 - Each example file includes key concepts, code examples, and key points
66 - Always check the example file for best practices and common patterns
67 - Avue is based on Vue and Element UI
68
694. **Reference API documentation** in the `api/` directory when needed:
70 - `api/global-api.md` - Global API reference
71 - `api/components.md` - Component API reference
72
735. **Use templates** from the `templates/` directory:
74 - `templates/form-template.md` - Form template
75 - `templates/table-template.md` - Table template
76 - `templates/crud-template.md` - CRUD template
77
78
79### Doc mapping (one-to-one with official documentation)
80
81- See examples and API files → https://avuejs.com
82
83## Examples and Templates
84
85This skill includes detailed examples organized to match the official documentation structure. All examples are in the `examples/` directory (see mapping above).
86
87**To use examples:**
88- Identify the topic from the user's request
89- Load the appropriate example file from the mapping above
90- Follow the instructions, syntax, and best practices in that file
91- Adapt the code examples to your specific use case
92
93**To use templates:**
94- Reference templates in `templates/` directory for common scaffolding
95- Adapt templates to your specific needs and coding style
96
97## API Reference
98
99Detailed API documentation is available in the `api/` directory, organized to match the official Avue API documentation structure:
100
101### Global API (`api/global-api.md`)
102- $DialogForm - Dialog form
103- $Clipboard - Clipboard operations
104- $ImagePreview - Image preview
105- $Print - Print functionality
106- $Export - Export functionality
107- $Log - Logging
108- findObject, findArray, findNode - Utility functions
109- watermark - Watermark
110- downFile - File download
111- randomId - Random ID generation
112- loadScript - Script loading
113- deepClone - Deep clone
114- setPx - Pixel conversion
115- validatenull - Validation
116- vaildData - Data validation
117
118### Components API (`api/components.md`)
119- Component props and APIs
120- Component events and methods
121- Component configuration
122
123**To use API reference:**
1241. Identify the API you need help with
1252. Load the corresponding API file from the `api/` directory
1263. Find the API signature, parameters, return type, and examples
1274. Reference the linked example files for detailed usage patterns
1285. All API files include links to relevant example files in the `examples/` directory
129
130## Best Practices
131
1321. **Install Avue**: Install @smallwei/avue package
1332. **Import styles**: Import Avue CSS styles
1343. **Use Vue.use()**: Register Avue with Vue.use(Avue)
1354. **Data-driven**: Use data-driven approach for forms and tables
1365. **Configuration**: Configure forms and tables via option objects
1376. **Global API**: Use Avue global APIs for common operations
1387. **Internationalization**: Configure i18n for multi-language support
1398. **Plugins**: Use Avue plugins for extended functionality
1409. **Component composition**: Compose components for complex UIs
14110. **Performance**: Optimize for performance with large datasets
142
143## Resources
144
145- **Official Website**: https://avuejs.com/
146- **GitHub Repository**: https://github.com/avue/avue
147
148## Keywords
149
150Avue, Vue, Element UI, data-driven, form, table, CRUD, $DialogForm, $Clipboard, $ImagePreview, $Print, $Export, tree, upload, select, 数据驱动, 表单, 表格, CRUD, 树形, 上传, 选择器