方法:
对象:
回调方法:
权限:
5+功能模块(permissions)
actionSheet
弹出系统选择按钮框
说明:
从底部动画弹出系统样式选择按钮框,可设置选择框的标题、按钮文字等。 弹出的提示框为非阻塞模式,用户点击选择框上的按钮后关闭,并通过actionsheetCallback回调函数通知用户选择的按钮。
参数:
返回值:
NativeUIObj : 系统原生界面基类对象
示例:
uni-app使用plus注意事项
alert
弹出系统提示对话框
说明:
创建并显示系统样式提示对话框,可设置提示对话框的标题、内容、按钮文字等。 弹出的提示对话框为非阻塞模式,用户点击提示对话框上的按钮后关闭,并通过alertCB回调函数通知对话框已关闭。
参数:
- message: ( String ) 必选 提示对话框上显示的内容
- alertCB: ( AlertCallback ) 可选 提示对话框上关闭后的回调函数
- title: ( String ) 可选 提示对话框上显示的标题
- buttonCapture: ( String ) 必选 提示对话框上按钮显示的内容
返回值:
void : 无
示例:
uni-app使用plus注意事项
confirm
弹出系统确认对话框
说明:
创建并显示系统样式确认对话框,可设置确认对话框的标题、内容、按钮数目及其文字。 弹出的确认对话框为非阻塞模式,用户点击确认对话框上的按钮后关闭,并通过confirmCB回调函数通知用户点击的按钮索引值。
参数:
- message: ( String ) 必选 确认对话框上显示的内容
- confirmCB: ( ConfirmCallback ) 可选 确认对话框关闭后的回调函数
回调函数中包括Event参数,可通过其index属性(Number类型)获取用户点击按钮的索引值。
- styles: ( ConfirmStyles | String ) 可选 确认对话框的参数/对话框的标题
类型为JSON Object(ConfirmStyles)时,表示设置确认对话框的参数; 类型为String时,表示设置确认对话框的标题(不推荐使用)。
- buttons: ( Array[String] ) 可选 确认对话框上显示的按钮(不推荐使用)
字符串数组,每项对应在确认对话框上显示一个按钮,用户点击后通过confirmCB返回用户点击按钮的在数组中的索引值。 不推荐使用,建议使用styles参数中的buttons属性。
返回值:
void : 无
平台支持:
示例:
uni-app使用plus注意事项
closePreviewImage
关闭预览图片界面
说明:
关闭已经显示的所有预览图片界面。
HBuilderX3.2.13+版本支持。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
closeWaiting
关闭系统等待对话框
说明:
关闭已经显示的所有系统样式等待对话框,触发Waiting对象的onclose事件。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
closeToast
关闭自动消失的提示消息
说明:
关闭已经显示的所有自动消失的提示框。
参数:
无
返回值:
void : 无
平台支持:
示例:
uni-app使用plus注意事项
previewImage
预览图片
说明:
创建并显示全屏图片预览界面,用户点击图片或返回键退出预览界面。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
showWaiting
显示系统等待对话框
说明:
创建并显示系统样式等待对话框,并返回等待对话框对象Waiting,显示后需调用其close方法进行关闭。
参数:
- title: ( String ) 可选 等待对话框上显示的提示标题内容
- styles: ( WaitingStyles ) 可选 等待对话框的显示参数
可设置等待对话框的宽、高、边距、背景等样式。
返回值:
Waiting : Waiting对象
示例:
uni-app使用plus注意事项
pickDate
弹出系统日期选择对话框
说明:
创建并显示系统样式日期选择对话框,可进行日期的选择。 用户操作确认后通过successCB回调函数返回用户选择的日期,若用户取消选择则通过errorCB回调。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
pickTime
弹出系统时间选择对话框
说明:
创建并弹出系统样式时间选择对话框,可进行时间的选择。 用户操作确认后通过successCB回调函数返回用户选择的时间,若用户取消选择则通过errorCB回调。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
prompt
弹出系统输入对话框
说明:
创建并显示系统样式输入对话框,可设置输入对话框的标题、内容、提示输入信息、按钮数目及其文字。 弹出的输入对话框为非阻塞模式,其中包含编辑框供用户输入内容,用户点击输入对话框上的按钮后自动关闭,并通过promptCB回调函数返回用户点击的按钮及输入的内容。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
toast
显示自动消失的提示消息
说明:
创建并显示系统样式提示消息,弹出的提示消息为非阻塞模式,显示指定时间后自动消失。 提示消息显示时间可通过styles的duration属性控制,长时间提示消息显示时间约为3.5s,短时间提示消息显示时间约为2s。
参数:
- message: ( String ) 必选 提示消息上显示的文字内容
- styles: ( ToastStyles ) 可选 提示消息的样式
可设置提示消息显示的图标、持续时间、位置等。
返回值:
void : 无
示例:
uni-app使用plus注意事项
setUIStyle
设置原生界面样式(暗黑模式)
说明:
iOS13+系统支持暗黑模式,可设置原生界面的外观样式为浅色或深色(暗黑模式)。 即使应用没有设置"全局开启暗黑模式",也可以调用此方法强制设置原生界面外观样式。 HBuilderX2.6.3+版本支持,并且要求iOS13及以上系统。
参数:
- style: ( String ) 必选 原生界面样式
可取值:
返回值:
void : 无
平台支持:
示例:
uni-app使用plus注意事项
ActionButtonStyles
原生选择按钮框上按钮的样式
属性:
- color: (String 类型 )按钮上的文字颜色
可取值: "#RRGGBB"格式字符串,如"#FF0000"表示文字颜色为红色; "rgba(R,G,B,A)",其中R/G/B分别代表红色值/绿色值/蓝色值,正整数类型,取值范围为0-255,A为透明度,浮点数类型,取值范围为0-1(0为全透明,1为不透明),如"rgba(255,0,0,0.5)",表示红色半透明。
平台支持
- title: (String 类型 )按钮上的文字内容
- style: (String 类型 )按钮的样式
可取值: "destructive" - 表示警示按钮样式,默认文字颜色为红色; "default" - 表示默认按钮样式。 默认值为"default"。
平台支持
示例:
uni-app使用plus注意事项
ActionSheetStyles
原生选择按钮框的样式
属性:
示例:
uni-app使用plus注意事项
ConfirmStyles
确认对话框的样式
属性:
示例:
uni-app使用plus注意事项
PreviewImageStyles
图片预览的样式
属性:
- background: (String 类型 )图片预览的背景颜色
颜色值格式为"#RRGGBB",如"#FF0000"表示为红色背景。 默认值为黑色("#000000")。
- current: (Number 类型 )默认显示图片的索引值
索引值从0开始,默认值为0。
- indicator: (String 类型 )图片指示器样式
可取值: "default" - 默认指示器(底部圆点样式); "number" - 顶部数字指示器(顶部居中显示,文字为%当前图片索引值(从1开始)%/%图片总数%); "none" - 不显示指示器。 默认值为"default"。
- loop: (Boolean 类型 )是否可循环预览
可取值: "true" - 支持循环预览; "false" - 不支持循环预览。 默认值为"false"。
- onLongPress: (PreviewImageLongPressCallback 类型 )长按事件
用户在图片预览界面长按时触发。 在回调中返回长按图片的信息(索引值、地址等)。 由于图片预览界面是层级非常高的窗口,此时只能调用plus.nativeUI.*显示的窗口覆盖在图片预览界面上(原生控件plus.nativeObj.View也无法显示)。 注意:HBuilderX1.9.5及以上版本支持。
示例:
uni-app使用plus注意事项
PickDateStyles
日期选择对话框的样式
属性:
- title: (String 类型 )日期选择对话框显示的标题
如果未设置,则不显示标题。
- date: (Date 类型 )日期选择对话框默认显示的日期
如果未设置,则显示当前的日期。
- minDate: (Date 类型 )日期选择对话框可选择的最小日期
Date类型对象,如果未设置可选择的最小日期,则使用系统默认可选择的最小日期值。
- maxDate: (Date 类型 )日期选择对话框可选择的最大日期
Date类型对象,如果未设置可选择的最大日期,则使用系统默认可选择的最大日期值。 其值必须大于minDate设置的值,否则使用系统默认可选择的最大日期值。
- popover: (JSON 类型 )时间选择对话框弹出指示区域
JSON类型对象,格式如{top:10;left:10;width:200;height:200;},所有值为像素值,其值为相对于容器Webview的位置。 如未设置此值,默认在屏幕居中显示。仅在iPad上有效,其它设备忽略此值。
示例:
uni-app使用plus注意事项
PickTimeStyles
时间选择对话框的样式
属性:
示例:
uni-app使用plus注意事项
NativeUIObj
系统原生界面基类对象
方法:
close
关闭显示的系统原生界面
说明:
调用plus.nativeUI.actionSheet方法创建并显示系统界面后,可通过其close方法将原生界面关闭。 此情况下触发界面关闭回调函数参数的index属性值为-1。 注意:一个系统原生界面只能关闭一次,多次调用将无任何作用。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
WaitingObj
系统等待对话框对象
说明:
从NativeUIObj对象继承而来,通过plus.nativeUI.showWaiting方法创建时返回。 用于控制系统样式等待对话框的操作,如关闭、设置标题内容等。
方法:
事件:
setTitle
设置等待对话框上显示的文字内容
参数:
- title: ( String ) 必选 要设置的文本信息
返回值:
void : 无
示例:
uni-app使用plus注意事项
close
关闭显示的系统等待对话框
说明:
调用plus.nativeUI.showWaiting方法创建并显示系统等待界后,可通过其close方法将原生等待控件关闭。 一个系统等待对话框只能关闭一次,多次调用将无任何作用。
参数:
无
返回值:
void : 无
示例:
uni-app使用plus注意事项
onclose
等待对话框关闭事件
说明:
SuccessCallback 类型
等待框关闭时触发,当调用close方法或用户点击返回按钮导致等待框关闭时触发。
示例:
uni-app使用plus注意事项
WaitingStyles
原生等待对话框的样式
属性:
- width: (String 类型 )等待框背景区域的宽度
值支持像素值("500px")或百分比("50%"),百分比相对于屏幕的宽计算,如果不设置则根据内容自动计算合适的宽度。
- height: (String 类型 )等待框背景区域的高度
值支持像素绝对值("500px")或百分比("50%"),如果不设置则根据内容自动计算合适的高度。
- color: (String 类型 )等待框中文字的颜色
颜色值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为白色。
- size: (String 类型 )等待框中文字的字体大小
如"14px"表示使用14像素高的文字,未设置则使用系统默认字体大小。
- textalign: (String 类型 )等待对话框中标题文字的水平对齐方式
对齐方式可选值包括:"left":水平居左对齐显示,"center":水平居中对齐显示,"right":水平居右对齐显示。默认值为水平居中对齐显示,即"center"。
- padding: (String 类型 )等待对话框的内边距
值支持像素值("10px")和百分比("5%"),百分比相对于屏幕的宽计算,默认值为"3%"。
- background: (String 类型 )等待对话框显示区域的背景色
背景色的值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值,默认值为rgba(0,0,0,0.7)。
- style: (String 类型 )等待对话框样式
可取值"black"、"white",black表示等待框为黑色雪花样式,通常在背景主色为浅色时使用;white表示等待框为白色雪花样式,通常在背景主色为深色时使用。 仅在iOS平台有效,其它平台忽略此值,未设置时默认值为white。
- modal: (Boolen 类型 )等待框是否模态显示
模态显示时用户不可操作直到等待对话框关闭,否则用户在等待对话框显示时也可操作下面的内容,未设置时默认为true。
- round: (Number 类型 )等待框显示区域的圆角
值支持像素值("10px"),未设置时使用默认值"10px"。
- padlock: (Boolen 类型 )点击等待显示区域是否自动关闭
true表示点击等待对话框显示区域时自动关闭,false则不关闭,未设置时默认值为false。
- back: (String 类型 )返回键处理方式
可取值"none"表示截获处理返回键,但不做任何响应;"close"表示截获处理返回键并关闭等待框;"transmit"表示不截获返回键,向后传递给Webview窗口继续处理(与未显示等待框的情况一致)。
平台支持
- Android - 2.3+ (支持)
- iOS - ALL (不支持) :
iOS设备无返回键,忽略此属性。
- loading: (WaitingLoadingStyles 类型 )自定义等待框上loading图标样式
WaitingLoadingStyles
JSON对象,原生等待对话框上loading图标自定义样式
属性:
- display: (String 类型 )loading图标显示样式
可取值: "block"表示图标与文字分开两行显示,上面显示loading图标,下面显示文字; "inline"表示loading图标与文字在同一行显示,左边显示loading图标,右边显示文字; "none"表示不显示loading图标;
- height: (String 类型 )loading图标高度
设置loading图标的高度(宽度等比率缩放),取值类型:像素值,如"14px"表示14像素高。
平台支持
- icon: (String 类型 )loading图标路径
自定义loading图标的路径,png格式,并且必须是本地资源地址; loading图要求宽是高的整数倍,显示等待框时按照图片的高横向截取每帧刷新。
- interval: (Number 类型 )loading图每帧刷新间隔
单位为ms(毫秒),默认值为100ms。
- type: (String 类型 )loading图标类型
如果设置了icon属性,则优先使用icon自定义图标。 可取值: "circle" - 圆圈类型loading图标; "snow" - 雪花类型loading图标。 默认值为"circle"。
平台支持
ToastStyles
系统提示消息框的样式
属性:
- align: (String 类型 )提示消息框在屏幕中的水平位置
可选值为"left"、"center"、"right",分别为水平居左、居中、居右,未设置时默认值为"center"。
- background: (String 类型 )提示消息框的背景色
背景色的值支持(参考CSS颜色规范):颜色名称(参考CSS Color Names)/十六进制值/rgb值/rgba值。
平台支持
- Android - ALL (支持) :
默认为系统toast的背景颜色。
- iOS - ALL (支持) :
默认值为rgba(0,0,0,0.7)。
- duration: (String 类型 )提示消息框显示的时间
可选值为"long"、"short",值为"long"时显示时间约为3.5s,值为"short"时显示时间约为2s,未设置时默认值为"short"。
- icon: (String 类型 )提示消息框上显示的图标
仅支持本地图片路径。
- iconWidth: (String 类型 )图标的宽度
单位为px(逻辑像素值),默认值为图片的宽度。
- iconHeight: (String 类型 )图标的高度
单位为px(逻辑像素值),默认值为图片的高度。
- style: (String 类型 )提示消息框上显示的样式
可取值: "block" - 表示图标与文字分两行显示,上面显示图标,下面显示文字; "inline" - 表示图标与文字在同一行显示,左边显示图标,右边显示文字。 默认值为"block"。
- type: (String 类型 )提示消息框上显示的文本类型
可取值: "text" - 显示的消息内容为文本字符串; "richtext" - 显示的消息内容为富文本内容。 默认值为"text"。 当type为"text"时,富文本使用html的部分标签,具体标签如下: 图片标签
; 字体标签,内容在一行显示不下时自动换行,行高默认为字体的1.2倍; 换行标签
; 链接标签链接地址。 如示例“
链接地址”。
- richTextStyle: (plus.nativeObj.RichTextStyles 类型 )富文本样式
当type属性值为"richtext"时有效,用于定义富文本的样式,如其文本对齐方式、使用的字体等。
- verticalAlign: (String 类型 )提示消息在屏幕中的垂直位置
可选值为"top"、"center"、"bottom",分别为垂直居顶、居中、居底,未设置时默认值为"bottom"。
示例:
uni-app使用plus注意事项
ActionSheetCallback
系统选择按钮框的回调函数
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
AlertCallback
系统提示框确认的回调函数
参数:
返回值:
void : 无
平台支持:
ConfirmCallback
关闭确认对话框的回调函数
参数:
返回值:
void : 无
平台支持:
PromptCallback
系统输入对话框关闭后的回调函数
参数:
返回值:
void : 无
平台支持:
PickDatetimeSuccessCallback
选择日期或时间操作成功的回调函数
参数:
返回值:
void : 无
PickDatetimeErrorCallback
选择日期或时间操作取消或失败的回调函数
参数:
返回值:
void : 无
PreviewImageLongPressCallback
图片预览长按事件
说明:
在图片预览界面长按时触发。
参数:
返回值:
void : 无
SuccessCallback
操作成功回调函数
说明:
操作成功后触发回调函数。
参数:
无
返回值:
void : 无