更新记录

1.0.0（2024-04-15）

uni-app x 环境 支持使用 uni-app 小程序

+支持打开，关闭，隐藏，展示等小程序管理方法

+支持小程序与宿主的双向参数传递

平台兼容性

uni-unimp

注意事项

• 导入示例项目时，需要勾选 uni-app x

• 导入插件后需提交云端打包后才能生效，真机运行时推荐使用自定义调试基座

• 当前版本仅支持打开一个小程序实例，这个问题稍后会修复

用法说明

加载uniMP模块

在调用uni小程序API时需先调用uni.createUniMPContext方法加载uni小程序管理模块。
示例如下：

let mp = uni.createUniMPContext()
//通过mp可调用方法操作uni小程序
mp.openUniMP({
  appid:'小程序的appid'
});

installUniMP(options,callback)

通过wgt安装uni小程序到宿主App中，示例如下：

mp.installUniMP({
  appid: 'uni小程序的appid',
  wgtFile: 'uni小程序的wgt文件路径'
}, (ret)=>{
  console.log('installUniMP: '+JSON.stringify(ret));
});

options参数说明

callback回调参数说明

openUniMP(options,callback)

打开uni小程序，示例如下：

mp.openUniMP({
  appid: 'uni小程序的appid'
}, (ret)=>{
  console.log('openUniMP: '+JSON.stringify(ret));
});

options参数说明

callback回调参数说明

closeUniMP(appid,callback)

关闭已经运行的uni小程序，示例如下：

mp.closeUniMP('uni小程序的appid', (ret)=>{
  console.log('closeUniMP: '+JSON.stringify(ret));
});

参数说明

callback回调参数说明

hideUniMP(appid,callback)

隐藏运行在前台的uni小程序，示例如下：

mp.hideUniMP('uni小程序的appid', (ret)=>{
  console.log('hideUniMP: '+JSON.stringify(ret));
});

参数说明

callback回调参数说明

showUniMP(appid,callback)

将运行在后台的uni小程序切换到前台显示，示例如下：

mp.showUniMP('uni小程序的appid', (ret)=>{
  console.log('showUniMP: '+JSON.stringify(ret));
});

参数说明

callback回调参数说明

getUniMPVersion(appid,callback)

获取安装的uni小程序版本信息，示例如下：

mp.getUniMPVersion('uni小程序的appid', (ret)=>{
  console.log('getUniMPVersion: '+JSON.stringify(ret));
});

参数说明

callback回调参数说明

versionInfo参数说明

onUniMPEventReceive(callback)

监听uni小程序发送的event事件，建议在宿主App的应用生命周期onLaunch中进行监听。在uni小程序中调用uni.sendHostEvent发送event事件后触发。

示例如下：

export default {
  onLaunch: function() {
    console.log('Host App Launch');

    //监听uni小程序发送的事件
    mp.onUniMPEventReceive(ret=>{
            console.log('Receive event from MP: '+JSON.stringify(ret));
    });
  },
  //...
}

callback回调参数说明

sendUniMPEvent(appid,event,data,callback)

注：uni小程序必须处于运行状态，否则会发送失败

宿主App向uni小程序发送event事件，在uni小程序中调用uni.onHostEventReceive监听。

示例如下：

mp.sendUniMPEvent('uni小程序的appid', 'event事件名称', '要传递的数据', (ret) => {
  //发送消息成功回调
  console.log('Send event to MP: '+JSON.stringify(ret));
});

参数说明

setDefaultMenuItems(options,callback)

设置胶囊按钮菜单 ActionSheet 项

示例如下：

mp.setDefaultMenuItems({
    items: [{
        title: "关于",
        id: "about"
    }, {
        title: "分享",
        id: "share"
    }]
}, ret => {
    if (ret.id == "about") {
        console.log("点击了 关于")
    }
})

参数说明

options 参数说明

actionSheetItem 参数说明

callback回调参数说明

JSON Object类型

uni小程序使用的API

获取启动参数

宿主App启动uni小程序传入的extraData参数可在小程序项目App.vue的应用生命周期onLaunch、onShow中获取，

示例如下：

//首次启动
onLaunch: function(info) {
    console.log('App Launch:',info);
}
//从后台切换到前台
onShow: function(info) {
    console.log('App Launch:',info);
}

info参数说明

JSON Object类型

ReferrerInfo参数说明

uni.sendHostEvent(event,data,ret,callback)

uni小程序向宿主App发送event事件，在宿主App中可调用onUniMPEventReceive监听接收event事件。

示例如下：

uni.sendHostEvent(event, data, (ret) => {
  //发送消息成功回调
  console.log('Send event to Host: '+JSON.stringify(ret));
});

参数说明

callback回调参数说明

uni.onHostEventReceive(callback)

uni小程序监听宿主App发送的event事件，建议在uni小程序应用生命周期onLaunch中监听。在uni宿主App中调用sendUniMPEvent发送event事件后触发。

示例如下：

export default {
  onLaunch: function() {
    console.log('App Launch');

    //监听宿主App通讯数据
    uni.onHostEventReceive((event,data)=>{
            console.log('Receive event('+event+') from HOST: '+JSON.stringify(data));
    });
  },
  //...
}

callback回调参数说明