mcpField
A
arco-design-vue

arco-design-vue

github.com/arco-designDesign & UI73120 installsUpdated 21w ago
Repository

About arco-design-vue

A reference skill for building Vue 3 interfaces with `@arco-design/web-vue`. It gives component usage conventions and an index of guidance for setup, forms, layouts, data display, feedback, and responsive design.

Key features

  1. 01Vue 3 and Composition API conventions
  2. 02Component and icon import guidance
  3. 03Template, event, and binding patterns
  4. 04Reference index for component families
  5. 05Guidance for forms and responsive layouts

Use cases

  1. 01Implementing forms and validation in Vue 3
  2. 02Building tables and navigation layouts
  3. 03Choosing component patterns for a Vue interface

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/arco-design/arco-design-skill --skill arco-design-vue

After installing, type/arco-design-vuein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/components/data-display/
avatar.md
badge.md
calendar.md
card.md
carousel.md
collapse.md
comment.md
descriptions.md
empty.md
image.md
list.md
overflow-list.md
popover.md
statistic.md
table.md
tabs.md
tag.md
timeline.md
tooltip.md
tree.md
references/components/data-entry/
auto-complete.md
cascader.md
checkbox.md
color-picker.md
date-picker.md
form.md
input-number.md
input-tag.md
input.md
mention.md

Details

From the project README

Arco Design Vue Skill

@arco-design/web-vue 是 Arco Design 的 Vue 3 组件库实现。

关键约定

编写 Arco Design Vue 代码时始终遵守这些规则:

  • 使用 Vue 3。新代码优先使用 <script setup lang="ts"> 和 Composition API。
  • 完整引入:
import { createApp } from 'vue';
import ArcoVue from '@arco-design/web-vue';
import '@arco-design/web-vue/dist/arco.css';
import App from './App.vue';

const app = createApp(App);
app.use(ArcoVue);
app.mount('#app');
  • 组件与服务从根包导入:import { Button, Table, Form, Message } from '@arco-design/web-vue'。
  • 图标从图标入口导入:import { IconSearch, IconPlus } from '@arco-design/web-vue/es/icon'。
  • 样式完整引入使用 @arco-design/web-vue/dist/arco.css。手动按需引入时使用组件样式,例如 @arco-design/web-vue/es/button/style/css.js。
  • 默认全局组件标签使用 a- 前缀:<a-button>、<a-table>、<a-form>、<a-form-item>。
  • 模板中的属性使用 kebab-case:html-type、show-jumper、row-selection。
  • 事件使用 Vue 语法:@click、@change、@page-change、@submit-success。
  • 双向绑定使用 v-model 或命名形式:v-model:visible、v-model:selected-keys、v-model:current。
  • 插槽使用 #slot-name;作用域插槽参数以组件文档为准。
  • 表单使用 :model、field 和校验规则;子输入控件用 v-model。
  • 日期时间组件内部使用 dayjs;不要引入 Moment.js。
  • 优先使用本 skill 中的 Vue 示例。不要套用 React 专属 API,例如 Form.useForm、JSX children 或 Component.Sub。

Skill 索引

需要完整属性、事件、插槽、示例和使用要点时,加载对应参考文件。

