K6CorePC库API

爱搭贝
更新于2025-01-23

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-modelNumber、String、Array、Object、Booleanundefined绑定值
disabledBooleanfalse禁用状态
schemaObject{}组件描述
schemaObject{}组件描述
ruleObject{}组件权限
actionStringinfo表单状态,可选值:add-新增 edit-编辑 info-详情
isExcelBooleanfalse是否为excel布局表单
isApproveBooleanfalse是否为流程表单
isChildBooleanfalse是否为明细表组件
childSchemaObject{}当前明细表的组件描述
childIndexNumber0当前组件所在的明细表行索引
childDataArray[]当前明细表的数据引用

formCreateDrawer

弹出新增状态的表单,普通表单为新增表单,流程表单为发起流程等效于原型链方法this.$form.create().show({})

record参数

参数类型默认值所属表单说明
actionStringadd普通&流程新增状态
formIdString''普通&流程表单id
formTypeNumber0普通&流程表单id, 0-普通表单,1-流程表单
nameString''普通&流程弹框头部显示的标题
definitionIdString''流程流程定义id
flowTypeNumber-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参数

参数类型默认值所属表单说明
actionString''普通&流程edit-编辑 info-详情
formIdString''普通&流程表单id
formTypeNumber0普通&流程表单id, 0-普通表单,1-流程表单
nameString''普通&流程弹框头部显示的标题
rowIdString''普通&流程数据id
flowTypeNumberundefined流程流程类型, 见flowType定义
definitionIdString''流程流程定义id
definitionNameString''流程流程定义名称
processesIdString''流程流程实例id
taskIdString''流程flowType=todo办理节点必送
startUserIdString''流程流程发起人id
startTimeString''流程流程发起时间
processPhaseString''流程实例状态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

参数类型默认值说明
urlString''加载链接
titleString''弹框标题
heightString90%弹框高度
onCloseCallbackFunction() => {}关闭回调

使用示例

import { websitePreviewDrawer } from '@k6/core-pc'
// 编辑某一行数据
function previewUrl () {
  websitePreviewDrawer.show({
    url: 'http://www.baidu.com',
    title: '百度',
    onCloseCallback: function() {
       // TODO: 关闭回调
    }
  })
}

DEMO下载

下载开发demo请点击这里