w

API-Referenz

Technische Referenz für Entwickler, die die Image Cropper-Funktionalität integrieren oder erweitern möchten.

Kernkomponenten

ImageCropper-Komponente

Die Haupt-Vue-Komponente, die die Benutzeroberfläche zum Zuschneiden von Bildern bereitstellt.

<template>
  <ImageCropper
    :aspect-ratio="aspectRatio"
    :output-format="format"
    :quality="quality"
    @crop-complete="handleCropComplete"
  />
</template>

Props

PropTypStandardwertBeschreibung
aspectRationumber | 'free''free'Einschränkung des Seitenverhältnisses beim Zuschneiden
outputFormat'png' | 'jpeg' | 'webp''png'Ausgabeformat des Bildes
qualitynumber[][85]JPEG-Qualität (10-100)
maxWidthnumberundefinedMaximale Ausgabebreite
maxHeightnumberundefinedMaximale Ausgabehöhe

Events

EventPayloadBeschreibung
crop-completeCropResultWird ausgelöst, wenn das Zuschneiden abgeschlossen ist
image-loadedImageInfoWird ausgelöst, wenn das Quellbild geladen ist
errorErrorWird ausgelöst, wenn ein Fehler auftritt

Typendefinitionen

CropResult

interface CropResult {
  url: string; // Blob-URL des zugeschnittenen Bildes
  blob: Blob; // Bild-Blob-Daten
  canvas: HTMLCanvasElement; // Canvas-Element
  info: {
    width: number; // Ausgabebreite in Pixeln
    height: number; // Ausgabehöhe in Pixeln
    size: number; // Dateigröße in Bytes
    format: string; // Ausgabeformat
  };
}

ImageInfo

interface ImageInfo {
  width: number; // Ursprüngliche Breite
  height: number; // Ursprüngliche Höhe
  size: number; // Dateigröße in Bytes
  type: string; // MIME-Typ
  name: string; // Ursprünglicher Dateiname
}

CropSettings

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

Cropper.js-Integration

Konfigurationsoptionen

const cropperOptions = {
  aspectRatio: NaN, // Freies Seitenverhältnis
  viewMode: 1, // Begrenzt die Zuschneidebox auf den Canvas
  responsive: true, // Responsiver Cropper
  restore: false, // Nicht nach Größenänderung wiederherstellen
  guides: true, // Gestrichelte Linien anzeigen
  center: true, // Mittelpunktanzeige anzeigen
  highlight: false, // Zuschneidebereich nicht hervorheben
  cropBoxMovable: true, // Verschieben der Zuschneidebox erlauben
  cropBoxResizable: true, // Größenänderung der Zuschneidebox erlauben
  toggleDragModeOnDblclick: false, // Doppelklick deaktivieren
};

Methoden

MethodeParameterRückgabeBeschreibung
getCroppedCanvas()options?HTMLCanvasElementZugeschnittenen Bereich als Canvas erhalten
setAspectRatio()ratio: numbervoidSeitenverhältnis ändern
reset()-voidAuf ursprünglichen Zustand zurücksetzen
destroy()-voidCropper-Instanz zerstören

Dienstprogramm-Funktionen

Dateihandhabung

// Bild aus Datei laden
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);
  });
}

// Blob als Datei herunterladen
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);
}

Bildverarbeitung

// Canvas in Blob konvertieren
function canvasToBlob(canvas: HTMLCanvasElement, format: string, quality?: number): Promise<Blob> {
  return new Promise((resolve) => {
    canvas.toBlob(resolve, `image/${format}`, quality);
  });
}

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

Formatkonvertierung

// Dateigröße für Anzeige formatieren
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];
}

// Bilddatei validieren
function isValidImageFile(file: File): boolean {
  return file.type.startsWith("image/");
}

Browser-Kompatibilität

Erforderliche APIs

  • Canvas API: Für Bildbearbeitung
  • File API: Für Handhabung von Datei-Uploads
  • Blob API: Für Ergebnisgenerierung
  • URL.createObjectURL: Für Bildvorschau
  • Clipboard API: Für Kopierfunktionalität (optional)

Browser-Unterstützung

FunktionChromeFirefoxSafariEdge
Kernfunktionalität✅ 50+✅ 52+✅ 10+✅ 79+
WebP-Ausgabe✅ 32+✅ 65+✅ 14+✅ 79+
Clipboard API✅ 66+✅ 63+✅ 13.1+✅ 79+

Fehlerbehandlung

Häufige Fehlertypen

// Dateivalidierungsfehler
class InvalidFileTypeError extends Error {
  constructor() {
    super("Ungültiger Dateityp. Bitte wählen Sie eine Bilddatei aus.");
  }
}

// Speicherfehler
class ImageTooLargeError extends Error {
  constructor() {
    super("Bild ist zu groß, um in diesem Browser verarbeitet zu werden.");
  }
}

// Verarbeitungsfehler
class CropProcessingError extends Error {
  constructor(message: string) {
    super(`Zuschneideverarbeitung fehlgeschlagen: ${message}`);
  }
}

Fehlerbehebung

// Elegante Fehlerbehandlung
function handleCropError(error: Error): void {
  if (error instanceof InvalidFileTypeError) {
    // Dateityp-Fehlermeldung anzeigen
    showErrorMessage("Bitte wählen Sie eine gültige Bilddatei aus");
  } else if (error instanceof ImageTooLargeError) {
    // Reduzierung der Bildgröße vorschlagen
    showErrorMessage("Bild zu groß. Bitte verwenden Sie ein kleineres Bild");
  } else {
    // Allgemeine Fehlerbehandlung
    showErrorMessage("Ein Fehler ist aufgetreten. Bitte versuchen Sie es erneut");
  }
}

Leistungsoptimierung

Speicherverwaltung

// Ressourcen bereinigen
function cleanup(): void {
  // Blob-URLs widerrufen
  blobUrls.forEach((url) => URL.revokeObjectURL(url));

  // Cropper-Instanz zerstören
  if (cropper) {
    cropper.destroy();
    cropper = null;
  }

  // Canvas-Referenzen löschen
  canvasRefs.length = 0;
}

Handhabung großer Bilder

// Große Bilder effizient verarbeiten
function processLargeImage(canvas: HTMLCanvasElement): HTMLCanvasElement {
  const maxDimension = 4096; // Browser-Limit
  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;
}
War diese Seite hilfreich?