# 快速开始

# element-ui-pro-components

本项目是受 Ant Design Pro Components 的启发,旨在为 Vue 2 + Element UI 生态提供更高级别的模板组件,方便表单、表格功能开发。

# 架构与组件总览

ProComponents 提供了一系列高级组件,覆盖了从布局到表单、表格的核心场景:

  • ProForm - 高级表单
  • DialogForm - 弹框表单
  • ProTable - 查询表格
  • EditableProTable - 可编辑表格

# 前置条件

本组件库依赖以下库,请确保你的项目中已安装:

{
 "peerDependencies": {
    "el-table-prepend": "^1.0.5",
    "element-ui": "^2.15.14",
    "vue": "^2.6.10",
    "vue-fragment": "^1.6.0"
  },
}
1
2
3
4
5
6
7
8

# 安装

安装 element-ui-pro-components 库:

npm install element-ui-pro-components
1

# 全量引入

// main.js
import Vue from 'vue'
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
import Fragment from 'vue-fragment'

import ElementUIPro from 'element-ui-pro-components'
import 'element-ui-pro-components/lib/style.css'

Vue.use(Fragment.Plugin)
Vue.use(ElementUI)
Vue.use(ElementUIPro)
1
2
3
4
5
6
7
8
9
10
11
12

# 按需引入

# 1. 安装 babel 插件

npm install babel-plugin-component --save-dev
1

# 2. 配置 babel.config.js

module.exports = {
  plugins: [
    [
      'component',
      {
        libraryName: 'element-ui-pro-components',
        style: true
      },
      'element-ui-pro-components'  // 命名,防止多个 component 冲突
    ]
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12

# 效果

import { ProTable } from 'element-ui-pro-components'

// 实际转换为:
import ProTable from 'element-ui-pro-components/lib/pro-table/index'
import 'element-ui-pro-components/lib/pro-table/style.css'
1
2
3
4
5

# 3. 在 main.js 中引入

// main.js
import Vue from 'vue'
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
import Fragment from 'vue-fragment'

Vue.use(Fragment.Plugin)
Vue.use(ElementUI)
1
2
3
4
5
6
7
8

# 4. 在页面中使用

import { ProForm, DialogForm, ProTable, EditableProTable } from 'element-ui-pro-components'

export default {
  components: {
    ProForm,
    DialogForm,
    ProTable,
    EditableProTable
  }
}
1
2
3
4
5
6
7
8
9
10