@tushi11/elpis NPM

elpis

一个企业级应用框架，通过全栈实现。

model配置

{
  mode: 'dashboard', // 模板类型，不同模板类型对应不一样的模板数据结构
  name: '', // 名称
  desc: '', // 描述
  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（遵循 RESTFUL 规范）
        schema: {
          // 板块数据结构
          type: 'object',
          properties: {
            key: {
              ...schema, // 标准 schema 配置
              type: '', // 字段类型
              label: '', // 字段的中文名
              // 字段在 table 中的相关配置
              tableOption: {
                ...elTableColumnConfig, // 标准 el-table-column 配置
                toFixed: 0, // 保留小数点后几位
                visible: true, // 默认为 true（为 false 时，表示不在 table 中显示）
              },
              // 字段在 search-bar 中的相关配置
              searchOption: {
                ...eleComponentConfig, // 标准 el-component-column 配置
                comType: '', // 配置组件类型（如 input/select/...）
                default: '', // 默认值

                // 当 comType === select 时
                enumList: [], // 下拉框可选项 // 当 comType === 'dynamicSelect' 时，会和 API 可选项进行合并
                // 当 comType === 'dynamicSelect'
                api: '',
              },
              // 字段在不同动态 component 中的相关配置，前缀对应 componentConfig 中的键值
              // 如：componentConfig.createForm，这里对应 createFormOption
              // 字段在 createForm 中相关配置
              createFormOption: {
                ...elComponentConfig, // 标准 el-component 配置
                comType: '', // 控件型（如 input/select/...）
                visible: true, // 是否展示（true/false）,默认为 true
                disabled: false, // 是否禁用（true/false）,默认为 false
                default: '', // 默认值

                // 当 comType === 'select' 时生效
                enumList: [], // 枚举列表
              },
              // 字段在 editForm 表单中的相关配置
              editFormOption: {
                ...elComponentConfig, // 标准 el-component 配置
                comType: '', // 控件型（如 input/select/...）
                visible: true, // 是否展示（true/false）,默认为 true
                disabled: false, // 是否禁用（true/false）,默认为 false
                default: '', // 默认值

                // 当 comType === 'select' 时生效
                enumList: [], // 枚举列表
              },
              detailPanelOption: {
                ...elComponentConfig, // 标准 el-component 配置
              },
            },
          },
          required: [], // 必填字段列表
        },
        // table 相关配置
        tableConfig: {
          headerButtons: [
            {
              label: '', // 按钮名称
              eventKey: '', // 按钮事件名称
              // 按钮事件具体配置
              eventOption: {
                // 当 eventKey === 'showComponent'
                comName: '', // 组件名称
              },
              ...elButtonConfig, // 标准 el-button 配置
            },
          ], // 表头按钮
          rowButtons: [
            {
              label: '', // 按钮名称
              eventKey: '', // 按钮事件名称
              eventOption: {
                // 当 eventKey === 'showComponent'
                comName: '', // 组件名称

                // 当 eventKey === 'remove'时，可填
                params: {
                  // paramsKey 等于 参数的键值
                  // rowValueKey 等于 参数值，格式为 schema::tableKey，到 table 中找相应的字段
                  paramsKey: rowValueKey,
                },
              }, // 按钮事件具体配置
              ...elButtonConfig, // 标准 el-button 配置
            },
          ], // 行按钮
        },
        // search-bar 相关配置
        searchConfig: {},
        // 动态组件 相关配置
        componentConfig: {
          // create-form 表单相关配置
          createForm: {
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // edit-form 表单相关配置
          editForm: {
            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
            title: '', // 表单标题
            saveBtnText: '', // 保存按钮文案
          },
          // detail-panel 相关配置
          detailPanel: {
            mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
            title: '', // 详情面板标题
          },
          // ...支持用户动态扩展
        },
      },
    },
  ],
}

服务端启动

const { serverStart } = require('@tushi11/elpis');

// 启动 elpis 服务
const app = serverStart({});

自定义服务端

router-schema
router
controller
service
extend
config

前端构建

const { frontendBuild } = require('@tushi11/elpis');

// 编译构建前端工程
frontendBuild(process.env._ENV);

自定义页面拓展

在 app/pages/ 目录下写入口 entry.xxx.js

dashboard / custom-view 自定义页面扩展

在 app/pages/dashboard/xxx 下写页面

dashboard / schema-view / components 动态组件扩展

在 app/pages/dashboard/complex-view/schema-view/components 下写组件
配置到 app/pages/dashboard/complex-view/schema-view/components/components-config.js

schema-form 控件扩展

在 app/widgets/schema-form/complex-view 下写控件
配置到 app/widgets/schema-form/form-item-config.js

schema-search-bar 控件扩展

在 app/widgets/schema-search-bar/complex-view 下写控件
配置到 app/widgets/schema-search-bar/search-item-config.js

规范

引入组件

在 JS 中，用大写开头的驼峰

import HeaderContainer from '$elpisWidgets/header-container/header-container.vue';

在template中，用【小写 + '-'】连接（传参数，命名都用这个规则）
```
<header-container :title="'项目列表'"></header-container>
```

组件传参

组件传参用【'-'】，不用驼峰。
```
<sub-menu :menu-item="item"></sub-menu>
```

组件接收参数可以用驼峰

const { menuItem } = defineProps(['menuItem']);