文档

对话框

更新时间:

本文介绍对话框类WVUIDialog相关的JSAPI,供您在通过跨平台DevOps创建H5端应用或者小程序时参考。对话框类WVUIDialog JSAPI提供提示框、确认框、警告框、权限引导提示框等相关能力。

WVUIDialog.alert

显示一个警告框。

iOS 效果

Android 效果

WVUIDialog_alert_iOS@2x.png WVUIDialog_alert_Android@2x.png

输入参数

  • [string] message:警告框要显示的消息。

  • [string] okbutton:警告框的确认按钮文本。

  • [string] identifier:警告框的标识符。

监听事件

WV.Event.Alert 用户响应了警告框。

事件参数:

  • [string]identifier:警告框的标识符。

回调参数

无回调参数,如果成功显示警告框,则进入success回调,否则进入failure回调。

var params = {
        // 警告框要显示的消息
        message: 'Hello World!',
        // 警告框的确认按钮文本
        okbutton: '确定'
};
window.WindVane.call('WVUIDialog', 'alert', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.confirm

显示一个确认框。

iOS 效果

Android 效果

WVUIDialog_confirm_iOS@2x.png WVUIDialog_confirm_Android@2x.png

输入参数

  • [string] message:确认框要显示的消息。

  • [string] okbutton:确认框的确认按钮文本。

  • [string] canclebutton:确认框的取消按钮文本。

  • [int] _index:确认框的索引,用于唯一标识该确认框。

回调参数

无回调参数,如果成功显示警告框,则进入success回调,否则进入failure 回调。

监听事件

wv.dialog 用户响应了确认框。

事件参数:

  • [string]type:用户点击的按钮文本,可能是输入参数中的okbuttoncanclebutton

  • [int] _index:确认框的索引,输入参数中的_index相同。

document.addEventListener('wv.dialog', function(e) {
alert(JSON.stringify(e.param));
}, false);

var params = {
// 确认框要显示的消息
message: 'Are you really really sure?',
// 确认框的确认按钮文本
 okbutton: '确定',
// 确认框的取消按钮文本
canclebutton: '取消',
// 确认框的索引
_index: 10086
};
window.WindVane.call('WVUIDialog', 'confirm', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.enableAlertBeforeUnload

说明

该API只在Windvane Android 1.0.3.4以上版本有效。

开启小程序页面返回询问对话框,开启后当用户使用返回键尝试关闭小程序页面时,会弹出"是否确认离开"的对话框。

输入参数

  • [string] message:可选,对话框中显示的消息内容,如果不传入则默认内容是“离开此页面?”。

回调参数

成功回调参数:

  • 无参数。

失败回调参数:

  • [string] msg:错误消息。

var params = {
    // 对话框内容
    message: '确认离开此页面吗',
};

window.WindVane.call('WVUI', 'enableAlertBeforeUnload', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.disableAlertBeforeUnload

说明

该API只在Windvane Android 1.0.3.4以上版本有效。

关闭小程序页面返回询问对话框。

输入参数

  • 无输入参数。

回调参数

成功回调参数:

  • 无参数。

失败回调参数:

  • [string] msg:错误消息。

window.WindVane.call('WVUI', 'disableAlertBeforeUnload', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.prompt

说明

该API只在Windvane Android 1.0.3.4以上版本有效。

弹出一个对话框,让用户在对话框内输入文本。

输入参数

  • [string] title:可选,prompt对话框标题。

  • [string] message:prompt对话框提示文本。默认为"请输入内容"。

  • [string] hint:可选,输入框内的提示文案。

  • [string] okbutton:确认框的确认按钮文本。可选,默认是"确定"。

  • [string] cancelbutton:确认框的取消按钮文本。可选,默认是"取消"。

回调参数

成功回调参数:

  • [boolean] ok:点击ok返回true, 点击cancel返回false 。

  • [string] inputValue: 当ok返回true时,返回用户输入的内容。

失败回调参数:

  • [string] msg:错误消息。

var params = {
  	    title: '提示框'
        message: '请输入xxx内容',
  		  hint: '请输入xxx内容'
        okbutton: '确定',
  		  cancelbutton: '取消'
};
window.WindVane.call('WVUIDialog', 'prompt', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.showAuthGuide

说明

该API只在Windvane Android 1.0.3.4以上版本有效。

通过权限引导模块以图文形式向用户弹出对话,引导用户打开相应的权限。

输入参数

  • [string] permission: 权限文案,如"照相机"、"通讯录"等。

  • [string] okbutton:确认按钮的文案。

  • [string] jumpToSettings:点击okbutton后是否跳转至系统应用详情页面,"0"不跳转,"1"跳转,默认是"0",可选。

回调参数

成功回调参数:

  • 无参数。

失败回调参数:

  • [string] msg:错误消息。

var params = {
  	    permission: '通讯录'
  		  cancelbutton: '取消'
};
window.WindVane.call('WVUIDialog', 'showAuthGuide', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});