Referência da API
Referência técnica para desenvolvedores que desejam integrar ou estender a funcionalidade do Recortador de Imagem (Image Cropper).
O componente principal do Vue que fornece a interface de recorte de imagem.
<template>
<ImageCropper
:aspect-ratio="aspectRatio"
:output-format="format"
:quality="quality"
@crop-complete="handleCropComplete"
/>
</template>
| Propriedade | Tipo | Padrão | Descrição |
|---|
aspectRatio | number | 'free' | 'free' | Restrição da proporção do recorte |
outputFormat | 'png' | 'jpeg' | 'webp' | 'png' | Formato da imagem de saída |
quality | number[] | [85] | Qualidade JPEG (10-100) |
maxWidth | number | undefined | Largura máxima de saída |
maxHeight | number | undefined | Altura máxima de saída |
| Evento | Payload | Descrição |
|---|
crop-complete | CropResult | Disparado quando o recorte é concluído |
image-loaded | ImageInfo | Disparado quando a imagem de origem é carregada |
error | Error | Disparado quando ocorre um erro |
interface CropResult {
url: string; // URL do Blob da imagem recortada
blob: Blob; // Dados do blob da imagem
canvas: HTMLCanvasElement; // Elemento Canvas
info: {
width: number; // Largura de saída em pixels
height: number; // Altura de saída em pixels
size: number; // Tamanho do arquivo em bytes
format: string; // Formato de saída
};
}
interface ImageInfo {
width: number; // Largura original
height: number; // Altura original
size: number; // Tamanho do arquivo em bytes
type: string; // Tipo MIME
name: string; // Nome original do arquivo
}
interface CropSettings {
aspectRatio: number | "free";
outputFormat: "png" | "jpeg" | "webp";
quality: number;
outputWidth?: number;
outputHeight?: number;
}
const cropperOptions = {
aspectRatio: NaN, // Proporção livre
viewMode: 1, // Restringe a caixa de recorte ao canvas
responsive: true, // Cropper responsivo
restore: false, // Não restaura após redimensionamento
guides: true, // Mostra linhas tracejadas
center: true, // Mostra o indicador central
highlight: false, // Não destaca a área de recorte
cropBoxMovable: true, // Permite mover a caixa de recorte
cropBoxResizable: true, // Permite redimensionar a caixa de recorte
toggleDragModeOnDblclick: false, // Desativa o clique duplo
};
| Método | Parâmetros | Retorno | Descrição |
|---|
getCroppedCanvas() | options? | HTMLCanvasElement | Obtém a área recortada como canvas |
setAspectRatio() | ratio: number | void | Altera a proporção de tela |
reset() | - | void | Restaura para o estado original |
destroy() | - | void | Destrói a instância do cropper |
// Carregar imagem de um arquivo
function loadImageFromFile(file: File): Promise<string> {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onload = (e) => resolve(e.target?.result as string);
reader.onerror = reject;
reader.readAsDataURL(file);
});
}
// Baixar blob como arquivo
function downloadBlob(blob: Blob, filename: string): void {
const url = URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = filename;
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
URL.revokeObjectURL(url);
}
// Converter canvas para blob
function canvasToBlob(canvas: HTMLCanvasElement, format: string, quality?: number): Promise<Blob> {
return new Promise((resolve) => {
canvas.toBlob(resolve, `image/${format}`, quality);
});
}
// Obter dimensões da imagem
function getImageDimensions(src: string): Promise<{ width: number; height: number }> {
return new Promise((resolve) => {
const img = new Image();
img.onload = () =>
resolve({
width: img.naturalWidth,
height: img.naturalHeight,
});
img.src = src;
});
}
// Formatar o tamanho do arquivo para exibição
function formatFileSize(bytes: number): string {
const sizes = ["Bytes", "KB", "MB", "GB"];
if (bytes === 0) return "0 Bytes";
const i = Math.floor(Math.log(bytes) / Math.log(1024));
return Math.round((bytes / Math.pow(1024, i)) * 100) / 100 + " " + sizes[i];
}
// Validar arquivo de imagem
function isValidImageFile(file: File): boolean {
return file.type.startsWith("image/");
}
- Canvas API: Para manipulação de imagens
- File API: Para tratamento de upload de arquivos
- Blob API: Para geração de resultados
- URL.createObjectURL: Para pré-visualização de imagens
- Clipboard API: Para funcionalidade de cópia (opcional)
| Recurso | Chrome | Firefox | Safari | Edge |
|---|
| Funcionalidade base | ✅ 50+ | ✅ 52+ | ✅ 10+ | ✅ 79+ |
| Saída WebP | ✅ 32+ | ✅ 65+ | ✅ 14+ | ✅ 79+ |
| Clipboard API | ✅ 66+ | ✅ 63+ | ✅ 13.1+ | ✅ 79+ |
// Erros de validação de arquivo
class InvalidFileTypeError extends Error {
constructor() {
super("Tipo de arquivo inválido. Por favor, selecione um arquivo de imagem.");
}
}
// Erros de memória
class ImageTooLargeError extends Error {
constructor() {
super("A imagem é muito grande para ser processada neste navegador.");
}
}
// Erros de processamento
class CropProcessingError extends Error {
constructor(message: string) {
super(`O processamento do recorte falhou: ${message}`);
}
}
// Tratamento elegante de erros
function handleCropError(error: Error): void {
if (error instanceof InvalidFileTypeError) {
// Mostrar mensagem de erro de tipo de arquivo
showErrorMessage("Por favor, selecione um arquivo de imagem válido");
} else if (error instanceof ImageTooLargeError) {
// Sugerir redução de tamanho da imagem
showErrorMessage("Imagem muito grande. Por favor, use uma imagem menor");
} else {
// Tratamento genérico de erros
showErrorMessage("Ocorreu um erro. Por favor, tente novamente");
}
}
// Limpar recursos
function cleanup(): void {
// Revogar URLs de blob
blobUrls.forEach((url) => URL.revokeObjectURL(url));
// Destruir a instância do cropper
if (cropper) {
cropper.destroy();
cropper = null;
}
// Limpar referências do canvas
canvasRefs.length = 0;
}
// Processar imagens grandes eficientemente
function processLargeImage(canvas: HTMLCanvasElement): HTMLCanvasElement {
const maxDimension = 4096; // Limite do navegador
const scale = Math.min(maxDimension / canvas.width, maxDimension / canvas.height, 1);
if (scale < 1) {
const scaledCanvas = document.createElement("canvas");
scaledCanvas.width = canvas.width * scale;
scaledCanvas.height = canvas.height * scale;
const ctx = scaledCanvas.getContext("2d");
ctx.drawImage(canvas, 0, 0, scaledCanvas.width, scaledCanvas.height);
return scaledCanvas;
}
return canvas;
}