# @capacitor-community/image-manipulator 中文文档

规范地址：https://npmcn.com/package/%40capacitor-community/image-manipulator/

版本：8\.0\.0
npm 元数据更新时间：2026-10-23T21:47:50.380Z
中文译文更新时间：2026-11-09T18:00:21.429Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-community/image-manipulator
原文对照：https://npmcn.com/package/%40capacitor-community/image-manipulator/?lang=original
项目主页：https://github.com/capacitor-community/image-manipulator#readme
源码仓库：https://github.com/capacitor-community/image-manipulator

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：68.8 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.0\.0
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-01-30T11:06:01.562Z
- 最新版本发布：2026-02-09T05:57:59.680Z
- 近 30 天下载量：2029（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 1 个）

## 中文简介

图像操纵器插件旨在操纵图像(大小调整,压缩,裁剪等)

## 安装

```sh
npm install @capacitor-community/image-manipulator
```

也可以使用：`pnpm add @capacitor-community/image-manipulator`、`yarn add @capacitor-community/image-manipulator`、`bun add @capacitor-community/image-manipulator`

## README

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 图像操纵器插件

**`@capacitor-community/image-manipulator`**

控制器社区插件来操纵图像(大小、压缩、裁剪等)

![](https://img.shields.io/maintenance/yes/2024?style=flat-square) [![](https://img.shields.io/npm/l/@capacitor-community/image-manipulator?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/image-manipulator)  
[![](https://img.shields.io/npm/dw/@capacitor-community/image-manipulator?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/image-manipulator) [![](https://img.shields.io/npm/v/@capacitor-community/image-manipulator?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/image-manipulator) [![](https://img.shields.io/badge/all%20contributors-1-orange?style=flat-square)](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-contributors-)

## 目录

-   [维护者](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-maintainers)
-   [关于](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-about)
-   [插件版本](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-plugin-versions)
-   [支持的平台](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-supported-platforms)
-   [安装](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-install)
-   [API 密码](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-api)
-   [解决问题](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-troubleshooting)

## 维护者

| 维护者 | GitHub 图像 | 活动 |
| --- | --- | --- |
| 尼亚a | [尼亚a](https://github.com/ryaa) | 对 |

## 关于

这个capcitor插件允许读取图像维度(宽和高)并调整图像大小. 此插件被启发并类似于 [线多瓦-插图-图像反应器](https://github.com/JoschkaSchulz/cordova-plugin-image-resizer) 插件 。 请注意它并不取决于 **克多瓦-插座-相机** 插件并可以独立使用.

  

**特征 :**

-   支持获取图像维度
-   支持图像的调整大小
-   支持 Android 和 iOS 平台

**页:1**: 插件版本8. 0.0 与 Capacitor 8 兼容

## 插件版本

| 电容版本 | 插件版本 |
| --- | --- |
| 8.x 电话 | 8.x 电话 |
| 7.x 电话 | 7.x 电话 |
| 6.x (单位:千美元) | 6.x (单位:千美元) |

## 支持的平台

-   iOS系统
-   机器人

## 安装

```bash
npm install @capacitor-community/image-manipulator
npx cap sync
```

## API 密码

-   [`getDimensions(...)`](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-getdimensions)
-   [`resize(...)`](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-resize)
-   [接口](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-interfaces)

### 获取 Dimension (...)

```typescript
getDimensions(options: GetDimensionsOptions) => Promise<{ width: number; height: number; }>
```

获取图像的维度( 宽度和高度)

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[GetDimensionsOptions](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-getdimensionsoptions)` | 选项以获取图像的维度 |

**回返情况:** `Promise<{ width: number; height: number; }>`

**自:** 6.0.0 (单位:千美元)

* * *

### 调整大小(...)

```typescript
resize(options: ResizeOptions) => Promise<{ originalWidth: number; originalHeight: number; resizedWidth: number; resizedHeight: number; imagePath: string; webPath: string; resized: boolean; }>
```

根据所提供的选项调整图像大小并返回已调整图像细节的方法 。 请注意: 图像将尊重原始图像的外观比,并将被调整大小以等同于所提供的最大宽度或最大高度. 如果图像的宽度和高度都小于所提供的最大宽度和最大高度,则图像将不会调整大小 而原始图像细节会被重新调整为虚假. 如果不提供最大Width 或最大H8, 此参数将被忽略( 未使用) , 图像将被显示为 根据所提供的最大宽度或最大高度相应调整大小. 请注意, 必须提供最大宽度或最大重度才能调整图像大小 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `[ResizeOptions](https://npmcn.com/package/%40capacitor-community/image-manipulator/#readme-resizeoptions)` | 修改图像大小的选项 |

**回返情况:** `Promise<{ originalWidth: number; originalHeight: number; resizedWidth: number; resizedHeight: number; imagePath: string; webPath: string; resized: boolean; }>`

**自:** 6.0.0 (单位:千美元)

* * *

### 接口

#### 获取 Dimensions 选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`imagePath`** | `string` | 通向图像以获得其维度的路径. | 6.0.0 (单位:千美元) |

#### 更改选项大小

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`imagePath`** | `string` | 改变图像大小的路径 . | 6.0.0 (单位:千美元) |
| **`folderName`** | `string` | (仅限机器人) 存储已调整图像的文件夹名称( 如果未提供可选的, 默认为“ 更改图像 ” ) . | 6.0.0 (单位:千美元) |
| **`fileName`** | `string` | 没有扩展名的修改文件名称( 如果不提供, 可选择, 时间戳为名称) . | 6.0.0 (单位:千美元) |
| **`quality`** | `number` | 图像质量由 0 调整为 100, 其中 100 最大( 如果不提供, 可选择, 默认为 85) . | 6.0.0 (单位:千美元) |
| **`maxWidth`** | `number` | 调整图像的最大宽度( 可选的, 但至少必须提供高度或宽度) . | 6.0.0 (单位:千美元) |
| **`maxHeight`** | `number` | 修改图像的最大高度( 可选的, 但至少必须提供宽度或高度) . | 6.0.0 (单位:千美元) |
| **`fixRotation`** | `boolean` | 根据 EXIF 元数据修正图像旋转( 如果不提供, 可选择的, 默认为假) . | 6.0.0 (单位:千美元) |

## 使用量

请参看 **示例应用程序** 一个完整的例子.

### 修改图像大小

```
import { ImageManipulator } from '@capacitor-community/image-manipulator';

const options: ImageResizeOptions = {
  imagePath: 'path/to/image.jpg',
  maxWidth: 300,
  maxHeight: 300,
  quality: 85,
  folderName: 'ResizedImages',
  fileName: 'resized',
  fixRotation: true
};
const result = await ImageManipulator.resize(options);
```

### 修改图像大小

```
import { ImageManipulator } from '@capacitor-community/image-manipulator';

const options: GetDimensionsOptions = {
  imagePath: 'path/to/image.jpg'
};
const result = await ImageManipulator.getDimensions(options);
```

## 常见问题

### @capacitor-community/image-manipulator 是什么？

图像操纵器插件旨在操纵图像\(大小调整,压缩,裁剪等\)

### 如何安装 @capacitor-community/image-manipulator？

在项目目录运行 npm install @capacitor-community/image-manipulator，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capacitor-community/image-manipulator 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capacitor-community/image-manipulator 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capacitor-community/image-manipulator 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @capacitor-community/image-manipulator 可以商用吗？

@capacitor-community/image-manipulator 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-community/image-manipulator 的下载量有多少？

根据 npm 官方下载统计，@capacitor-community/image-manipulator 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,029 次，日均约 68 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capacitor-community/image-manipulator 还在维护吗？

最新版本 8\.0\.0 发布于 2026/02/09（8 个月前）；至今共发布 3 个版本，其中过去 12 个月发布了 1 个；首次发布于 2025/01/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。