1.0.2 • Published 7 months ago
@e66/elpis v1.0.2
elpis
一个企业级应用框架，通过全栈实现
model 配置
{
// 模板类型，不同模板类型对应不一样的模板数据结构
mode: 'dashboard';
name: ''; // 模板名称
description: ''; // 模板描述
icon: ''; // 模板图标
homePage: ''; // 首页（项目配置）
// 头部菜单
menu: [{
key: '', // 菜单的唯一描述
name: '', // 菜单的名称
menuType: '', // 枚举值，group / module
// 当 menuType == group 时，可填
subMenu: [{
// 可递归 menuItem
}],
// 当 menuType == module 时，可填
moduleType: '', // 枚举值：sider/iframe / custom / schema
// 当 moduleType == sider 时 点击菜单后侧边菜单显示的内容
siderConfig: {
menu: [{
// 可递归 menuItem(除 moduleType == sider)
}],
},
// 当 moduleType == iframe 时
iframeConfig: {
path: '', // iframe 的路径
},
// 当 moduleType == custom 时
customConfig: {
path: '', // 自定义路由路径
},
// 当 moduleType == schema 时
schemaConfig: {
api: '/api/user', // 数据源 API （遵循 RESTFUL 规范）
schema: {
type: 'object',
properties: {
key: {
...schema, // 标准 schema 配置
type: '',// 字段类型
label: '', // 字段的中文名
// 字段在 table 中的配置
tableOption: {
...elTableColumnConfig, // 标准 el-table-column 的配置
toFixed: 0, // 保留小数后几位
visible: true, // 是否显示在表单中
},
// 字段在 search-bar 中的配置
searchOption: {
...elTableColumnConfig, // 标准 el-table-column 的配置
comType: '', // 配置控件类型 （el-input / el-select / el-date-picker / el-cascader / el-switch）
default: '', // 默认值
// comType === 'select'
enumList: [], // 下拉框可选项
// comType === 'dynamicSelect'
api: ''
},
// 字段在不同动态 component 中的配置，前缀对应 componentConfig 的 key
// 如：componentConfig.createForm 这里对应 createFormOption 的配置
// 字段在 creatForm 中的配置
createFormOption: {
...elTableColumnConfig, // 标准 el-component 的配置
comType: '', // 控件类型 input / select / input—number
visible: true, // 是否显示在表单中 默认 true
disabled: false, // 是否禁用 默认 false
default: '', // 默认值
// comType === 'select'
enumList: [], // 下拉框可选项
},
// 字段在 editForm 表单中的配置
editFormOption: {
...elTableColumnConfig, // 标准 el-component 的配置
comType: '', // 控件类型 input / select / input—number
visible: true, // 是否显示在表单中 默认 true
disabled: false, // 是否禁用 默认 false
default: '', // 默认值
// comType === 'select'
enumList: [], // 下拉框可选项
},
detailPanelOption: {
...elTableColumnConfig, // 标准 el-component 的配置
}
},
},
required: [], // 必填项
},
tableConfig: {
headerButtons: [{
label: '', // 按钮名称
evenKey: '', // 按钮事件名称
// 按钮事件具体配置
evenOption: {
// 当 evenkey === 'showComponent'
comName: '', // 组件名称
},
...elButtonConfig, // 标准 el-button 的配置
}], // 表头按钮配置
rowButtons: [{
label: '', // 按钮名称
evenKey: '', // 按钮事件名称
evenOption: {
comName: '', // 组件名称
// 当 evenkey === 'remove'
params: {
// 这个 paramsKey = 参数的键值，也就是发送这个事件请求的时候，会带上 table-panle 页面的 rowValueKey (user_id:rowData.user_id)
// 这个 rowValueKey = 参数值格式为 schema::tableKey，到table中找到相应字段
paramsKey: rowValueKey
}
}, // 按钮事件具体配置,
...elButtonConfig, // 标准 el-button 的配置
}], // 表格行按钮配置
}, // table 的配置
// search-bar 的配置
searchConfig: {},
// 动态组件 相关配置
componentConfig: {
// create-form 表单配置
createForm: {
title: '', // 表单标题
saveBtnText: '', // 保存按钮名称
},
// edit-form 表单相关配置
editForm: {
mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
title: '', // 表单标题
saveBtnText: '' // 保存按钮
},
// detail-penal 详情查看 相关配置
detailPanel: {
mainKey: '', // 用于查找数据的主键
title: '', // 表单标题
}
// ... 支持用户动态扩展
},
}
}]
}服务端启动
const {
serverStart
} = require('@e66/elpis')
// 启动 elpis 服务
const app = serverStart({})
### 自定义服务端
- router-schema
- router
- controller
- service
- extend
- config
### 前端构建
``` javascript
const { frontendBuild } = require('@e66/elpis')
// 编译构建前端工程
frontendBuild(process.env._ENV)自定义页面扩展
- 在
app/pages/目录下写入口 entry.xxx.js
dashboard / custom-view 自定义页面扩展
- 在
app/pages/dashboard/xxx下写页面
dashboard / schema-view / components 动态组件扩展
- 在
app/pages/dashboard/compiex-view/schema-view/components下写组件 - 配置到
app/pages/dashboard/compiex-view/schema-view/components/component-config.js
schema-form 控件扩展
- 在
app/pages/widgets/schema-form/compiex-view下写控件 - 配置到
app/pages/widgets/schema-form/form-item-config.js
schema-search-bar 控件扩展
- 在
app/pages/widgets/schema-search-bar/compiex-view下写控件 - 配置到
app/pages/widgets/schema-search-bar/search-item-config.js