Extends-Api

141 阅读2分钟

Extends-Api

跳转到的地方

一、介绍

  @burgeon/extends-api 扩展化API;   为了更高效地管理及更便捷地完成项目的配置,特向项目组提供此配置项。

二、引入

// 项目入口文件index.js中
import CustomConfig from 'burgeonConfig/customized.config.js'
  • 提示: burgeonConfig = 'node_modules/@burgeon/project-logic/config'点击跳转 burgeonConfig源于依赖包@burgeon/project-logic",在使用前请确保项目已经安装了相关依赖。
  • 特别地:引入后会将CustomConfig挂载到全局实例上,使用 this.$OMS2 访问

Usage Example

// 引入配置
import CustomConfig from 'burgeonConfig/config.ex';

// 修改定制弹窗界面配置项
CustomConfig.editCusModalConfig({ CHANNELINVENTORY:{
  component: () => import('@/views/modal/inventoryCenter/channelInventory.vue'),
}})

R3.launchApplication({
    externalModules: CustomConfig.cusPageConfig, // 自定义界面
    externalModals: CustomConfig.cusModalConfig, // 自定义弹框
    ...
});

三、Properties

提示:由于默认配置项较多,在此不作举例,请在项目中打印查看。

NameTypeDescriptionDefault Value
CustomConfig.cusPageConfigObject自定义界面配置项{}
CustomConfig.cusModalConfigObject定制弹窗界面配置项{}
CustomConfig.cusExternalTreeDatasObject树结构配置项{}
CustomConfig.cusServiceObject接口配置项{}
CustomConfig.cusLabelListArray订单管理专用label配置项[]
CustomConfig.cusOrderLogoObjectorderLogo配置项{}
CustomConfig.cusWaterMarkConfigObject水印配置项{}
CustomConfig.cusFilterUrlConfigObject过滤报错接口配置项{}
CustomConfig.connectorObject订单详情-半定制-配置项{}
CustomConfig.omsUtilsClass公用方法的封装{}
[CustomConfig.BtnConfig](#2. BtnConfig)Class按钮配置{}

omsUtils

  • 说明:一个方法集
  • 使用:
// 如获取按钮权限的方法:
this.$OMS2.omsUtils.getPermissions(this,'btnConfig','orderManager');
  • 内置方法如下:
Method说明参数返回
msgTips(self, type, tips, tipsType = 1)
modalShow$Model类型的提示框(self, tips, okKey, data, ...callback)
getPermissions按钮权限请求方法(self, arrry, params, isIndependent)接口返回的button集

2. BtnConfig

  • 说明:功能按钮的封装(根据webname匹配)
  • 使用:
// 1. mounted中初始化this指向
mounted() {
	this.$OMS2.BtnConfig.target = this;
}
// 2. data中赋值
data() {
	return {
		btnConfig: this.$OMS2.BtnConfig.config()
	}
}
  • 内置按钮有:
按钮key备注
webname: 'Newly added',新增
webname: 'Revising Logistics',批量修改物流
webname: 'holdOrder',批量Hold单
webname: 'Drop-out copy',丢单复制

四、Methods

NameTypeDescription
CustomConfig.editCusModalConfigFunction用于编辑定制弹窗配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editCusPageConfigFunction用于编辑定制页面配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.cusExternalTreeDatasFunction用于编辑树结构配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editCusServiceFunction用于编辑接口配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editCusLabelListFunction用于编辑Label配置项的方法,接收一个参数( [] )
1.参数为要修改的目标配置项
CustomConfig.editCusOrderLogoFunction用于编辑OrderLogo配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editCusWaterMarkConfigFunction用于编辑水印配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editCusFilterUrlConfigFunction用于编辑FilterUrl配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项
CustomConfig.editConnectorFunction用于修改配置项的方法,接收一个参数( {} )
1.参数为要修改的目标配置项

五、版本说明

VersionDescription
v1.0.0初始化API
v1.0.1首封装测试
v1.0.2service引用微调
v1.0.3新增一些配置项
v1.0.4modify CC to CustomConfig
v1.0.5add 下载模板及确认导入的Api配置
v1.0.6add filterUrlForNetworkScript配置
v1.0.7add downLoadAll.config配置
v1.0.9add R3.launchApplication.globalComponent配置
v1.0.10add R3.launchApplication.image配置
v1.0.11add 初始化项目配置
v1.0.12add btnConfig/commonUtils……