0.0.26-5 • Published 1 year ago

kxkj-common1 v0.0.26-5

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

kxkj-common

This template should help get you started developing with Vue 3 in Vite. 是基于vue3项目,对element-plus及vxe-table进行的二次封装.

使用方式

1. 安装kxkj-common:npm install --save kxkj-common@对应版本号-如不带则下载最新版本

npm install --save kxkj-common

2. main.js 引用

import { createApp } from "vue";
import App from "./App.vue";
import kxkjCommon from 'kxkj-common'
import "kxkj-common/dist/style.css"

let app = createApp(App);

app.use(kxkjCommon);
app.mount("#app");

3. 页面中使用kxkjCommon组件:表格 KxVxTable

<template>
	<KxVxTable
		:tableData="tableData"
        :total="total"
        :tableConfig="tableConfig"
        :loading="loading"
        placeholder="员工姓名"
        @search="getPageList"
        @clear="getPageList"
        v-model:pageNum="pageRequest.pageNum"
        v-model:pageSize="pageRequest.pageSize"
        v-model:uname="queryParam.uname"
    >
	</KxVxTable>
</template>

属性

名称说明类型默认
tableData表格数据Array
tableConfig表格配置项(表头,权限,导入导出配置)Object
loading表格加载数据的过渡效果Boolean
placeholder默认搜索框提示内容String关键字名称
v-model:uname默认搜索参数String
total数据总数Number
v-model:pageNum当前页数Number1
v-model:pageSize每页显示条目个数Number15
showRadio是否显示单选框Booleanfalse
showSelCheckbox是否显示多选框Booleanfalse
checkBoxConfig单选框配置项Object

事件

名称说明
search点击搜索按钮时触发
clear点击重置按钮时触发
checkbox-change复选框改变时触发
select-all复选框全选时触发
cell-click单元格点击时触发

插槽

插槽名说明
add搜索栏前面按钮区域
search搜索栏本体
toolSlot搜索栏尾部按钮区域
btn表格列操作区域

4. 页面中使用kxkjCommon组件:左侧树 KxSelTree

<template>
	<KxSelTree
      :catalogTree="TreeData"
      :defaultCheckedKeys="defaultCheckedKeys"
      :defaultLevel="defaultOpenLevel"
      @transfer="getCurrNodeInfo"
      :defaultProps="defaultProps"
      cardStyle
      cardTitle="标题"
    >
    	<template #viewdata></template>
	</KxSelTree
</template>

属性

名称说明类型默认
catalogTree树显示的数据Array
defaultCheckedKeys默认选中数据Array
defaultLevel默认展开数据Array
defaultProps配置数据Object
placeholderName树搜索关键字String
nodeKey每个树节点用来作为唯一标识的属性,整棵树应该是唯一的String
emptyText内容为空的时候展示的文本String
isRightView判断是否需要右侧的视图Boolean
cardStyle是否需要卡片样式Boolean
cardTitle卡片样式下树的标题String
hasOperation树书否需要编辑、删除操作Boolean

事件

事件名说明参数
refresh刷新树数据
transfer节点点击回调data:节点数据
edit节点点击编辑按钮回调data:节点数据
delete节点点击删除按钮回调data:节点数据

5.页面中使用kxkjCommon组件:表单 KxForm【有副作用待优化】

<template>
	<KxForm tableName="表单名称" :state="表单状态" :sendInfo="sendInfo"  @handleSuccess="handleSuccess">
</template>

属性

名称说明类型默认
tableName表单名称String
state表单状态String新增-编辑-预览,默认无
sendInfo外部传进来需要与表单合并的数据Object
infoKey表单主键名称Stringuid
infoId表单主键值String
isFooter是否需要操作按钮Booleanfalse
divUrl请求地址前缀String
adjustable外部提交Booleanfalse
isLabel表单是否已文本形式显示Booleanfalse

事件

事件名说明参数
handleSuccess外部提交和自动提交成功回调res:接口调用结果,info Form:表单数据
initSuccess调用info接口完成后回调data:接口返回的data数据
initMustChoice必录项初始化完毕ruleRequireList:必录项信息点数据

6.页面中使用kxkjCommon组件:权限按钮 KxButton【有副作用待优化】

<template>
	<KxButton label="删除" :perms="权限名称" type="primary" @click="点击事件" />
</template>

属性

名称说明类型默认
label按钮文本String
perms权限名称String
其他的参考element-plus按钮属性

插槽

名称说明
label按钮文本插槽

7.页面中使用kxkjCommon组件:弹窗 KxDialog \ 抽屉 KxDrawer

<template>
    <KxDialog v-model:isShow="showMoreSelect" dialogName="弹窗名字" state="浏览" :isShowState="false" dialogWidth="50%">
      <template #content>
        弹窗内容
      </template>
    </KxDialog>

	<KxDrawer v-model:isShow="showMoreSelect" dialogName="抽屉名字" state="浏览" :isShowState="false" dialogWidth="50%">
      <template #content>
        抽屉内容
      </template>
    </KxDrawer>
</template>

属性

名称说明类型默认
v-model:isShow显示隐藏Booleanfalse
dialogName名字String
appendBody自身是否插入至 body 元素上Booleanfalse
dialogWidth表格宽度String30%
state弹窗、抽屉状态String新增-预览-编辑,默认无
isShowState是否显示状态信息Booleantrue
isFooter是否需要按钮Booleantrue
confirmButtonText提交按钮名称String保存
customerFooter是否自定义按钮Booleanfalse
loading加载动画Booleanfalse

插槽

名称说明
content弹窗、抽屉内容
operate自定义按钮区域

事件

事件名称说明
onSubmit点击保存按钮回调
onCancel关闭弹窗、抽屉回调