关于 element-plus-vue3
element-plus-vue3 是使用 Element Plus 的参考技能,面向 Vue 3 开发者,按主题提供安装、组件、配置、API 和示例指引。
主要功能
- 01安装与项目设置指引
- 02常用 UI 组件示例
- 03主题与国际化配置指引
- 04组件属性、事件和方法参考
- 05常见设置任务模板
适用场景
- 01在 Vue 3 应用中配置 Element Plus
- 02查找表单、表格或对话框示例
- 03自定义主题或国际化设置
- 04查询组件 API 与事件处理方式
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ full-stack-skills/ vue-ui-skills --skill element-plus-vue3安装后在 Claude Code 中输入/element-plus-vue3确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
LICENSE.txtagents/openai.yamlapi/component-api.mdglobal-config.mdprops-and-events.mdexamples/components/button.mddate-picker.mddialog.mdform.mdinput.mdmessage.mdoverview.mdselect.mdtable.mdexamples/guide/design.mdglobal-config.mdi18n.mdinstallation.mdquick-start.mdtheme.mdtemplates/component-usage.mdinstallation.mdproject-setup.md详细介绍
适用场景
当用户希望执行以下操作时,请使用此技能:
- 在 Vue 3 项目中安装并设置 Element Plus
- 在 Vue 3 应用中使用 Element Plus 组件
- 配置 Element Plus(全局配置、i18n、主题等)
- 使用表单组件(Button、Input、Form 等)
- 使用数据展示组件(Table、Card 等)
- 使用反馈组件(Message、Notification、Dialog 等)
- 使用导航组件(Menu、Tabs 等)
- 自定义组件样式和主题
- 处理组件事件
- 了解 Element Plus 的 API 和方法
- 排查 Element Plus 问题
如何使用此技能
此技能的组织结构与 Element Plus 官方文档结构一致(https://element-plus.org/zh-CN/、https://element-plus.org/en-US/guide/design、https://element-plus.org/en-US/component/overview)。使用 Element Plus 时:
-
根据用户的请求确定主题:
- 安装/安装 →
examples/guide/installation.md - 快速开始/快速开始 →
examples/guide/quick-start.md - 设计/设计 →
examples/guide/design.md - 组件/组件 →
examples/components/ - API/API 文档 →
api/
- 安装/安装 →
-
从
examples/目录加载相应的示例文件:指南(使用指南):
examples/guide/installation.md- 安装指南examples/guide/quick-start.md- 快速开始指南examples/guide/design.md- 设计指南examples/guide/i18n.md- 国际化examples/guide/theme.md- 主题自定义examples/guide/global-config.md- 全局配置
组件(组件):
examples/components/overview.md- 组件概览examples/components/button.md- Button 组件examples/components/input.md- Input 组件examples/components/form.md- Form 组件examples/components/table.md- Table 组件examples/components/card.md- Card 组件examples/components/dialog.md- Dialog 组件examples/components/message.md- Message 组件examples/components/notification.md- Notification 组件examples/components/menu.md- Menu 组件examples/components/tabs.md- Tabs 组件examples/components/date-picker.md- DatePicker 组件examples/components/select.md- Select 组件examples/components/switch.md- Switch 组件examples/components/checkbox.md- Checkbox 组件examples/components/radio.md- Radio 组件examples/components/upload.md- Upload 组件examples/components/pagination.md- Pagination 组件examples/components/tree.md- Tree 组件examples/components/tree-select.md- TreeSelect 组件examples/components/transfer.md- Transfer 组件examples/components/descriptions.md- Descriptions 组件examples/components/avatar.md- Avatar 组件examples/components/badge.md- Badge 组件examples/components/tag.md- Tag 组件examples/components/empty.md- Empty 组件examples/components/loading.md- Loading 组件examples/components/popover.md- Popover 组件examples/components/tooltip.md- Tooltip 组件examples/components/dropdown.md- Dropdown 组件examples/components/drawer.md- Drawer 组件examples/components/popconfirm.md- Popconfirm 组件
-
遵循该示例文件中的具体说明,了解语法、结构和最佳实践
重要说明:
- Element Plus 仅适用于 Vue 3
- 组件使用 Vue 3 Composition API
- 示例包含 Options API 和 Composition API
- 每个示例文件都包含关键概念、代码示例和要点
-
需要时参考
api/目录中的 API 文档:api/component-api.md- 组件 API 参考api/props-and-events.md- Props 和事件参考api/global-config.md- 全局配置 API
-
使用
templates/目录中的模板:templates/installation.md- 安装模板templates/component-usage.md- 组件用法模板templates/project-setup.md- 项目设置模板
1. 了解 Element Plus
Element Plus 是一个 Vue 3 组件库,提供丰富的 UI 组件,并遵循 Element Design 原则。
核心概念:
- 支持 Vue 3:基于 Vue 3 和 Composition API 构建
- 设计系统:遵循 Element Design 语言
- 丰富的组件:提供 60 多个组件,适用于各种场景
- 主题自定义:支持自定义主题
- i18n:支持国际化
- TypeScript:全面支持 TypeScript
2. 安装
使用 npm:
npm install element-plus
使用 yarn:
yarn add element-plus
使用 pnpm:
pnpm add element-plus
3. 基本设置
完整导入:
import { createApp } from 'vue'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import App from './App.vue'
const app = createApp(App)
app.use(ElementPlus)
app.mount('#app')
按需导入:
import { ElButton, ElInput } from 'element-plus'
import 'element-plus/es/components/button/style/css'
import 'element-plus/es/components/input/style/css'
文档映射(一对一对应官方文档)
指南(Guide):
- 查看
examples/guide/或examples/getting-started/中的指南文件 → https://element-plus.org/en-US/guide/design
组件(Components):
- 查看
examples/components/中的组件文件 → https://element-plus.org/en-US/component/overview
示例和模板
此技能包含详细示例,其组织结构与官方文档一致。所有示例均位于 examples/ 目录中(参见上方映射)。
使用示例:
- 根据用户请求确定主题
- 从上方映射中加载相应的示例文件
- 遵循该文件中的说明、语法和最佳实践
- 根据具体使用场景调整代码示例
使用模板:
- 参考
templates/目录中的模板,了解常见脚手架 - 根据具体需求和编码风格调整模板
API 参考
详细的 API 文档位于 api/ 目录中,其组织结构与官方 Element Plus API 文档一致:
组件 API(api/component-api.md)
- 组件属性和事件
- 组件方法
- 组件插槽
属性和事件(api/props-and-events.md)
- 常用属性
- 常用事件
- 事件处理
全局配置(api/global-config.md)
- 全局配置选项
- ConfigProvider 用法
- 主题配置
使用 API 参考:
- 确定需要帮助的 API
- 从
api/目录加载相应的 API 文件 - 查找 API 签名、参数、返回类型和示例
- 参考链接的示例文件,了解详细用法
- 所有 API 文件均包含指向
examples/目录中相关示例文件的链接
最佳实践
- 按需导入:仅导入所需组件,以减小打包体积
- 使用 Composition API:优先使用 Composition API,以便更好地组织代码
- 正确处理事件:为组件交互使用恰当的事件处理程序
- 自定义主题:使用主题变量进行自定义
- 遵循设计规范:遵循 Element Design 规范
- 使用 TypeScript:利用 TypeScript 提高类型安全性
资源
- 官方文档:https://element-plus.org/zh-CN/
- 英文文档:https://element-plus.org/en-US/
- 设计指南:https://element-plus.org/en-US/guide/design
- 组件概览:https://element-plus.org/en-US/component/overview
- GitHub 仓库:https://github.com/element-plus/element-plus
关键词
Element Plus, element-plus, Vue 3, Vue3, UI 组件, 组件库, 组件库, 按钮, 表单, 表格, 弹窗, 消息, 通知, 菜单, 标签页, 日期选择器, 选择器, 开关, 复选框, 单选框, 上传, 分页, 树形控件, 穿梭框, 描述列表, 头像, 徽标, 标签, 空状态, 加载, 弹出框, 提示, 下拉菜单, 抽屉, 气泡确认框, Button, Form, Table, Dialog, Message, Notification, Menu, Tabs, DatePicker, Select, Switch, Checkbox, Radio, Upload, Pagination, Tree, Transfer, Descriptions, Avatar, Badge, Tag, Empty, Loading, Popover, Tooltip, Dropdown, Drawer, Popconfirm