工具/交互方法
#
$w.utils.showToast$w.utils.showToast(options):void
#
功能描述显示提示框
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
title | title | 是 | 提示的内容 | |
icon | string | 'success' | 否 | 图标 |
image | string | 否 | 自定义图标的本地路径或 url ,image 的优先级高于 icon | |
duration | number | 1500 | 否 | 提示的延迟时间(毫秒) |
入参 object.icon 的合法值:
值 | 说明 |
---|---|
success | 显示成功图标,此时 title 文本最多显示 7 个汉字长度 |
error | 显示失败图标,此时 title 文本最多显示 7 个汉字长度 |
loading | 显示加载图标,此时 title 文本最多显示 7 个汉字长度 |
none | 不显示图标,此时 title 文本最多可显示两行,1.9.0 及以上版本支持 |
#
示例$w.utils.showToast({ title: '成功', icon: 'success', duration: 2000, // 2秒});
$w.utils.showToast({ title: '失败', icon: 'error', duration: 2000, // 2秒});
#
$w.utils.showLoading#
功能描述显示 loading 提示框。需主动调用 $w.utils.hideLoading 才能关闭提示框。
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
title | string | false | 提示的内容 |
#
示例$w.utils.showLoading({ title: '加载中',});
#
$w.utils.hideLoading#
功能描述隐藏 loading 提示框。
#
示例$w.utils.hideLoading();
#
$w.utils.showModal$w.utils.showModal(options):void
#
功能描述显示模态对话框。
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
title | string | 否 | 提示的标题 | |
content | string | 否 | 提示的内容 | |
showCancel | boolean | true | 否 | 是否显示取消按钮 |
cancelText | string | '取消' | 否 | 取消按钮的文字,最多 4 个字符 |
cancelColor | string | #000000 | 否 | 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 |
confirmText | string | '确定' | 否 | 确认按钮的文字,最多 4 个字符 |
confirmColor | string | #576B95 | 否 | 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
入参 object.success 回调函数:
属性 | 类型 | 说明 |
---|---|---|
content | string | editable 为 true 时,用户输入的文本 |
confirm | boolean | 为 true 时,表示用户点击了确定按钮 |
cancel | boolean | 为 true 时,表示用户点击了取消 |
#
示例$w.utils.showModal({ title: '提示', content: '这是一个模态弹窗', success(res) { if (res.confirm) { console.log('用户点击确定'); } else if (res.cancel) { console.log('用户点击取消'); } },});
#
$w.utils.callPhone#
功能描述拨打电话
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
tel | string | 是 | 电话号码 |
#
示例$w.utils.callPhone({ tel: '18718573322',});
#
$w.utils.scanCode#
功能描述调起扫码界面进行扫码
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
onlyFromCamera | boolean | false | 否 | 是否只能从相机扫码,不允许从相册选择图片 |
scanType | string[] | ['barCode', 'qrCode'] | 否 | 扫码类型 |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
scanType 的值有:
合法值 | 说明 |
---|---|
barCode | 条码 |
qrCode | 二维码 |
#
出参入参为 object 类型:
属性 | 类型 | 说明 |
---|---|---|
result | string | 所扫码的内容 |
scanType | string[] | 所扫码的类型 |
#
示例// 只允许从相机扫码$w.utils.scanCode({ onlyFromCamera: true, success: (res) => { console.log(res); },});
#
$w.utils.navigateTo#
功能描述保留当前页面,跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pageId | string | '' | 是 | 页面 id |
packageName | string | '' | 否 | 子应用包地址,例如 packages/subapp |
params | object | {} | 否 | query object 对象 |
#
示例$w.utils.navigateTo({ pageId: 'index', // 页面 Id params: { key: 'value' },});
#
$w.utils.redirectTo#
功能描述关闭当前页面,跳转到应用内的某个页面。
#
入参入参为 object 类型:
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pageId | string | '' | 是 | 页面 id |
packageName | string | '' | 否 | 子应用名称 |
params | object | {} | 否 | query object 对象 |
#
示例$w.utils.redirectTo({ pageId: 'home', // 页面 Id packageName: '', // 主应用为空或不填,子模块填写 子包目录,查找位置 子包编辑器 --- 页面 --- 子包目录 params: { key: 'value' },});
#
$w.utils.reLaunch#
功能描述关闭所有页面,打开到应用内的某个页面(因浏览器限制,web 下能后退页面)
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pageId | string | '' | 是 | 页面 id |
packageName | string | '' | 否 | 子应用名称 |
params | object | {} | 否 | query object 对象 |
#
示例$w.utils.reLaunch({ pageId: 'home', // 页面 Id packageName: '', // 主应用为空或不填,子模块填写 子包目录,查找位置 子包编辑器 --- 页面 --- 子包目录 params: {},});
#
$w.utils.relaunchHome#
功能描述返回首页
#
入参无
#
出参无
#
示例$w.utils.relaunchHome();
#
$w.utils.navigateBack#
功能描述关闭当前页面,返回上一页面或多级页面。
#
入参#
options: object属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
delta | number | 1 | 否 | 返回的页面数,如果 delta 大于现有页面数,则返回到首页。 |
#
示例$w.utils.navigateBack();