w

Referência da API

Referência técnica para desenvolvedores que desejam integrar ou estender a funcionalidade do Recortador de Imagem (Image Cropper).

Componentes Principais

Componente ImageCropper

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>

Propriedades (Props)

PropriedadeTipoPadrãoDescrição
aspectRationumber | 'free''free'Restrição da proporção do recorte
outputFormat'png' | 'jpeg' | 'webp''png'Formato da imagem de saída
qualitynumber[][85]Qualidade JPEG (10-100)
maxWidthnumberundefinedLargura máxima de saída
maxHeightnumberundefinedAltura máxima de saída

Eventos

EventoPayloadDescrição
crop-completeCropResultDisparado quando o recorte é concluído
image-loadedImageInfoDisparado quando a imagem de origem é carregada
errorErrorDisparado quando ocorre um erro

Definições de Tipo

CropResult

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
  };
}

ImageInfo

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
}

CropSettings

interface CropSettings {
  aspectRatio: number | "free";
  outputFormat: "png" | "jpeg" | "webp";
  quality: number;
  outputWidth?: number;
  outputHeight?: number;
}

Integração com Cropper.js

Opções de Configuração

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étodos

MétodoParâmetrosRetornoDescrição
getCroppedCanvas()options?HTMLCanvasElementObtém a área recortada como canvas
setAspectRatio()ratio: numbervoidAltera a proporção de tela
reset()-voidRestaura para o estado original
destroy()-voidDestrói a instância do cropper

Funções Utilitárias

Manipulação de Arquivos

// 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);
}

Processamento de Imagem

// 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;
  });
}

Conversão de Formato

// 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/");
}

Compatibilidade de Navegadores

APIs Necessárias

  • 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)

Suporte de Navegadores

RecursoChromeFirefoxSafariEdge
Funcionalidade core✅ 50+✅ 52+✅ 10+✅ 79+
Saída WebP✅ 32+✅ 65+✅ 14+✅ 79+
Clipboard API✅ 66+✅ 63+✅ 13.1+✅ 79+

Tratamento de Erros

Tipos de Erro Comuns

// 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}`);
  }
}

Recuperação de Erros

// 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");
  }
}

Otimização de Desempenho

Gestão de Memória

// 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;
}

Manipulação de Imagens Grandes

// 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;
}
Esta página foi útil?