# element-plus-doc **Repository Path**: junerver/element-plus-doc ## Basic Information - **Project Name**: element-plus-doc - **Description**: 一个用于在vscode中帮助提示element-plus的文档插件 - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2025-02-06 - **Last Updated**: 2025-02-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # element-plus-doc README `element-plus` 的一个工具插件,用于智能提示,悬停显示属性文档等等,整理至`element-plus` 2.8.5 的文档,后续`element-plus`更新,也会跟着更新,如未及时更新,请大家到[github](https://github.com/mxp131011/element-plus-doc)提交[issues](https://github.com/mxp131011/element-plus-doc/issues) 催促作者更新,有什么问题也请大家及时反馈,[github](https://github.com/mxp131011/element-plus-doc)访问不了也可到[gitee](https://gitee.com/mxp131011/element-plus-doc)提交[issues](https://gitee.com/mxp131011/element-plus-doc/issues),或者加作者微信:mxp131011 或者反馈。如还有什么需求,也可提出(不考虑`element-plus`之外的需求)。 ## 功能介绍 1. [下 划 线]:标签添加下划线,表示此标签可以显示悬浮文档,以及输入智能提示 2. [悬浮文档]:鼠标移动到`element-plus`组件的标签上会提示标签此标签的所有文档。 3. [悬浮文档]:鼠标移动到`element-plus`组件标签中的某条属性时仅显示该条属性的文档 4. [悬浮文档]:鼠标移动到`element-plus`组件标签中的`ref`属性时会显示此组件暴露出的所有方法 5. [智能提示]:``标签内输入`` 6. [代码块智能提示]:``标签内输入`el`(不带`<`),会提示出定义好的代码块,如输入:`elt`会补全如下内容 ```html ``` 7. [代码块智能提示]:在`js`、`ts`文件中或则`vue`文件的``标签内输入对应的代码会补全完整的代码。如:输入`al`,会补全如下内容 ```js ElMessageBox.alert('内容', '标题', { confirmButtonText: '确定', callback: (action) => { if (action === 'confirm') { } }, }); ``` 8. 可在设置中设置自定义前缀,如 `base`,`my` 等等,以此前缀或 `le` 前缀开头的都视作 `element-plus` 组件。会添加相应悬浮文档(为了性能,不算 `el` 前缀,最多支持还可添加三个自定义前缀) 9. 如果自定义前缀还是无法满足需求,可以设置自定义映射组件,如:`` 组件想拥有 `` 的文档或提示,则可在设置中配置:`{ baseInputNumbFor: 'elInput'` ,此时,``就有了 `` 的智能提示和此鼠标悬浮显示文档功能了 10. 可在设置中修改 `element-plus` 中/英官网的地址 11. 本插件仅支持中文和英文的提示文档,会根据 vscode 当前语言自动显示中文或英文的文档 ### 示例图 1. 标签添加下划线 (图中所有有下划线的标签都支悬浮文档 和 持智能提示) ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_001.jpg) 2. 鼠标移动到`element-plus`组件的标签上会提示标签此标签的所有文档 ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_002.jpg) 3. [悬浮文档]:鼠标移动到`element-plus`组件标签中的某条属性时仅显示该条属性的文档 ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_003.jpg) 4. [悬浮文档]:鼠标移动到`element-plus`组件标签中的`ref`属性时会显示此组件暴露出的所有方法 ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_004.jpg) 5. [智能提示]:``标签内输入`` ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_005.jpg) 6. [代码块智能提示]:``标签内输入`el`(不带`<`),会提示出定义好的代码块 ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_006.jpg) 7. [代码块智能提示]:在`js`、`ts`文件中或则`vue`文件的``标签内输入对应的代码会补全完整的代码。 ![下划线](https://res.mxpkf.com/element-plus-doc/markdown/show_example_007.jpg) ### 模板内的代码片段
输入字段 说明 生成代码
info 普通类型的消息提示 (ElMessage)
```js ElMessage.info({ message: '', showClose: true, }); ```
success 成功类型的消息提示 (ElMessage)
```js ElMessage.success({ message: '', showClose: true, }); ```
warning 警告类型的消息提示 (ElMessage)
```js ElMessage.warning({ message: '', showClose: true, }); ```
error 错误类型的消息提示 (ElMessage)
```js ElMessage.error({ message: '', showClose: true, }); ```
alert alert消息弹出框 (ElMessageBox)
```js ElMessageBox.alert('内容', '标题', { confirmButtonText: '确定', callback: action => { if (action === 'confirm') { } } }); ```
confirm confirm消息弹出框 (ElMessageBox)
```js ElMessageBox.confirm('内容', '标题', { { confirmButtonText: '确定' cancelButtonText: '取消' } }).then(() => { }).catch(() => { }); ```
prompt prompt消息弹出框 (ElMessageBox)
```js ElMessageBox.prompt('内容', '标题', { { confirmButtonText: '确定' cancelButtonText: '取消' } }).then(() => { }).catch(() => { }); ```
info 普通类型的消息通知 (ElNotification)
```js ElNotification.info({ title: '温馨提示', message: '', }); ```
success 成功类型的消息通知 (ElNotification)
```js ElNotification.success({ title: '成功', message: '', }); ```
warning 警告类型的消息通知 (ElNotification)
```js ElNotification.warning({ title: '警告', message: '', }); ```
error 错误类型的消息通知 (ElNotification)
```js ElNotification.error({ title: '错误', message: '', }); ```
### JS/TS 内的代码片段
输入字段 说明 生成代码
template 模板
```html ```
slot 插槽
```html ```
el-button 按钮组件
```html ```
el-container 布局组件
```html Sider Header main footer ```
el-confirm 确认按钮组件
```html 确认 ```
el-cancel 取消按钮组件
```html 取消 ```
el-link 路由跳转组件
```html ```
el-scrollbar 滚动条组件
```html ```
el-space 间距组件
```html ```
el-config-provider 间距组件
```html ```
el-autocomplete 自动补全输入框组件
```html ```
el-icon 图标组件
```html ```
el-tabs 标签页组件
```html ```
el-tab-pane 面包屑子组件
```html ```
el-aside 布局侧边栏组件
```html aside ```
el-header 布局顶部组件
```html header ```
el-main 布局内容组件
```html main ```
el-footer 布局底部组件
```html footer ```
el-breadcrumb 面包屑组件
```html ```
el-breadcrumb-item 面包屑子组件
```html ```
el-menu 菜单组件
```html ```
el-sub-menu 子菜单组件
```html ```
el-menu-item 菜单子组件
```html ```
el-timeline 时间轴组件
```html ```
el-timeline-item 时间轴子组件
```html ```
el-tour 漫游式引导
```html
Put you files here.
```
el-tour-step 漫游式引导步骤
```html
Put you files here.
```
el-collapse 折叠面板组件
```html ```
el-collapse-item 折叠面板子组件
```html ```
el-descriptions 描述列表组件
```html ```
el-descriptions-item 描述列表子组件
```html ```
el-result 结果组件
```html ```
el-empty 空状态组件
```html ```
el-dropdown 下拉菜单父组件
```html ```
el-dropdown-menu 下拉菜单子组件
```html ```
el-dropdown-item 下拉菜单子组件
```html ```
el-pagination 分页组件
```html ```
el-checkbox-group 多选框 el-checkbox形式编码
```html ```
el-checkbox 复选框组件
```html ```
el-radio-group 单选框组件 el-radio形式编码
```html ```
el-radio 复选框组件
```html ```
el-badge 徽标数组件
```html ```
el-calendar 日历组件
```html ```
el-image 图片组件
```html ```
el-backtop 返回顶部组件
```html ```
el-card 卡片组件
```html ```
el-carousel 走马灯组件
```html ```
el-carousel-item 走马灯子组件
```html ```
el-switch 开关组件
```html ```
el-input 输入框组件
```html ```
el-select 下拉框组件
```html ```
el-select-v2 虚拟化选择器
```html ```
el-input-number 数字输入框组件
```html ```
el-avatar 头像组件
```html ```
el-spin 加载中组件
```html ```
el-divider 分割线组件
```html ```
el-skeleton 骨架屏组件
```html ```
el-alert 警告提示组件
```html ```
el-popconfirm 气泡二次确认组件
```html ```
el-popover 气泡组件
```html ```
el-tooltip 文字提示组件
```html ```
el-tag 标签组件
```html ```
el-slider 滑动输入条
```html ```
el-progress 进度条组件
```html ```
el-time-select 时间选择器
```html ```
el-time-picker 时间选择器
```html ```
el-date-picker 日期选择器
```html ```
el-date-picker 日期范围选择器
```html ```
el-rate 评分组件
```html ```
el-color-picker 颜色选择器
```html ```
el-steps 步骤条组件
```html ```
el-dialog 弹窗组件
```html 这事一个消息 ```
el-transfer 穿梭框组件
```html ```
el-cascader 级联选择组件
```html ```
el-cascader-panel 级联选择面板组件
```html ```
el-upload 上传文件组件
```html ```
el-drawer 抽屉组件
```html

```
el-tree 树形结构组件
```html ```
el-tree-select 树形选择器组件
```html ```
el-tree-v2 虚拟化树形控件
```html ```
el-statistic 统计组件
```html ```
el-countdown 倒计时组件
```html ```
el-affix 固钉组件
```html ```
el-anchor 锚点组件
```html {{ locale['Basic Usage'] }} {{ locale['Horizontal Mode'] }} {{ locale['Scroll Container'] }} ```
el-anchor-link 锚点链接组件
```html {{ locale['Basic Usage'] }} ```
el-page-header 页头组件
```html ```
el-table 表格组件
```html ```
el-table-v2 虚拟化表格
```html ```
el-form 表单组件
```html ```
el-form-item 表单子组件
```html ```
el-row 栅格布局组件
```html ```
el-col 栅格布局子组件
```html ```
el-watermark 水印组件
```html ```