uni.showToast(options) @showtoast

展示全部

# uni.showToast(options)

显示消息提示框

# showToast 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowToastOptions

是

uni.showToast参数定义

名称

类型

必备

默认值

兼容性

描述

title

string

是

提示的内容，长度与 icon 取值有关。

icon

string

否

"success"

icon值说明

合法值

兼容性

描述

success

显示成功图标

error

显示错误图标

fail

显示错误图标，此时title文本无长度显示

exception

显示异常图标，此时title文本无长度显示

显示加载图标

none

不显示图标

image

string.ImageURIString

否

自定义图标的本地路径（app端暂不支持gif）

mask

boolean

否

false

是否显示透明蒙层，防止触摸穿透

duration

number

否

1500

提示的延迟时间，单位毫秒

position

string

否

position值说明。纯文本轻提示显示位置，填写有效值后只有 title 属性生效，且不支持通过 uni.hideToast 隐藏。

合法值

兼容性

描述

top

居上显示

center

居中显示

bottom

居底显示

success

(res: ShowToastSuccess) => void

否

uni.showToast成功回调函数定义

fail

(res: ShowToastFail) => void

否

uni.showToast失败回调函数定义

complete

(res: any) => void

否

uni.showToast完成回调函数定义

# ShowToastFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值

兼容性

描述

撤销

1001

请求参数非法

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# 参见

# 注意事项

App平台 position 参数特别说明

如果没有设置 position 字段，uni.showToast 会采用应用弹窗方案，即弹窗与页面生命周期绑定。页面关闭时，当前页面弹出的所有弹窗都会被自动取消。

如果设置了position 字段，uni.showToast 会采用系统弹窗方案，即弹窗与页面无绑定关系。页面关闭后，弹出中的/等待弹出的Toast会继续展示。

系统弹窗在部分系统（比如 MIUI,Google）可能会有应用图标前缀。

系统弹窗在部分系统（比如鸿蒙 4.0以上）可能不支持顶部和居中展示。

# uni.hideToast()

隐藏消息提示框。

# hideToast 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参见

# uni.showLoading(options)

显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。

# showLoading 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowLoadingOptions

是

uni.showLoading参数定义

名称

类型

必备

默认值

兼容性

描述

title

string

是

提示的内容，长度与 icon 取值有关。

mask

boolean

否

是否显示透明蒙层，防止触摸穿透，默认：false

success

(res: ShowLoadingSuccess) => void

否

uni.showLoading成功回调函数定义

fail

(res: ShowLoadingFail) => void

否

uni.showLoading失败回调函数定义

complete

(res: any) => void

否

uni.showLoading完成回调函数定义

# ShowLoadingFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

错误码

合法值

兼容性

描述

撤销

1001

请求参数非法

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# 参见

# uni.hideLoading()

隐藏 loading 提示框。

# hideLoading 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参见

# uni.showModal(options)

显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。

# showModal 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowModalOptions

是

名称

类型

必备

默认值

兼容性

描述

title

string

否

提示的标题

content

string

否

提示的内容

showCancel

boolean

否

true
是否显示取消按钮，默认为 true

cancelText

string

否

取消按钮的文字，默认为"取消"

cancelColor

string.ColorString

否

取消按钮的文字颜色，默认为"#000000"

confirmText

string

否

确定按钮的文字，默认为"确定"

confirmColor

string.ColorString

否

确定按钮的文字颜色

editable

boolean

否

false

是否显示输入框

placeholderText

string

否

显示输入框时的提示文本

success

(result: UniShowModalResult) => void

否

接口调用成功的回调函数

fail

(result: ShowModalFail) => void

否

接口调用失败的回调函数

complete

(result: any) => void

否

接口调用结束的回调函数（调用成功、失败都会执行）

# UniShowModalResult 的属性值

名称

类型

必备

默认值

兼容性

描述

content

string

否

editable 为 true 时，用户输入的文本

cancel

boolean

是

为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭）

confirm

boolean

是

为 true 时，表示用户点击了确定按钮

# ShowModalFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

# 返回值

类型	必备
UniPage	否

# 参见

# uni.showActionSheet(options)

从底部向上弹出操作菜单

# showActionSheet 兼容性

Web	微信小程序	Android	iOS	iOS uni-app x UTS 插件	HarmonyOS
4.0	4.41	3.91	4.11	4.11	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

ShowActionSheetOptions

是

uni.showActionSheet函数参数定义

名称

类型

必备

默认值

兼容性

描述

title

string

否

菜单标题

alertText

string

否

警示文案（仅微信小程序真机有效）

itemList

Array<string>

是

按钮的文字数组

itemColor

string.ColorString

否

按钮的文字颜色，字符串格式

popover

Popover

否

大屏设备弹出原生选择按钮框的指示区域，默认居中显示

名称

类型

必备

默认值

兼容性

描述

top

number

是

指示区域坐标，使用原生 navigationBar 时一般需要加上 navigationBar 的高度

left

number

是

指示区域坐标

width

number

是

指示区域宽度

height

number

是

指示区域高度

titleColor

string.ColorString

否

菜单标题文字颜色，字符串格式

cancelText

string

否

取消按钮的文字，默认为"取消"

cancelColor

string.ColorString

否

取消按钮的文字颜色，字符串格式

backgroundColor

string.ColorString

否

弹框背景颜色

success

(result: ShowActionSheetSuccess) => void

否

接口调用成功的回调函数

fail

(result: ShowActionSheetFail) => void

否

接口调用失败的回调函数

complete

(result: any) => void

否

接口调用结束的回调函数（调用成功、失败都会执行）

# ShowActionSheetSuccess 的属性值

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

tapIndex

number

是

# ShowActionSheetFail 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

showActionSheet 错误码
- 4: 框架内部异常

errSubject

string

是

统一错误主题（模块）名称

data

any

否

错误信息中包含的数据

cause

Error

否

源错误信息，可以包含多个错误，详见SourceError

errMsg

string

是

itemList，即actionsheet的列表项，在app和小程序上最多6项，超出会报错。在web上超出不报错，列表区变为可滚动。

# 参见

# 通用类型

# GeneralCallbackResult

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

错误信息

# Bug & Tips

目前web和App的弹窗UI风格不统一，后续会修复

运营产品

uni-ad uni统计 uni发行 uni安全专题

开发者服务

问答社区开发者后台

技术文档

uni-app文档 uniCloud文档原生开发者支持文档 HBuilder文档

生态服务

插件市场 OAuth用户开放平台

关于我们： DCloud官网案例需求墙许可协议加入我们赞助我们

联系我们：商务合作：bd@dcloud.io 广告合作：uniad@dcloud.io

DCloud.io 数字天堂（北京）网络技术有限公司是

HTML5中国产业联盟发起单位

京公网安备：11010802035340号

国家信息安全等级保护三级，证书编号：11010813802-20001