---
name: "showActionSheet"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## showActionSheet

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

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Show an action sheet

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `alertText` | `string` | No | - | `2.0.1` | Warning text |
| `itemList` | `string[]` | Yes | - | `2.0.1` | Array of button texts, up to 6 items |
| `itemColor` | `string` | Yes | - | `2.0.1` | Button text color |
| `itemColors` | `string[]` | No | - | `3.6.8` | Button text color |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `tapIndex` | `number` | `3.2.6` | Index of the button the user tapped, ordered top to bottom, starting from 0 |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

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

// Show an action sheet; the callback returns the button index tapIndex
showActionSheet({
  alertText: "Please select an action",
  itemList: ["Option 1", "Option 2", "Option 3"],
  itemColor: "#000000",
  success: data => console.log("Tapped index:", data.tapIndex),
  fail: error => console.error(error),
});
```