K6CorePC库API说明
@k6/core-pc命名导出如下api
import {
getPluginPropTypes,
formCreateDrawer,
formDisplayDrawer,
websitePreviewDrawer
} from '@k6/core-pc'
getPluginPropTypes
getPluginPropTypes声明了表单组件的所有props
在写自定义表单组件时,使用@k6/core-pc导出的getPluginPropTypes来声明props
import { getPluginPropTypes } from '@k6/core-pc'
export default {
name: 'DemoFormInput',
props: {
...getPluginPropTypes
},
}
| 参数 | 类型 | 默认值 | 说明 |
|---|
| value/v-model | Number、String、Array、Object、Boolean | undefined | 绑定值 |
| disabled | Boolean | false | 禁用状态 |
| schema | Object | {} | 组件描述 |
| schema | Object | {} | 组件描述 |
| rule | Object | {} | 组件权限 |
| action | String | info | 表单状态,可选值:add-新增 edit-编辑 info-详情 |
| isExcel | Boolean | false | 是否为excel布局表单 |
| isApprove | Boolean | false | 是否为流程表单 |
| isChild | Boolean | false | 是否为明细表组件 |
| childSchema | Object | {} | 当前明细表的组件描述 |
| childIndex | Number | 0 | 当前组件所在的明细表行索引 |
| childData | Array | [] | 当前明细表的数据引用 |
formCreateDrawer
弹出新增状态的表单,普通表单为新增表单,流程表单为发起流程等效于原型链方法this.$form.create().show({})
record参数
| 参数 | 类型 | 默认值 | 所属表单 | 说明 |
|---|
| action | String | add | 普通&流程 | 新增状态 |
| formId | String | '' | 普通&流程 | 表单id |
| formType | Number | 0 | 普通&流程 | 表单id, 0-普通表单,1-流程表单 |
| name | String | '' | 普通&流程 | 弹框头部显示的标题 |
| definitionId | String | '' | 流程 | 流程定义id |
| flowType | Number | -1 | 流程 | 发起流程 |
// flowType 类型枚举值
export const KEY_FLOW_TYPE = {
CREATE: -1, // 创建流程 => 前端自己定义的状态
TODO: 3, // 待办
INITIATOR: 4, // 申请
DONE: 5, // 已办
DRAFT: 6, // 草稿
DELEGATE: 7, // 委托代理
MONITOR: 8, // 流程监控
DESTROY: 9, // 流程删除
SEARCH: 10, // 流程查询
NOTIFY: 11 // 知会
}
使用示例
import { formCreateDrawer } from '@k6/core-pc'
// 新增表单
function addHandler() {
formCreateDrawer().show({
record: {
action: KEY_FORM_ACTION_TYPE.ADD,
formId: state.formId,
formType: state.formType,
name: state.authRaw.name
},
onCloseCallback() {
// TODO: 关闭回调
}
})
}
formDisplayDrawer
弹出编辑和详情状态的表单, 等效于原型链方法this.$form.display().show({})
record参数
| 参数 | 类型 | 默认值 | 所属表单 | 说明 |
|---|
| action | String | '' | 普通&流程 | edit-编辑 info-详情 |
| formId | String | '' | 普通&流程 | 表单id |
| formType | Number | 0 | 普通&流程 | 表单id, 0-普通表单,1-流程表单 |
| name | String | '' | 普通&流程 | 弹框头部显示的标题 |
| rowId | String | '' | 普通&流程 | 数据id |
| flowType | Number | undefined | 流程 | 流程类型, 见flowType定义 |
| definitionId | String | '' | 流程 | 流程定义id |
| definitionName | String | '' | 流程 | 流程定义名称 |
| processesId | String | '' | 流程 | 流程实例id |
| taskId | String | '' | 流程 | flowType=todo办理节点必送 |
| startUserId | String | '' | 流程 | 流程发起人id |
| startTime | String | '' | 流程 | 流程发起时间 |
| processPhase | String | '' | 流程 | 实例状态flowType!=todo流程查看时送 |
使用示例
import { formDisplayDrawer } from '@k6/core-pc'
// 编辑某一行数据
function editHandler () {
formDisplayDrawer().show({
record: {
formId: state.formId,
action: KEY_FORM_ACTION_TYPE.EDIT,
rowId: record.id,
formType: state.formType,
name: state.authRaw.name
},
onCloseCallback: function() {
// TODO: 关闭回调
}
})
}
websitePreviewDrawer
弹出网站预览页面,使用iframe加载链接等效于原型链方法this.$websitePreviewDrawer().show({})
Props
| 参数 | 类型 | 默认值 | 说明 |
|---|
| url | String | '' | 加载链接 |
| title | String | '' | 弹框标题 |
| height | String | 90% | 弹框高度 |
| onCloseCallback | Function | () => {} | 关闭回调 |
使用示例
import { websitePreviewDrawer } from '@k6/core-pc'
// 编辑某一行数据
function previewUrl () {
websitePreviewDrawer.show({
url: 'http://www.baidu.com',
title: '百度',
onCloseCallback: function() {
// TODO: 关闭回调
}
})
}
DEMO下载
下载开发demo请点击这里