# Burgeon-R3 Tutorial
> Api

| 版本号
| Name |  Type  |   Description  |
| --- | --- | --- |
| R3.launchApplication   |  Function   |  启动应用程序   |
| R3.urlSearchParams     |  Function   |  对[URLSearchParams](https://developer.mozilla.org/zh-CN/docs/Web/API/URLSearchParams)的简单封装，通常配合Axios使用，用于提交参数。    |
| R3.getModuleName       |  Function   | 用于获取当前路由所对应界面，唯一模块标识    |
| R3.network             |  Object     | 对axios的封装，提供get、post方法（用法同axios相同）<br/>以及axios原对象  |

##### R3.launchApplication(projectConfig：JSON Object)
```
/**
   * @param projectConfig 项目配置
   * projectConfig: {
   *   image: {
   *     enterpriseLogo: '',  // 公司 Logo 图片
   *     enterpriseBanner: '', // 公司Banner 图片
   *   }, // 此配置项必传。
   *   globalComponent: {
   *     Login: '',  // 登录页
   *     WelcomePage: '', // 欢迎页
   *   }, // 此配置项必传。
   *   externalModules: { // 项目自定义界面组件入口
   *      keyOne: VueComponentOne,
   *      keyTwo: VueComponentTwo,
   *      ...
   *   }, // 如无自定义界面，此配置项可不传参。
   *   externalModals: {  // 项目自定义弹框（模态框）组件
   *     keyOne: VueComponentOne,
   *     keyTwo: VueComponentTwo,
   *     ...
   *   }, // 如无自定义弹窗，此配置项可不传参。
   *   projectRoutes: [  // 项目自定义路由，一般情况下用不到此配置。
   *     {
   *       path: '/register',
   *       component: VueComponentForRegister
   *     }
   *   ], // 此配置项可不传参。
   *   quietRoutes: [ '/register' ],  // 项目中针对403的请求，都会默认跳转到登录页面。处于静默路由列表的路由界面则不进行跳转。一般情况用不到此配置。默认值为[]，此配置项可不传参。
   *   Version： '1.4', // 后台框架API版本号，目前只支持['1.3', '1.4']其中一个。默认值是"1.4"，此配置项可不传参。
   *   enableGateWay: true, // 开启 | 关闭 网关(默认开启)，此配置项可不传参。
   *   enableJflow: true, // 开启JFlow插件功能（默认关闭），此配置项可不传参。
   *   jflowRequestDomain： 'http(s)://domain:port', // jflow请求转发的域名或者IP（只有在enableJflow为true时生效），此配置项可不传参。
   * }
   */

```


> Usage e.g.
```
import R3 from '@syman/burgeon-r3';

// 企业Logo、Banner配置信息
import enterpriseLogo from './src/assets/image/logo.png';
import enterpriseBanner from './src/assets/image/banner.png';
import Login from './src/component/Login';
import WelcomePage from './src/component/WelcomePage'

R3.launchApplication({
  image: { enterpriseLogo,  enterpriseBanner },
  globalComponent: { Login, WelcomePage },
  externalModules: {
    TheKeyNameOfMyPage: {
      component: {
        template: '<h1>Here is my customized component.</h1>'
      }
    }
    ...
  }
});
```

代码结构
全局引入组件模块：/src/config/globalComponents.js

iframe文件夹（用于存放内嵌iframe页面的）
/iframe/AddSubWareRule/index.html   分仓规则设置-设置规则仓库关系  页面  ---已翻新
/iframe/BIReport/DeliveryExpress.html   BI看板-发货物流看板 页面
/iframe/BIReport/ProductIndex.html   BI看板-发货物流看板 页面
/iframe/BIReport/SaleCenter.html   BI看板-销售看板 页面
/iframe/ComboProduct/AddProduct.html   组合商品管理-新增 页面
/iframe/ComboProduct/EditProduct.html  组合商品管理-修改 页面
/iframe/Content 文件夹（存放相关js,css,iconfont等）
/iframe/DownloadexpressManage/index.html  下载物流公司 弹框
/iframe/DownloadPO/index.html  下载PO单 弹框 ---无效
/iframe/EleFaceSheet/index.html  平台店铺-电子面单设置  弹框 ---无效
/iframe/Home/AliBill_authorize.html ---无效
/iframe/Home/Index.html 首页 页面/弹框
/iframe/IESPlatProduct/PlatProductAdd.html 下载商品 弹框
/iframe/IESPlatProduct/SetInventory.html  ---无效
/iframe/IESProduct/AddGift.html ---无效
/iframe/IESProduct/IESProductSKU2.html ---无效
/iframe/images iframe静态图片
/iframe/JdCloudProduct/DownloadProduct.html -京东云枢纽商品-下载商品 弹框
/iframe/JdOrder/DownloadOrder.html 京东订单接口-下载订单 弹框
/iframe/JdRefund/DownloadRefund.html -京东退单接口-下载退单 弹框
/iframe/JITManage/addJIT.html 新增JIT仓库 弹框
/iframe/JITManage/modifyJIT.html 修改JIT仓库 弹框
/iframe/Languages iframe语言
/iframe/LocalProduct/ViewStock.html 本地商品维护-查看库存 弹框
/iframe/media iframe中静态图片
/iframe/OMSAccountBill/AliBill_authorize.html  ---无效
/iframe/OMSAccountBill/Authorize.html  ---无效
/iframe/OMSAccountBill/Download.html  财务管理-财务对账-平台原始账单-下载 弹框
/iframe/OMSActive/OMSActiveAdd.html  活动管理 -> 新增活动 弹框
/iframe/OMSActive/OMSActiveUpdate.html  活动管理 -> 修改活动 弹框
/iframe/OMSOrder/OrderDownload.html  下载订单 弹框
/iframe/OMSRefundOrder/OMSExchangeOrderView_Add.html  换货单新增 弹框
/iframe/OMSRefundOrder/OMSOnlineOrderView.html  ---无效
/iframe/OMSRefundOrder/OMSRefundOrderView_Add.html  退货单新增 弹框
/iframe/OMSRefundOrder/OMSRefundOrderView_update.html  进销存-配货管理-后置扫描出库-<整页面> 页面
/iframe/OrderPrint/ManualDelivery.html  订单打印-手工发货 弹框 ---已翻新
/iframe/OrderPrint/PrintExpressList.html  订单打印-打印物流单 弹框
/iframe/OrderPrint/PrintShippingOrder.html  订单打印-打印发货单 弹框
/iframe/OrderSplit/orderSplit.html  订单拆分 弹框
/iframe/Package/PrintSign.html  包裹签收单-打印包裹签收单 弹框
/iframe/Package/ScanSign.html  包裹签收单-扫描签收 弹框
/iframe/PrintConfig/SetPrintConfig.html  设置打印配置页面 弹框
/iframe/PrintTemplate/AddTemplate.html  新增打印模板 弹框  ---无效
/iframe/PrintTemplate/EditTemplate.html  修改打印模板 弹框
/iframe/ScanIn/Index.html  扫描入库 页面
/iframe/ScanOut/Index.html  扫描出库 页面
/iframe/ScanOut/OrderBasicInfo.html  ---无效
/iframe/ScanOut/PostPrint.html  进销存-配货管理-后置扫描出库-<整页面> 页面
/iframe/ScanOut/Weigh.html  订单称重 页面
/iframe/Scripts 相关js
/iframe/setExpressRules/index.html  设置物流规则 弹框 ---已翻新
/iframe/setExpressRules/SetCodExpressRule.html  店铺物流规则设置-设置COD物流规则 弹框 ---已翻新
/iframe/setLogisticsArea/deliveryDetail.html  ---无效
/iframe/setLogisticsArea/index.html  物流区域设置 页面 
/iframe/setLogisticsArea/setRemoveRegion.html  ---无效
/iframe/setLogisticsRules/index.html  物流规则 设置物流规则关系 弹框 ---已翻新
/iframe/setLogisticsRulesShip/index.html  ---无效
/iframe/setWareLogisticsRule/CODSetLogisticsRule.html  仓库物流规则设置-设置COD物流规则 弹框 ---已翻新
/iframe/setLogisticsRules/SetLogisticsRule.html  仓库物流规则设置-设置物流规则 弹框 ---已翻新
/iframe/ShopStrategy/SetMergeStrategy.html  店铺自动合并策略-设置 弹框
/iframe/ShopStrategy/SetMergeStrategy.html  店铺自动合并策略-设置 弹框
/iframe/SysGrid/MyExport.html 进销存-订单打印-订单打印-导出发货单 弹框
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_Acceptance.html 进销存-配货管理-拣货单管理-验收 弹框
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_Distribute.html 进销存-配货管理-拣货单管理-分配 弹框
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_PrintPick.html 进销存-配货管理-拣货单管理-打印拣货单 弹框
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_View_BasicInfo.html ---无效
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_View_OrderList.html ---无效
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_View_OrderProductList.html ---无效
/iframe/T_OMSPICKINGLIST/T_OMSPICKINGLIST_View.html 进销存-配货管理-拣货单管理-查看 弹框
/iframe/T_OMSPrintTemplate/T_OMSPrintTemplate_Add.html  进销存-订单打印-打印模板配置-新增 弹框
/iframe/T_OMSPRINTPRDER/T_OMSPRINTPRDER_PrintPick.html  ---无效
/iframe/T_OMSPRINTPRDER/T_OMSPRINTPRDER_PrintTaoda.html  ---无效
/iframe/T_OMSPRINTPRDER/T_OMSPRINTPRDER_SaveLogistNum.html  ---无效
/iframe/V_OMSMS_Template/SMSTemplate_add.html  订单系统-短信管理-系统短信模板-新增 弹框
/iframe/V_OMSolOrder_ActTest/V_OMSOLORDER_ACTTESTView_Add.html  订单系统-短信管理-短信模板管理-新增 弹框
/iframe/V_OMSStorageIn/V_OMSStorageInView_Match.bak.html  ---无效
/iframe/V_OMSStorageIn/V_OMSStorageInView_Match.html  ---无效
/iframe/VipCloubProduct/DownloadCancle.html  ---无效
/iframe/VipCloubProduct/DownLoadOrderPo.html  PO下载 弹框
/iframe/VipCloubProduct/DownloadProduct.html  唯品会商品-商品下载 弹框
/iframe/VipCloubProduct/JITDELIVERYOrderDowm.html  唯品会寻仓订单-下载订单 弹框
/iframe/VipCloubProduct/JitxOrderDown.html  唯品会jitx订单-下载订单 弹框
/iframe/VipCloubProduct/PrintXT.html  打印箱贴 弹框
/iframe/VipCloubProduct/SCJITPO.html  生成拣货单 弹框 --已翻新
/iframe/VipCloubProduct/Select.html  ---无效
/iframe/VipCloubProduct/SXDownloadProduct.html  ---无效
/iframe/VipCloubProduct/UpdatePo.html  唯品会po单-更新po单 弹框 ---已翻新
/iframe/VipCloubProduct/XZDowmPo.html  下载拣货单 ---已翻新
/iframe/Warehouse/SetSendArea.html  实体电仓管理-设置配送区域 

src文件夹


static（静态资源，主要存放了R3框架包）