安装与配置
主题文件适用场景
安装getting-started.md安装 @arco-design/web-vue、注册 ArcoVue、引入样式、配置按需加载
全局配置config-provider.md使用 app.use(ArcoVue, options) 或 <a-config-provider> 配置语言、前缀、尺寸等
主题theming.mdLess 变量、主题包、暗黑模式、CSS/样式引入
国际化internationalization.md语言包和 <a-config-provider :locale="...">
架构约定architecture.mdVue 3 SFC 结构、导入、v-model、属性、事件、插槽、组件注册
通用
组件文件适用场景
Buttonbutton.md操作按钮、加载按钮、图标按钮、按钮组
ConfigProviderconfig-provider.md全局语言、前缀、尺寸、滚动更新等配置
Iconicon.md内置图标、图标注册、按需导入、iconfont.cn
Linklink.md链接及其状态、图标链接
Typographytypography.md标题、段落、文本、省略、复制、编辑
布局
组件文件适用场景
Dividerdivider.md水平或垂直分割线
Gridgrid.md24 栅格、响应式行列布局
Layoutlayout.md页面骨架、页头、侧边栏、内容区、页脚
Spacespace.md行内或块级元素间距
导航
组件文件适用场景
Breadcrumbbreadcrumb.md页面层级和路由面包屑
Dropdowndropdown.md下拉菜单和命令浮层
Menumenu.md侧边导航、顶部导航、子菜单
PageHeaderpage-header.md页头、返回操作、面包屑、额外操作
Paginationpagination.md分页、跳转、页大小切换
Stepssteps.md步骤流程和进度
数据录入
组件文件适用场景
AutoCompleteauto-complete.md输入建议和搜索补全
Cascadercascader.md多级级联选择
Checkboxcheckbox.md多选、全选、半选状态
ColorPickercolor-picker.md颜色选择
DatePickerdate-picker.md日期、周、月、季度、年、范围选择
Formform.md表单、校验、动态字段、布局、提交处理
Inputinput.md文本输入、搜索、密码、文本域相关模式
InputNumberinput-number.md数字输入、精度、最小/最大值
InputTaginput-tag.md标签输入和编辑
Mentionmention.md在文本中提及用户或主题
Radioradio.md单选和单选组
Raterate.md评分
Selectselect.md选择器、多选、搜索、选项插槽
Sliderslider.md滑动输入和范围输入
Switchswitch.md布尔开关
Textareatextarea.md多行文本输入
TimePickertime-picker.md时间和时间范围选择
Transfertransfer.md两栏穿梭选择
TreeSelecttree-select.md树形数据选择
Uploadupload.md文件上传、拖拽上传、图片上传
VerificationCodeverification-code.md验证码或 OTP 输入
数据展示
组件文件适用场景
Avataravatar.md用户头像和头像组
Badgebadge.md数字徽标、状态点、通知标记
Calendarcalendar.md日历展示
Cardcard.md内容卡片和卡片栅格
Carouselcarousel.md轮播图
Collapsecollapse.md折叠面板
Commentcomment.md评论展示和嵌套评论
Descriptionsdescriptions.md键值详情展示
Emptyempty.md空状态
Imageimage.md图片展示和预览
Listlist.md列表和虚拟列表
OverflowListoverflow-list.md折叠溢出的列表项
Popoverpopover.md富内容气泡卡片
Statisticstatistic.md数值、倒计时、指标
Tabletable.md表格、列、排序、筛选、选择、虚拟滚动
Tabstabs.md标签页、可编辑标签页、卡片式标签页
Tagtag.md标签、可选标签、可关闭标签
Timelinetimeline.md时间线和活动流
Tooltiptooltip.md悬浮或聚焦文字提示
Treetree.md树形层级数据
反馈
组件文件适用场景
Alertalert.md行内警告提示
Drawerdrawer.md抽屉面板和抽屉表单
Messagemessage.md全局轻量提示
Modalmodal.md对话框、确认流程、弹窗表单
Notificationnotification.md富内容全局通知
Popconfirmpopconfirm.md轻量确认气泡
Progressprogress.md线形/环形进度
Resultresult.md成功、错误、404 等结果状态
Skeletonskeleton.md骨架屏加载占位
Spinspin.md加载中
其他
组件文件适用场景
Affixaffix.md滚动时固定元素
Anchoranchor.md页内锚点导航
BackTopback-top.md回到顶部
ResizeBoxresize-box.md可伸缩容器和分割面板
Scrollbarscrollbar.md自定义滚动条
Splitsplit.md面板分割
Triggertrigger.md基础弹出触发和定位
Watermarkwatermark.md文字或图片水印
模式
主题文件适用场景
表单模式form-patterns.md复杂表单、校验、动态字段、表单提交
表格模式table-patterns.md远程表格、插槽、行选择、分页
弹窗模式modal-patterns.md弹窗表单、确认、全局反馈
受控值controlled-uncontrolled.mdv-model、default-*、受控/非受控状态
响应式设计responsive-design.md栅格断点、响应式表单、自适应仪表盘

Comments

Markdown supported