本页目录
title: "openMiniWidget - 打开小部件弹窗"

title: "openMiniWidget - 打开小部件弹窗"

openMiniWidget(params: Object)

版本要求:
BaseKit≥3.0.3@ray-js/ray≥0.8.0
支持平台:
iOSAndroid
import { openMiniWidget } from '@ray-js/ray';

// Promise 调用
try {
  const res = await openMiniWidget({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

打开小部件弹窗

参数

属性类型必填默认值说明BaseKit 最低版本
appIdstring是-要打开的小部件appid-
pagePathstring否-对应的小部件页面相对url, 如果为空则打开首页,path 中 ? 后面的部分会成为 query-
deviceIdstring否-面板类型设备id-
groupIdstring否-面板群组类型群组id-
stylestring否"middle"小部件样式,默认middle-
versionType"release" | "preview"否'release'版本类型,默认release-
versionstring否-版本号-
position"bottom" | "top" | "center"否'bottom'展示位置,默认bottom-
autoDismissboolean否true点击空白处是否关闭v3.0.4
autoCacheboolean否true是否优先展示默认缓存 对应属性在小程序容器3.1.0生效v3.1.0
supportDarkboolean否true是否支持深色模式v3.1.3
complete() => void否-接口调用结束的回调函数（调用成功、失败都会执行）-
success() => void否-接口调用成功的回调函数-
fail(params: Object) => void否-接口调用失败的回调函数-
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

类型：MiniWidgetDialog
MiniWidgetDialog
属性类型说明BaseKit 最低版本
dismissMiniWidgetfunction关闭小部件弹窗-
onWidgetDismissfunction监听widget关闭事件v3.0.4
offWidgetDismissfunction取消监听widget关闭事件v3.0.4

合法值

versionType
值说明BaseKit 最低版本
release线上版本-
preview预发版本-
position
值说明BaseKit 最低版本
bottom居底展示-
top居顶展示-
center居中展示v3.4.0

示例代码

import { home, openMiniWidget } from '@ray-js/ray'

// deviceId 为面板类 widget 的可选参数，取当前账号下第一台设备。
const { homeId } = await home.getCurrentHomeInfo();
const { devIds } = await home.getDeviceIdList({ ownerId: homeId, roomId: 80079606, devId: "vdevo178158139173829" });

const dialog = await openMiniWidget({
  appId: "ty8gpajcefnj0capj4",
  deviceId: devIds[0],
  pagePath: "/cards/alarm/index",
  position: "bottom",
  style: "1.3",
  versionType: "release",
  autoCache: false,
  autoDismiss: true,
  supportDark: true,
});

console.log(dialog);