小程序API能力集成指南——界面交互API汇总

news/2024/7/20 4:31:48 标签: 小程序, javascript, 前端, iot, 开发语言, App, API

ty.showModal

显示模态对话框

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
titlestring提示的标题
contentstring提示的内容
showCancelboolean是否显示取消按钮
cancelTextstring取消按钮的文字,最多 4 个字符
cancelColorstring取消按钮的文字颜色,必须是 16 进制格式的颜色字符串
confirmTextstring确认按钮的文字,最多 4 个字符
confirmColorstring确认按钮的文字颜色,必须是 16 进制格式的颜色字符串
completefunction接口调用完成的回调函数(成功或失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
confirmboolean为 true 时,表示用户点击了确定按钮
cancelboolean为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭)

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 显示模态对话框
 */
export function showModal(params: {
  /** 提示的标题 */
  title: string;
  /** 提示的内容 */
  content?: string;
  /** 是否显示取消按钮 */
  showCancel?: boolean;
  /** 取消按钮的文字,最多 4 个字符 */
  cancelText?: string;
  /** 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
  cancelColor?: string;
  /** 确认按钮的文字,最多 4 个字符 */
  confirmText?: string;
  /** 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
  confirmColor?: string;
  complete?: () => void;
  success?: (params: {
    /** 为 true 时,表示用户点击了确定按钮 */
    confirm: boolean;
    /** 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
    cancel: boolean;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

常见问题(FAQ)

如何自定义对话框内容?

可以尝试扩展组件中的 Dialog 组件。

 

ty.showActionSheet

显示操作菜单

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
alertTextstring警示文案
itemListarray按钮的文字数组,数组长度最大为 6
itemColorstring按钮的文字颜色
completefunction接口调用完成的回调函数(成功或失败都会调用)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

object.success 回调参数

参数

Object res

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

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 显示操作菜单
 */
export function showActionSheet(params: {
  /** 警示文案 */
  alertText?: string;
  /** 按钮的文字数组,数组长度最大为 6 */
  itemList: string[];
  /** 按钮的文字颜色 */
  itemColor?: string;
  complete?: () => void;
  success?: (params: {
    /** 用户点击的按钮序号,从上到下的顺序,从0开始 */
    tapIndex: number;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.showLoading

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

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
titlestring提示的内容
maskboolean是否显示透明蒙层,防止触摸穿透
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

函数定义示例

/**
 * 显示 loading 提示框。需主动调用 ty.hideLoading 才能关闭提示框
 */
export function showLoading(params: {
  /** 提示的内容 */
  title: string;
  /** 是否显示透明蒙层,防止触摸穿透 */
  mask?: boolean;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.hideLoading

隐藏 loading 提示框

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

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

函数定义示例

/**
 * 隐藏 loading 提示框
 */
export function hideLoading(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.showToast

显示消息提示框

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
titlestring提示的内容
iconstring图标 'success' / 'error' / 'loading' / 'none'
imagestring自定义图标的本地路径,image 的优先级高于 icon
durationnumber提示的延迟时间
maskboolean是否显示透明蒙层,防止触摸穿透
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

函数定义示例

/**
 * 显示消息提示框
 */
export function showToast(params: {
  /** 提示的内容 */
  title: string;
  /** 图标 'success' / 'error' / 'loading' / 'none' */
  icon?: string;
  /** 自定义图标的本地路径,image 的优先级高于 icon */
  image?: string;
  /** 提示的延迟时间 */
  duration?: number;
  /** 是否显示透明蒙层,防止触摸穿透 */
  mask?: boolean;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.hideToast

隐藏消息提示框

需引入BaseKit,且在>=1.2.10版本才可使用

参数

Object object

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

函数定义示例

/**
 * 隐藏消息提示框
 */
export function hideToast(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发。


http://www.niftyadmin.cn/n/5384336.html

相关文章

PROBIS铂思金融破产后续:ASIC牌照已注销

2024年1月31日,PROBIS铂思金融的澳大利亚ASIC牌照 (AFSL 338241) 被注销《差价合约经纪商PROBIS宣布破产,澳大利亚金融服务牌照遭暂停》,这也就意味着,PROBIS铂思金融目前已经没有任何金融牌照。 值得注意的是,时至今日…

深究 DevOps 与平台工程的区别

今天,我们将讨论平台工程和 DevOps 的关系。尽管这两个概念有一些共同点,但它们仍然是截然不同的,我们将具体了解它们之间的区别。本文旨在解释当代软件工程中的这两个基本概念。通过实际案例,我们将分别说明这两个方法如何塑造了…

Hive数据仓库行转列

查了很多资料发现网上很多文章都是转发和抄袭,有些问题。这里分享一个自己项目中使用的行转列例子,供大家参考。代码如下: SELECTmy_id,nm_cd_map[A] AS my_cd_a,nm_cd_map[B] AS my_cd_b,nm_cd_map[C] AS my_cd_c,nm_num_map[A] AS my_num_…

SDK 移植及BSP工程管理

NXP 官方为 I.MX6ULL 编写了 SDK 包,在 SDK 包里面 NXP 已经编写好了寄存器定义文件, 所以我们可以直接移植 SDK 包里面的文件来用 1 I.MX6ULL 官方 SDK 包简介 NXP 针对 I.MX6ULL 编写了一个 SDK 包,这个 SDK 包就类…

C# OpenCvSharp DNN Image Retouching

目录 介绍 模型 项目 效果 代码 下载 C# OpenCvSharp DNN Image Retouching 介绍 github地址:https://github.com/hejingwenhejingwen/CSRNet (ECCV 2020) Conditional Sequential Modulation for Efficient Global Image Retouching 模型 Model Properti…

认识TypeScript 中的接口和类

🎬 江城开朗的豌豆:个人主页 🔥 个人专栏 :《 VUE 》 《 javaScript 》 📝 个人网站 :《 江城开朗的豌豆🫛 》 ⛺️ 生活的理想,就是为了理想的生活 ! 目录 接口 类 江城开朗的豌豆 在 TypeScript 中&…

Android 面试问题 2024 版(其一)

Android 面试问题 2024 版(其一) 一、Java 和 Kotlin二、安卓组件三、用户界面 (UI) 开发四、安卓应用架构五、网络和数据持久性 一、Java 和 Kotlin Java 中的抽象类和接口有什么区别? 答:抽象类是不能实例化的类,它…

【Linux】安装ffmpeg

前言 安装ffmpeg,需要先安装依赖: SDL2、yasm、x264、freetype 安装SDL2 yum install SDL2安装yasm yum install yasm #wget http://www.tortall.net/projects/yasm/releases/yasm-1.3.0.tar.gz #tar -zxvf yasm-1.3.0.tar.gz #cd yasm-1.3.0 #./configure #mak…