# @ballcat/vue-cropper 中文文档

规范地址：https://npmcn.com/package/%40ballcat/vue-cropper/

版本：1\.0\.6
npm 元数据更新时间：2023-11-08T03:03:29.136Z
中文译文更新时间：2026-11-07T16:05:28.001Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ballcat/vue-cropper
原文对照：https://npmcn.com/package/%40ballcat/vue-cropper/?lang=original

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

- 包体积（解压后）：32.9 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.0\.0
- 运行依赖：1 个
- peer 依赖：vue \>=3\.2\.0
- 首次发布：2022-06-16T23:42:06.004Z
- 最新版本发布：2023-11-08T03:03:28.943Z
- 近 30 天下载量：5547（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

vue 图像收割器, 按收割器

## 安装

```sh
npm install @ballcat/vue-cropper
```

也可以使用：`pnpm add @ballcat/vue-cropper`、`yarn add @ballcat/vue-cropper`、`bun add @ballcat/vue-cropper`

## README

# 恶作剧

由收割机组成的 Vue 图像收割器组件 .

吉图布: [https://github.com/ballcat-projects/vue-cropper (中文(简体) )](https://github.com/ballcat-projects/vue-cropper)

## 演示

在线演示 : [https://ballcat-projects.github.io/vue-cropper (中文(简体) )](https://ballcat-projects.github.io/vue-cropper)

您也可以克隆寄存器并本地运行演示 :

```shell
# clone
git clone https://github.com/ballcat-projects/vue-cropper.git

# enter the folder
cd vue-cropper/example

# install dependency
npm install

# run it
npm run dev
```

## 开始

### 安装

```npm
npm install @ballcat/vue-cropper
```

或者说

```yarn
yarn add @ballcat/vue-cropper
```

### 使用量

#### 全球登记

```vue
import { createApp } from 'vue';
import App from './App';

import VueCropper from '@ballcat/vue-cropper';
import 'cropperjs/dist/cropper.css';

const app = createApp(App);

app.use(VueCropper).mount('#app');
```

#### 地方登记

```vue
<template>
  <vue-cropper 
      ref="vueCropperRef"
      :src="imgSrc"
      alt="Source Image"
  />
</template>
<script>
import {ref, onMounted} from 'vue'
import VueCropper from '@ballcat/vue-cropper';
import 'cropperjs/dist/cropper.css';

export default {
  components: {
    VueCropper,
  },
  setup() {
    const imgSrc = ref('the image path')
    const vueCropperRef = ref(null);

    onMounted(() => {
      console.log(vueCropperRef.value.getData());
    });

    return {
      imgSrc,
      vueCropperRef
    };
  }
};
</script>
```

或使用设置脚本

```vue
<script setup>
import {ref, onMounted} from 'vue'
import VueCropper from '@ballcat/vue-cropper';
import 'cropperjs/dist/cropper.css';

const imgSrc = ref('the image path')
const vueCropperRef = ref(null);

onMounted(() => {
  console.log(vueCropperRef.value.getData());
});
</script>
```

## API 密码

可用 VueCropper 道具分为自定义和所有属性两个部分,由 cropperjs 支持

### 自定义选项

| 财产 | 说明 | 类型 | 需求 |
| :-- | :-- | :-- | :-- |
| 曲线 | 原生图像 src | 字符串 | 真实 |
| 图像化 | img 元素样式 | 对象 | \- 说吧 |
| 缩写 | ing 元素横跨奥里金属性值 | 字符串 | \- 说吧 |
| 备选案文 | img 元素 alt 属性值 | 布尔 | \- 说吧 |

### Cropperjs 选项

见 [copperjs 文档](https://github.com/fengyuanchen/cropperjs/blob/main/README.md)

### 自定义曝光方法

| 方法 | 说明 | 类型 |
| :-- | :-- | :-- |
| 翻转X | 水平翻转图片 | () 无效 |
| 翻转 | 垂直翻转图片 | () 无效 |

## 常见问题

### @ballcat/vue-cropper 是什么？

vue 图像收割器, 按收割器

### 如何安装 @ballcat/vue-cropper？

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

### @ballcat/vue-cropper 支持 TypeScript 吗？

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

### @ballcat/vue-cropper 支持 ESM 还是 CommonJS？

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

### @ballcat/vue-cropper 需要什么版本的 Node\.js？

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

### @ballcat/vue-cropper 可以商用吗？

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

### @ballcat/vue-cropper 的下载量有多少？

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

### @ballcat/vue-cropper 还在维护吗？

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