FinClip为企业提供小程序生态圈技术产品,开发者可在FinClip小程序开发帮助中心找到相关FinClip小程序指引

# 界面

# 交互

# showToast

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 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 SDK 2.1.23 起,Android SDK 2.1.38 起支持

showModal(Object object)

显示模态对话框

参数

Object object

属性 类型 默认值 必填 说明
title string 是 提示的标题
content string 是 提示的内容
showCancel boolean true 否 是否显示取消按钮
cancelText string '取消' 否 取消按钮的文字
cancelColor string #000000 否 取消按钮的文字颜色,必须是 16 进制的颜色字符串
confirmText string '确定' 否 确认按钮的文字
confirmColor string #576B95 否 确认按钮的文字颜色,必须是 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 SDK 2.1.23 起,Android SDK 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 SDK 2.1.23 起,Android SDK 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 SDK 2.1.23 起,Android SDK 2.1.38 起支持

hideToast(Object object)

隐藏消息提示框。

参数

Object object

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

# hideLoading

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

hideLoading(Object object)

隐藏 loading 提示框。

参数

Object object

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

# 导航栏

# showNavigationBarLoading

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

showNavigationBarLoading(Object object)

在当前页面显示导航条加载动画。

参数

Object object

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

# setNavigationBarTitle

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

setNavigationBarTitle(Object object)

动态设置当前页面的标题。

参数

Object object

属性 类型 默认值 必填 说明
title string 是 页面标题
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

ft.setNavigationBarTitle({
  title: '页面标题'
})

# setNavigationBarColor

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

setNavigationBarColor(Object object)

设置页面导航条颜色。

参数

Object object

属性 类型 默认值 必填 说明
frontColor string 是 前景颜色值,包括按钮、标题、状态栏的颜色,仅支持 #ffffff 和 #000000
backgroundColor string 是 背景颜色值,有效值为十六进制颜色
animation Object 是 动画效果
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数(调用成功、失败都会执行)

object.animation 的结构

属性 类型 默认值 必填 说明
duration number 0 否 动画变化时间,单位 ms
timingFunc string 'linear' 否 动画变化方式

object.animation.timingFunc 的合法值

值 说明
'linear' 动画从头到尾的速度是相同的
'easeIn' 动画以低速开始
'easeOut' 动画以低速结束
'easeInOut' 动画以低速开始和结束

示例代码

ft.setNavigationBarColor({
  frontColor: '#ffffff',
  backgroundColor: '#ff0000',
  animation: {
    duration: 400,
    timingFunc: 'easeIn'
  }
})

# hideNavigationBarLoading

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

hideNavigationBarLoading(Object object)

在当前页面隐藏导航条加载动画。

参数

Object object

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

# hideHomeButton

ft.hideHomeButton(Object object)

隐藏返回首页按钮。

参数

Object object

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

# 菜单

# getMenuButtonBoundingClientRect

基础库 1.3.9 起,iOS SDK 2.1.23 起,Android SDK 2.1.38 起支持

获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点。

属性 类型 说明
width number 宽度,单位:px
height number 高度,单位:px
top number 上边界坐标,单位:px
right number 右边界坐标,单位:px
bottom number 下边界坐标,单位:px
left number 左边界坐标,单位:px