小程序开发之API界面交互- 技术文档

小程序开发之API界面交互

网友投稿 458 2024-07-09 11:18:20

交互

#showToast

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

showToast(Object object)

显示消息提示框。

参数

Object object

属性	类型	默认值	必填	说明
title	string		是	提示的内容
icon	string	'success'	否	图标
image	string		否	自定义图标的本地路径，image 的优先级高于 icon
duration	number	1500	否	提示的显示时长
mask	boolean	false	否	是否显示透明蒙层
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.icon 的合法值

值	说明
success	显示成功图标，此时 title 文本最多显示两行
loading	显示加载图标，此时 title 文本最多显示两行
error	显示失败图标，此时 title 文本最多显示两行
none	不显示图标，此时 title 文本最多可显示两行

示例代码

ft.showToast({
  title: '成功',
  icon: 'success',
  duration: 2000})
        已复制代码

注意

ft.showLoading 和 ft.showToast 同时只能显示一个
ft.showToast 应与 ft.hideToast 配对使用

#showModal

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

showModal(Object object)

显示模态对话框

参数

Object object

属性	类型	默认值	必填	说明
title	string		否	提示的标题
content	string		否	提示的内容
showCancel	boolean	true	否	是否显示取消按钮
cancelText	string	'取消'	否	取消按钮的文字
cancelColor	string	浅色主题#191919;深色主题#A5A5A5	否	取消按钮的文字颜色，必须是 16 进制的颜色字符串
confirmText	string	'确定'	否	确认按钮的文字
confirmColor	string	浅色主题#409EFF;深色主题#368CE4	否	确认按钮的文字颜色，必须是 16 进制的颜色字符串
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
confirm	boolean	为 true 时，表示用户点击了确定按钮
cancel	boolean	为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭）

示例代码

ft.showModal({
  title: '提示',
  content: '这是一个模态弹窗',
  success(res) {
    if (res.confirm) {
      console.log('用户点击确定')
    } else if (res.cancel) {
      console.log('用户点击取消')
    }
  }})
        已复制代码

#showLoading

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

showLoading(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
title	string		是	提示的内容
mask	boolean	false	否	是否显示透明蒙层
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

ft.showLoading({
  title: '加载中',})setTimeout(function () {
  ft.hideLoading()}, 2000)
        已复制代码

注意

ft.showLoading 和 ft.showToast 同时只能显示一个
ft.showLoading 应与 ft.hideLoading 配对使用

#showActionSheet

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

showActionSheet(Object object)

显示操作菜单

参数

Object object

属性	类型	默认值	必填	说明
itemList	Array.<string>		是	按钮的文字数组，数组长度最大为 6
itemColor	string	#000000	否	按钮的文字颜色
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
tapIndex	number	用户点击的按钮序号，从上到下的顺序，从0开始

示例代码

ft.showActionSheet({
  itemList: ['A', 'B', 'C'],
  success(res) {
    console.log(res.tapIndex)
  },
  fail(res) {
    console.log(res.errMsg)
  }})
        已复制代码

#hideToast

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

hideToast(Object object)

隐藏消息提示框。

参数

Object object

属性	类型	默认值	必填	说明
noConflict	boolean	false	否	目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

#hideLoading

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38

hideLoading(Object object)

隐藏 loading 提示框。

参数

Object object

属性	类型	默认值	必填	说明
noConflict	boolean	false	否	目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

#enableAlertBeforeUnload

基础库2.11.5开始支持，iOS版本2.35.1，Android版本2.35.1

enableAlertBeforeUnload(Object object)

开启小程序页面返回询问对话框

参数

Object object

属性	类型	必填	说明
message	string	是	接口调用成功的回调函数
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

#disableAlertBeforeUnload

基础库2.11.5开始支持，iOS版本2.35.1，Android版本2.35.1

disableAlertBeforeUnload(Object object)

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

参数

Object object

属性	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）