interface.uts

/**
 * uni.showToast成功回调参数
 */
export type ShowToastSuccess = {
}

/**
 * uni.showToast成功回调函数定义
 */
export type ShowToastSuccessCallback = (res: ShowToastSuccess) => void
/**
 * uni.showToast失败回调函数定义
 */
export type ShowToastFailCallback = (res: UniError) => void
/**
 * uni.showToast完成回调函数定义
 */
export type ShowToastCompleteCallback = (res: any) => void

/**
 * uni.showToast参数定义
 */
export type ShowToastOptions = {
  /**
   * 提示的内容，长度与 icon 取值有关。
   */
  title: string,
  /**
   * 图标，有效值详见下方说明，默认：success。
   * @description icon值说明 success: 显示成功图标，error: 显示错误图标； fail: 显示错误图标，此时title文本无长度显示； exception: 显示异常图标，此时title文本无长度显示； loading: 显示加载图标；none: 不显示图标。
   */
  icon?: "success" | "error" | "fail" | "exception" | "loading" | "none" | null,
  /**
   * 自定义图标的本地路径（app端暂不支持gif）
   */
  image?: string.ImageURIString | null,
  /**
   * 是否显示透明蒙层，防止触摸穿透，默认：false
   */
  mask?: boolean | null,
  /**
   * 提示的延迟时间，单位毫秒，默认：1500
   */
  duration?: number | null,
  /**
   * 纯文本轻提示显示位置，填写有效值后只有 title 属性生效，且不支持通过 uni.hideToast 隐藏。
   * @description position值说明（仅App生效） top: 居上显示； center: 居中显示；bottom： 居底显示
   */
  position?: "top" | "center" | "bottom" | null,
  /**
   * 接口调用成功的回调函数
   */
  success?: ShowToastSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ShowToastFailCallback | null,
  /**
   * 接口调用结束的回调函数（调用成功、失败都会执行）
   */
  complete?: ShowToastCompleteCallback | null
}

/**
 * uni.showToast函数定义
 * 弹出toast  
 * 
 * @param {ShowToastOptions} options 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type ShowToast = (options: ShowToastOptions) => void

/**
 * uni.hideToast函数定义
 * 隐藏toast
 * 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#hidetoast
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type HideToast = () => void


/**
 * uni.showLoading成功回调参数
 */
export type ShowLoadingSuccess = {
}

/**
 * uni.showLoading成功回调函数定义
 */
export type ShowLoadingSuccessCallback = (res: ShowLoadingSuccess) => void
/**
 * uni.showLoading失败回调函数定义
 */
export type ShowLoadingFailCallback = (res: UniError) => void
/**
 * uni.showLoading完成回调函数定义
 */
export type ShowLoadingCompleteCallback = (res: any) => void

/**
 * uni.showLoading参数定义
 */
export type ShowLoadingOptions = {
  /**
   * 提示的内容，长度与 icon 取值有关。
   */
  title: string,
  /**
   * 是否显示透明蒙层，防止触摸穿透，默认：false
   */
  mask?: boolean | null,
  /**
   * 接口调用成功的回调函数
   */
  success?: ShowLoadingSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ShowLoadingFailCallback | null,
  /**
   * 接口调用结束的回调函数（调用成功、失败都会执行）
   */
  complete?: ShowLoadingCompleteCallback | null
}

/**
 * uni.showLoading函数定义
 * 弹出loading
 * 
 * @param {ShowLoadingOptions} options 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type ShowLoading = (options: ShowLoadingOptions) => void

/**
 * uni.hideLoading函数定义
 * 隐藏loading
 * 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#hideloading
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 * 
 */
export type HideLoading = () => void

/**
 * uni.showModal 成功回调参数
 */
export type ShowModalSuccess = {
  /**
   * 为 true 时，表示用户点击了确定按钮
   */
  confirm: boolean,
  /**
   * 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭）
   */
  cancel: boolean,
  /**
   * editable 为 true 时，用户输入的文本
   */
  content: string | null
}

/**
 * uni.showModal成功回调函数定义
 */
export type ShowModalSuccessCallback = (res: ShowModalSuccess) => void
/**
 * uni.showModal失败回调函数定义
 */
export type ShowModalFailCallback = (res: UniError) => void
/**
 * uni.showModal完成回调函数定义
 */
export type ShowModalCompleteCallback = (res: any) => void
/**
 * uni.showModal 参数定义
 */
export type ShowModalOptions = {
  /**
   * 提示的标题
   */
  title?: string | null,
  /**
   * 提示的内容
   */
  content?: string | null,
  /**
   * @default true
   * 是否显示取消按钮，默认为 true
   */
  showCancel?: boolean | null,
  /**
   * 取消按钮的文字，默认为"取消"
   */
  cancelText?: string | null,
  /**
   * 取消按钮的文字颜色，默认为"#000000"
   */
  cancelColor?: string.ColorString | null,
  /**
   * 确定按钮的文字，默认为"确定"
   */
  confirmText?: string | null,
  /**
   * 确定按钮的文字颜色
   */
  confirmColor?: string.ColorString | null,
  /**
   * @default false
   * 是否显示输入框
   */
  editable?: boolean | null,
  /**
   * 显示输入框时的提示文本
   */
  placeholderText?: string | null,
  /**
   * 接口调用成功的回调函数
   */
  success?: ShowModalSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ShowModalFailCallback | null,
  /**
   * 接口调用结束的回调函数（调用成功、失败都会执行）
   */
  complete?: ShowModalCompleteCallback | null
}

/**
 * uni.showModal 函数定义
 * 
 * 弹出modal
 * 
 * @param {ShowModalOptions} options 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
 *    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type ShowModal = (options: ShowModalOptions) => void

/**
 * uni.ShowActionSheet成功回调参数
 */
export type ShowActionSheetSuccess = {
  /**
   * 用户点击的按钮，从上到下的顺序，从0开始
   */
  tapIndex: number | null,
}

export type Popover = {
  /**
   * 指示区域坐标，使用原生 navigationBar 时一般需要加上 navigationBar 的高度
   */
  top: number,
  /**
   * 指示区域坐标
   */
  left: number,
  /**
   * 指示区域宽度
   */
  width: number,
  /**
   * 指示区域高度
   */
  height: number
}

/**
 * uni.showActionSheet成功回调函数定义
 */
export type ShowActionSheetSuccessCallback = (res: ShowActionSheetSuccess) => void
/**
 * uni.showActionSheet成功回调函数定义
 */
export type ShowActionSheetFailCallback = (res: UniError) => void
/**
 * uni.showActionSheet成功回调函数定义
 */
export type ShowActionSheetCompleteCallback = (res: any) => void

/**
 * uni.showActionSheet函数参数定义
 */
export type ShowActionSheetOptions = {
  /**
   * 菜单标题
   */
  title?: string | null,
  /**
   * 警示文案（同菜单标题, app无效）
   */
  alertText?: string | null,
  /**
   * 按钮的文字数组
   */
  itemList: string[],
  /**
   * 按钮的文字颜色，字符串格式（iOS默认为系统控件颜色）
   */
  itemColor?: string.ColorString | null,
  /**
   * 大屏设备弹出原生选择按钮框的指示区域，默认居中显示
   */
  popover?: Popover | null,
  /**
   * 接口调用成功的回调函数
   */
  success?: ShowActionSheetSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   */
  fail?: ShowActionSheetFailCallback | null,
  /**
   * 接口调用结束的回调函数（调用成功、失败都会执行）
   */
  complete?: ShowActionSheetCompleteCallback | null
}

/**
 * uni.showActionSheet函数定义
 * 
 * 弹出actionSheet
 * 
 * @param {ShowActionSheetOptions} options 
 * @tutorial https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet
 * @uniPlatform {
 *    "app": {
 *        "android": {
 *            "osVer": "5.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *        },
 *        "ios": {
 *            "osVer": "9.0",
 *            "uniVer": "√",
 *            "unixVer": "3.9.0"
 *   	  }
 *    },
*    "web": {
 *        "uniVer": "√",
 *        "unixVer": "4.0"
 *    }
 * }
 */
export type ShowActionSheet = (options: ShowActionSheetOptions) => void


export interface Uni {
  /**
   * @description 显示消息提示框
   * @param {ShowToastOptions} option
   * @example
   * ```typescript
   *    uni.showToast({
   *        title: '标题',
   *        duration: 2000
   *    });
   * ```
   * @remark
   * - showLoading 和 showToast 同时只能显示一个
   * - showToast 应与 hideToast 配对使用
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  showToast(options: ShowToastOptions): void,
  /**
   * @description 隐藏消息提示框。
   * @example
   * ```typescript
   *    uni.hideToast();
   * ```
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#hidetoast)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  hideToast(): void,
  /**
   * @description 显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。
   * @param {ShowLoadingOptions} option
   * @example
   * ```typescript
   *	uni.showLoading({
   *		title: '加载中'
   *	});
   * ```
   * @remark
   * - showLoading 和 showToast 同时只能显示一个
   * - showToast 应与 hideToast 配对使用
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  showLoading(options: ShowLoadingOptions): void,
  /**
   * @description 隐藏 loading 提示框。
   * @example
   * ```typescript
   *	uni.showLoading({
   *		title: '加载中'
   *	});
   *
   *	setTimeout(function () {
   *		uni.hideLoading();
   *	}, 2000);
   *
   * ```
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#hideloading)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  hideLoading():void,
  /**
   * @description 显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。
   * @param {ShowModalOptions} option
   * @example
   * ```typescript
   *	uni.showModal({
   *		title: '提示',
   *		content: '这是一个模态弹窗',
   *		success: function (res) {
   *			if (res.confirm) {
   *				console.log('用户点击确定');
   *			} else if (res.cancel) {
   *				console.log('用户点击取消');
   *			}
   *		}
   *	});
     *
   *
   * ```
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  showModal(options: ShowModalOptions) :  void,
  /**
   * @description 从底部向上弹出操作菜单
   * @param {ShowActionSheetOptions} option
   * @example
   * ```typescript
   *	uni.showActionSheet({
   *		itemList: ['A', 'B', 'C'],
   *		success: function (res) {
   *			console.log('选中了第' + (res.tapIndex + 1) + '个按钮');
   *		},
   *		fail: function (res) {
   *			console.log(res.errMsg);
   *		}
   *	});
   * ```
   * @tutorial [](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showactionsheet)
   * @uniPlatform {
   *    "app": {
   *        "android": {
   *            "osVer": "5.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        },
   *        "ios": {
   *            "osVer": "9.0",
   *            "uniVer": "√",
   *            "unixVer": "3.9.0"
   *        }
   *    },
   *    "web": {
   *        "uniVer": "√",
   *        "unixVer": "4.0"
   *    }
   * }
   */
  showActionSheet(options: ShowActionSheetOptions) : void
}