name: element-plus-vue3 description: 提供Element Plus Vue 3组件库的综合指南,包括安装、组件、主题、国际化和API参考。当用户询问Element Plus for Vue 3时使用,或需要构建Vue 3应用程序并使用Element Plus,或自定义组件样式。 license: 完整条款见LICENSE.txt
何时使用此技能
当用户想要:
- 在Vue 3项目中安装和设置Element Plus
- 在Vue 3应用程序中使用Element Plus组件
- 配置Element Plus(全局配置、i18n、主题等)
- 使用表单组件(按钮、输入、表单等)
- 使用数据显示组件(表格、卡片等)
- 使用反馈组件(消息、通知、对话框等)
- 使用导航组件(菜单、选项卡等)
- 自定义组件样式和主题
- 处理组件事件
- 理解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- 按钮组件examples/components/input.md- 输入组件examples/components/form.md- 表单组件examples/components/table.md- 表格组件examples/components/card.md- 卡片组件examples/components/dialog.md- 对话框组件examples/components/message.md- 消息组件examples/components/notification.md- 通知组件examples/components/menu.md- 菜单组件examples/components/tabs.md- 选项卡组件examples/components/date-picker.md- 日期选择器组件examples/components/select.md- 选择器组件examples/components/switch.md- 开关组件examples/components/checkbox.md- 复选框组件examples/components/radio.md- 单选框组件examples/components/upload.md- 上传组件examples/components/pagination.md- 分页组件examples/components/tree.md- 树形组件examples/components/tree-select.md- 树选择组件examples/components/transfer.md- 穿梭框组件examples/components/descriptions.md- 描述列表组件examples/components/avatar.md- 头像组件examples/components/badge.md- 徽标组件examples/components/tag.md- 标签组件examples/components/empty.md- 空状态组件examples/components/loading.md- 加载组件examples/components/popover.md- 弹出框组件examples/components/tooltip.md- 提示组件examples/components/dropdown.md- 下拉菜单组件examples/components/drawer.md- 抽屉组件examples/components/popconfirm.md- 气泡确认框组件
-
遵循该示例文件中的具体说明,包括语法、结构和最佳实践
重要注意事项:
- Element Plus 仅适用于 Vue 3
- 组件使用 Vue 3 组合式 API
- 示例包括选项式 API 和组合式 API
- 每个示例文件包括关键概念、代码示例和关键点
-
需要时参考
api/目录中的API文档:api/component-api.md- 组件API参考api/props-and-events.md- 属性和事件参考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 构建,使用组合式 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'
文档映射(与官方文档一一对应)
指南(指南):
- 参见
examples/guide/或examples/getting-started/中的指南文件 → https://element-plus.org/en-US/guide/design
组件(组件):
- 参见
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/目录中的相关示例文件
最佳实践
- 使用按需导入:仅导入需要的组件以减少包大小
- 使用组合式 API:优先使用组合式 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