---
name: "chooseImage"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "chooseImage - 从本地相册选择图片或使用相机拍照, 可用 chooseMedia 替代此方法"
---

## chooseImage

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

> [PLATFORM] iOS, Android

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

### 描述

从本地相册选择图片或使用相机拍照, 可用chooseMedia替代此方法 权限：[scope.camera, scope.writePhotosAlbum] 关联API：[chooseMedia]

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `count` | `number` | 否 | `9` | `2.0.1` | 最多可以选择的图片张数 注意：Android13以上的版本，使用的是系统图片选择器，该字段不生效 |
| `imageType` | `string` | 否 | - | `3.35.7` | 筛选图片类型；可传 'gif' 仅展示 GIF，传 'image' 展示非 GIF 静态图片，未传或为空默认不过滤 |
| `sizeType` | `string[]` | 否 | - | `2.0.1` | 图片尺寸类型；可传 'original' 原图、'compressed' 压缩图 |
| `sourceType` | `string[]` | 否 | - | `2.0.1` | 选择图片的来源 ['album', 'camera'] |
| `disableDismissAnimationAfterSelect` | `boolean` | 否 | - | `3.11.3` | 是否取消选择图片后关闭界面的动画效果 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `tempFilePaths` | `string[]` | `3.2.6` | 图片的本地临时文件路径列表 (本地路径) |
| `tempFiles` | `TempFileCB[]` | `3.2.6` | 所选图片文件对象列表，包含本地临时文件路径 path 和文件大小 size（单位 B） |

#### fail 回调参数

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

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

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


### 引用对象

##### `interface` TempFileCB

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `path` | `string` | `3.2.6` | 本地临时文件路径 (本地路径) |
| `size` | `number` | `3.2.6` | 本地临时文件大小，单位 B |


### 示例代码

#### Demo

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

// 从相册选择或拍照选图（会拉起系统选择器，需手动选择）
chooseImage({
  count: 1,
  sizeType: ["compressed"],
  sourceType: ["album", "camera"],
  success: data => console.log("已选图片：", data.tempFilePaths),
  fail: error => console.error(error),
});
```