MiniWidgetDialogTask openMiniWidget
用来控制小部件弹窗显示和关闭
引入
import { openMiniWidget } from '@ray-js/ray';
需引入
BaseKit
,且在>=3.0.3
版本才可使用。
参数
Object object
打开小部件弹窗的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
appId | string | 是 | 要打开的小部件 appid | |
pagePath | string | 否 | 对应的小部件页面相对 URL, 如果为空则打开首页 path 中 ? 后面的部分会成为 query | |
deviceId | string | 否 | 面板类型设备 id | |
groupId | string | 否 | 面板群组类型群组 id | |
style | string | 否 | 小部件样式,默认 middle | |
versionType | WidgetVersionType | 否 | 版本类型,默认 release | |
version | string | 否 | 版本号 | |
position | WidgetPosition | 否 | 展示位置,默认 bottom | |
autoDismiss | boolean | 否 | 点击空白处是否关闭 | |
autoCache | boolean | 否 | 是否优先展示默认缓存 对应属性在小程序容器 3.1.0 生效 | |
supportDark | boolean | 否 | 是否支持深色模式 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
返回值
MiniWidgetDialogTask 用来控制小部件弹窗显示和关闭
函数定义示例
/**
* 用来控制小部件弹窗显示和关闭
*/
interface MiniWidgetDialogTask {
/**
* 关闭小部件弹窗
*/
dismissMiniWidget(params: {
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
/**
* 监听 widget 关闭事件
*/
onWidgetDismiss(
listener: (params: {
/** widget 弹窗 ID */
dialogId: string;
}) => void,
): void;
/**
* 取消监听 widget 关闭事件
*/
offWidgetDismiss(
listener: (params: {
/** widget 弹窗 ID */
dialogId: string;
}) => void,
): void;
}
export function openMiniWidget(params: {
/** 要打开的小部件 appid */
appId: string;
/** 对应的小部件页面相对 URL, 如果为空则打开首页 path 中 ? 后面的部分会成为 query */
pagePath?: string;
/** 面板类型设备 ID */
deviceId?: string;
/** 面板群组类型群组 ID */
groupId?: string;
/** 小部件样式,默认 middle */
style?: string;
/** 版本类型,默认 release */
versionType?: WidgetVersionType;
/** 版本号 */
version?: string;
/** 展示位置,默认 bottom */
position?: WidgetPosition;
/** 点击空白处是否关闭 */
autoDismiss?: boolean;
/**
* 是否优先展示默认缓存
* 对应属性在小程序容器 3.1.0 生效
*/
autoCache?: boolean;
/** 是否支持深色模式 */
supportDark?: boolean;
complete?: () => void;
success?: (params: null) => void;
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): MiniWidgetDialogTask;
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。
MiniWidgetDialogTask
MiniWidgetDialogTask.dismissMiniWidget
关闭小部件弹窗
参数
Object object
关闭小部件弹窗的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
函数定义示例
/**
* 关闭小部件弹窗
*/
export function dismissMiniWidget(params: {
/** 接口调用结束的回调函数(调用成功、失败都会执行) */
complete?: () => void;
/** 接口调用成功的回调函数 */
success?: (params: null) => void;
/** 接口调用失败的回调函数 */
fail?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
MiniWidgetDialogTask.onWidgetDismiss
监听 widget 关闭事件
参数
function callback
监听 widget 关闭事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
dialogId | string | 是 | widget 弹窗 ID |
MiniWidgetDialogTask.offWidgetDismiss
取消监听 widget 关闭事件
参数
function callback
取消监听 widget 关闭事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
dialogId | string | 是 | widget 弹窗 ID |
👉 立即免费领取开发资源,体验涂鸦 MiniApp 小程序开发。