# @epeejs/antd-img-crop

> An image cropper for Ant Design Upload

Latest version **1.1.1** (published 2022-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @epeejs/antd-img-crop
pnpm add @epeejs/antd-img-crop
yarn add @epeejs/antd-img-crop
bun add @epeejs/antd-img-crop
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2022-04-15 |
| First published | 2021-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 26.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | dobble11, luoqian2019 |
| Keywords | react, antd, ant-design, upload, image, crop, cropper |

## Links

- npm: https://www.npmjs.com/package/@epeejs/antd-img-crop
- Repository: https://github.com/epeejs/react-components/tree/main/packages/antd-img-crop
- npm.io page: https://npm.io/package/@epeejs/antd-img-crop

## Dependencies (1)

- [react-easy-crop](https://npm.io/package/react-easy-crop.md) ^3.5.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2022-04-15
- 1.1.0 — 2021-09-28
- 1.0.1 — 2021-09-08
- 1.0.0 — 2021-09-08

## README

# antd-img-crop

图片裁切工具，用于 Ant Design [Upload](https://ant.design/components/upload-cn/) 组件。

fork from [nanxiaobei/antd-img-crop](https://github.com/nanxiaobei/antd-img-crop)

进行了如下改动

- beforeCrop：返回 `false` 时，仍然会进行文件上传
- quality：图片质量默认值修改为 `0.8`
- 新增 beforeUpload 方法，补充 beforeCrop 不能拦截上传能力
- 不需要单独导入样式文件（已经按需加载）
- 使用 ts 编写

现在上传流程变为 beforeUpload（Crop）-> beforeCrop（Crop）-> beforeUpload（Antd Upload），其中 beforeCrop 只控制是否裁剪，beforeUpload 返回 false 则会终止后面流程

beforeCrop 改动可以支持例如对 gif 图片不裁剪等功能

```tsx
<ImgCrop beforeCrop={(file) => !file.type.includes('gif')}>
  <Upload />
</ImgCrop>
```

`antd-img-crop` 是返回 `false` 则不裁剪，也不会继续上传，如果需要实现原有功能，使用 antd Upload 组件的 `beforeUpload` 函数

## 安装

```sh
yarn add @epeejs/antd-img-crop
```

## 使用

```jsx harmony
import ImgCrop from '@epeejs/antd-img-crop';
import { Upload } from 'antd';

const Demo = () => (
  <ImgCrop>
    <Upload>+ Add image</Upload>
  </ImgCrop>
);
```

## Props

| 属性 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| aspect | `number` | `1 / 1` | 裁切区域宽高比，`width / height` |
| shape | `string` | `'rect'` | 裁切区域形状，`'rect'` 或 `'round'` |
| grid | `boolean` | `false` | 显示裁切区域网格（九宫格） |
| quality | `number` | `0.8` | 图片质量，`0 ~ 1` |
| fillColor | `string` | `'white'` | 裁切图像小于画布时的填充颜色 |
| zoom | `boolean` | `true` | 启用图片缩放 |
| rotate | `boolean` | `false` | 启用图片旋转 |
| minZoom | `number` | `1` | 最小缩放倍数 |
| maxZoom | `number` | `3` | 最大缩放倍数 |
| modalTitle | `string` | `'编辑图片'` | 弹窗标题 |
| modalWidth | `number` \| `string` | - | 弹窗宽度，`px` 的数值或百分比 |
| modalOk | `string` | `'确定'` | 弹窗确定按钮文字 |
| modalCancel | `string` | `'取消'` | 弹窗取消按钮文字 |
| onModalOK | `function` | - | 点击弹窗确定回调 |
| onModalCancel | `function` | - | 点击弹窗遮罩层、右上角叉、取消的回调 |
| beforeCrop | `function` | - | 弹窗打开前调用，若返回 `false`，弹框将不会打开，但任然会执行 ant upload 组件的上传 |
| beforeUpload | `function` | - | beforeCrop 调用前触发，若返回 `false`，将不会进行裁剪与上传操作 |
| onUploadFail | `function` | - | 上传失败时的回调 |
| cropperProps | `object` | - | [react-easy-crop] 的 props（\* [已有 props] 无法重写） |

---
_Source: https://npm.io/package/@epeejs/antd-img-crop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._