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

## chooseCropImage

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

> [PLATFORM] iOS, Android

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

### Description

Select images from the album or take photos with the camera (cropping supported)

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `sourceType` | `string[]` | No | `["album", "camera"]` | `2.2.4` | Sources for selecting images ['album', 'camera']; both supported by default |
| `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 |
| --- | --- | --- | --- |
| `path` | `string` | `3.2.6` | Local temporary file path of the cropped image |

#### 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 { chooseCropImage } from '@ray-js/ray'

// Select an image and crop (invokes the system picker; manual selection required)
chooseCropImage({
  sourceType: ["album", "camera"],
  success: data => console.log("Cropped path:", data.path),
  fail: error => console.error(error),
});
```