1.5.3 • Published 4 years ago

meiko v1.5.3

Weekly downloads
60
License
-
Repository
-
Last release
4 years ago

Meiko

前端通用组件与工具库,该框架基于iViewVueTypeScriptLess等。致力于更轻松的构建前端项目。

Demo 示例

克隆 Meiko 源代码,切换到example分支,并执行以下命令:

npm install # 安装依赖
npm run serve

在浏览器中输入http://127.0.0.1:1841即可,在此页面可预览整体示例以及组件示例。

框架安装

使用vue脚手架构建项目,激活如下选项:

  • TypeScript
  • Class-style Component
  • Less
  • TSLint

安装 Meiko 框架:

cd your-project
npm i meiko
npm i iview

编辑main.ts,引入框架:

import Vue from 'vue';
import App from './App.vue';
import router from './router';
// 导入 Meiko
import 'meiko';
import 'meiko/src/styles/index.less';

Vue.config.productionTip = false;

new Vue({
  router,
  render: (h) => h(App),
}).$mount('#app');

根目录添加vue.config.js,并编辑:

module.exports = {
  css: {
    loaderOptions: {
      less: {
        javascriptEnabled: true,
      },
    },
  },
};

组件使用说明

meiko框架基于iView,具体组件使用说明请参考官方网站,以下是meiko自集成组件。

MViewport

该组件为基础视图组件,为前端项目的基础组件。可参考示例代码中的App.vue

props:

属性说明类型默认值
logo项目 LogoString默认 Logo
name项目名称String-
modules项目模块,可代表系统模块分类或菜单分类,如果只有一个模块,则不显示此模块。该功能的初衷是为了支持体量可大可小的项目ViewportModule[][]
docUrl项目说明文档String-
user用户信息ViewportUser默认示例用户
lock蒙层Booleanfalse
userItems用户下拉菜单ViewportUserDropItem[][]

slots:

名称说明
tool工具栏组件,支持 MIconButton、Input、Select

events:

事件名说明返回值
on-module-change点击模块按钮时触发name
on-logout点击注销选项时触发-
on-item-click点击用户菜单选项时触发name

MIconButton

该组件为图标按钮组件,只能应用于MViewport的顶栏中,用于实现功能性按钮,其中icon属性请参考iView说明手册。

props:

属性说明类型默认值
icon图标String-
tooltip提示文字String-

events:

事件名说明返回值
on-click按钮点击时触发-

MIcon

该组件为图标按钮组件,用于实现功能性按钮,其中icon属性请参考iView说明手册。

props:

属性说明类型默认值
icon图标String-
tooltip提示文字String-
size图标的大小,单位是 pxNumber18
color图标的颜色String-

events:

事件名说明返回值
on-click点击时触发-

MForm

该组件为表单组件,便于更简单的编写与布局多输入项的页面。

props:

属性说明类型默认值
label-width标签宽度Number80
field-width输入项宽度Number200
confirm-text确认按钮文字String确认
columns输入项列数Number1
border显示边框Booleanfalse
fields表单项FormField[][]
values表单数据,支持 syncFormValues{}

events:

事件名说明返回值
on-confirm点击确认按钮时触发各字段值

MTable

该组件为表格组件,包含表格以及分页功能。可参考示例代码中的Table.vue

props:

属性说明类型默认值
height表格高度,单位 px,设置后,如果表格内容大于此值,会固定表头Number-
max-height表格最大高度,单位 px,设置后,如果表格内容大于此值,会固定表头Number-
columns表格列的配置描述,详见 iView 官方文档TableColumn[][]
data表格数据,详见 iView 官方文档TableData[][]
show-header是否显示表头Booleantrue
draggable是否启用拖拽Booleanfalse
show-page是否显示分页Booleanfalse
page-total分页数据总数Number0
page-current分页当前页码Number1
page-size分页每页条数Number10
show-search显示查询Booleanfalse
search-columns查询组件输入项列数Number3
search-fields查询组件输入项FormField[][]

slots:

名称说明绑定值
列定义 slot用于行内工具组件{row}: 行数据

events:

事件名说明返回值
on-table-current-change当表格的当前行发生变化的时候会触发currentRow:当前高亮行的数据oldCurrentRow:上一次高亮的数据
on-table-select在多选模式下有效,选中某一项时触发selection:已选项数据row:刚选择的项数据
on-table-select-cancel在多选模式下有效,取消选中某一项时触发selection:已选项数据row:刚选择的项数据
on-table-select-all在多选模式下有效,点击全选时触发selection:已选项数据
on-table-select-all-cancel在多选模式下有效,点击取消全选时触发selection:已选项数据
on-table-selection-change在多选模式下有效,只要选中项发生变化时就会触发selection:已选项数据
on-table-sort-change排序时有效,当点击排序时触发column:当前列数据key:排序依据的指标order:排序的顺序,值为 asc 或 desc
on-table-filter-change筛选时有效,筛选条件发生变化时触发当前列数据
on-table-row-click单击某一行时触发当前行的数据index
on-table-row-dblclick双击某一行时触发当前行的数据index
on-table-expand展开或收起某一行时触发row:当前行的数据status:当前的状态
on-table-drag-drop拖拽排序松开时触发,返回置换的两行数据索引index1, index2
on-table-search-change切换页码、每页条数与点击刷新按钮触发,推荐使用查询字段值,包含分页(激活查询时)start:起始 end: 截止(未激活查询时)
on-page-change页码改变的回调,返回改变后的页码页码
on-page-size-change切换每页条数时的回调,返回切换后的每页条数page-size

权限设计

页面的权限设计涵盖两个方面,基础视图MViewport以及路由页面中的组件,下面详细说明权限控制层面上的约定。

基础视图

基础视图MViewport可进行权限控制的组件有:

组件位置控制方式
模块按钮顶栏可通过ViewportModule类型中的hidden参数控制是否隐藏
菜单左边栏可通过ViewportModule类型中的hidden参数控制是否隐藏
工具按钮顶栏可通过v-if控制显示与隐藏
1.5.3

4 years ago

1.5.2

4 years ago

1.5.1

4 years ago

1.5.0

4 years ago

1.4.2

5 years ago

1.4.1

5 years ago

1.4.0

5 years ago

1.3.2

5 years ago

1.3.1

5 years ago

1.2.0

5 years ago

1.1.0

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago