---
name: "showToast"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "showToast - 显示消息提示框"
---

## showToast

> [VERSION] BaseKit >= 2.0.1 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

显示消息提示框

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `title` | `string` | 是 | - | `2.0.1` | 提示的内容 |
| `icon` | `string` | 否 | `"success"` | `2.0.1` | 图标 'success' / 'error' / 'loading' / 'none' |
| `image` | `string` | 否 | - | `2.0.1` | 自定义图标的本地路径，image 的优先级高于 icon |
| `duration` | `number` | 否 | `1500` | `2.0.1` | 提示的延迟时间（仅iOS生效） |
| `mask` | `boolean` | 否 | `false` | `2.0.1` | 是否显示透明蒙层，防止触摸穿透 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### Demo

```tsx
import { showToast } from '@ray-js/ray'

// 显示消息提示框
showToast({
  title: "操作成功",
  icon: "success",
  duration: 1500,
  mask: false,
  success: () => console.log("toast 已显示"),
  fail: error => console.error(error),
});
```