# Cropper
`Cropper` 构造函数用于创建一个新的 Cropper 实例。
## 使用
### 语法
```js
new Cropper(element[, options])
```
- **element**
- 类型:`HTMLImageElement | HTMLCanvasElement | string`
- 要裁剪的目标图像或画布元素。如果是字符串,将传入 [`document.querySelector`](https://developer.mozilla.org/zh-CN/docs/Web/API/Document/querySelector) 中去查找元素。
- **options** (可选)
- 类型:`Object`
- 配置选项。请查看可用的 [选项](#选项)。
或者,您也可以使用 `createCropper(element[, options])`。
### 示例
::: details
<<< @/.vitepress/components/CropperExample.vue
:::
## 选项
| 名称 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| container | `Element \| string` | 默认为目标元素的父元素,如果父元素为空,则为 `document.body`。 | Cropper 容器。如果是字符串,将传入 `document.querySelector` 中去查找元素。 |
| template | `string` | 默认为内置模板,见下文。 | Cropper 模板。 |
Cropper 的默认模板:
```html
```
## 实例属性
| 名称 | 类型 | 描述 |
| --- | --- | --- |
| element | `HTMLImageElement \| HTMLCanvasElement` | 标准化的 Cropper 元素。 |
| options | `Object` | 标准化的 Cropper 选项。 |
| container | `Element` | 标准化的 Cropper 容器。 |
## 实例方法
### getCropperCanvas
- **语法**:`getCropperCanvas()`
- **等同于**:`cropper.container.querySelector('cropper-canvas')`
- **返回值**:
- 类型:`CropperCanvas | null`
- `` 元素(如果有)。
获取 Cropper 容器中的 `` 元素。
### getCropperImage
- **语法**:`getCropperImage()`
- **等同于**:`cropper.container.querySelector('cropper-image')`
- **返回值**:
- 类型:`CropperImage | null`
- `` 元素(如果有)。
获取 Cropper 容器中的 `` 元素。
### getCropperSelection
- **语法**:`getCropperSelection()`
- **等同于**:`cropper.container.querySelector('cropper-selection')`
- **返回值**:
- 类型:`CropperSelection | null`
- `` 元素(如果有)。
获取 Cropper 容器中的 `` 元素。
### getCropperSelections
- **语法**:`getCropperSelections()`
- **等同于**:`cropper.container.querySelectorAll('cropper-selection')`
- **返回值**:
- 类型:`NodeListOf | null`
- `` 元素(如果有)。
当有多个选择时,获取 Cropper 容器中的所有 `` 元素。
### destroy
- **语法**: `destroy()`
注销 Cropper 实例。
## 导出的函数
### createCropper
- **语法**:`createCropper(element[, options])`
- **参数**:
- `element`:
- 类型:`HTMLImageElement | HTMLCanvasElement | string`
- 要裁剪的目标图像或画布元素。如果是字符串,将传入 [`document.querySelector`](https://developer.mozilla.org/zh-CN/docs/Web/API/Document/querySelector) 中去查找元素。
- `options`(可选):
- 类型:`Object`
- 用于裁剪的[选项](#选项)。
- **返回值**:
- 类型:`Cropper`
- 一个新的 Cropper 实例。
创建一个新的 Cropper 实例。
## 导出的模块
```js
import Cropper, {
// 常量
DEFAULT_TEMPLATE,
// 函数
createCropper,
// 元素
CropperElement,
CropperCanvas,
CropperImage,
CropperShade,
CropperHandle,
CropperSelection,
CropperGrid,
CropperCrosshair,
CropperViewer,
} from 'cropperjs';
```