> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# previewImage

预览图片。

## 扫码预览

![扫码预览 previewImage](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fmedia%252Fpreview-image%252Findex)

## 使用限制

> \[!WARNING]
> **Android、iOS**：只按字符串形式与 urls 中的完整图片地址匹配，数字下标不能定位图片；传入数字下标时会从第一张图片开始预览。
> **Android、iOS**：调用时忽略 referrerPolicy，预览请求不会应用该策略；调用方配置的 Referrer 策略不生效。

## 支持版本

前端库版本不低于 `0.0.26`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>支持</td></tr>
</tbody>
</table>

## 接入准备

### 前置条件

- urls 至少包含一个有效图片地址；需要指定首图时传入 urls 中的完整图片地址

## 调用方式

### 异步 API

```typescript
previewImage(params: PreviewImageParams): Promise<object>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>current</code></td><td><code>string | number</code></td><td>否</td><td><code>urls 中的第一张</code></td><td>-</td><td>当前显示图片的链接，或当前显示图片的下标。不填时显示 `urls` 中的第一张。Android、iOS：只按字符串形式与 urls 中的完整图片地址匹配，数字下标不能定位图片。</td></tr>
<tr><td><code>referrerPolicy</code></td><td><code>string</code></td><td>否</td><td><code>-</code></td><td>-</td><td>预览页使用的 Referrer 策略。Android、iOS：调用时忽略 referrerPolicy，预览请求不会应用该策略。</td></tr>
<tr><td><code>showmenu</code></td><td><code>boolean</code></td><td>否</td><td><code>true</code></td><td>-</td><td>是否显示长按菜单，菜单支持保存图片至本地相册。</td></tr>
<tr><td><code>urls</code></td><td><code>string[]</code></td><td>是</td><td>-</td><td>-</td><td>需要预览的图片链接列表。</td></tr>
</tbody>
</table>

## 调用示例

```typescript
import { previewImage } from '@doubao-dev/framework/api';

await previewImage({
  urls: ['https://example.com/a.png', 'https://example.com/b.png'],
  current: 'https://example.com/a.png'
});
```

## 成功返回

无返回字段。

### 返回示例

```json
{}
```
