w

Referensi API

Referensi teknis untuk pengembang yang ingin mengintegrasikan atau memperluas fungsionalitas Image Cropper.

Komponen Inti

Komponen ImageCropper

Komponen Vue utama yang menyediakan antarmuka pemotongan gambar.

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

Props

PropTipeBawaanDeskripsi
aspectRationumber | 'free''free'Batasan rasio aspek pemotongan
outputFormat'png' | 'jpeg' | 'webp''png'Format gambar keluaran
qualitynumber[][85]Kualitas JPEG (10-100)
maxWidthnumberundefinedLebar keluaran maksimum
maxHeightnumberundefinedTinggi keluaran maksimum

Events

EventPayloadDeskripsi
crop-completeCropResultDipicu saat pemotongan selesai
image-loadedImageInfoDipicu saat gambar sumber dimuat
errorErrorDipicu saat terjadi kesalahan

Definisi Tipe

CropResult

interface CropResult {
  url: string; // URL Blob dari gambar yang dipotong
  blob: Blob; // Data blob gambar
  canvas: HTMLCanvasElement; // Elemen canvas
  info: {
    width: number; // Lebar keluaran dalam piksel
    height: number; // Tinggi keluaran dalam piksel
    size: number; // Ukuran file dalam byte
    format: string; // Format keluaran
  };
}

ImageInfo

interface ImageInfo {
  width: number; // Lebar asli
  height: number; // Tinggi asli
  size: number; // Ukuran file dalam byte
  type: string; // Tipe MIME
  name: string; // Nama file asli
}

CropSettings

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

Integrasi Cropper.js

Opsi Konfigurasi

const cropperOptions = {
  aspectRatio: NaN, // Rasio aspek bebas
  viewMode: 1, // Batasi kotak potong ke canvas
  responsive: true, // Pemotong responsif
  restore: false, // Jangan kembalikan setelah mengubah ukuran
  guides: true, // Tampilkan garis putus-putus
  center: true, // Tampilkan indikator tengah
  highlight: false, // Jangan sorot area potong
  cropBoxMovable: true, // Izinkan memindahkan kotak potong
  cropBoxResizable: true, // Izinkan mengubah ukuran kotak potong
  toggleDragModeOnDblclick: false, // Nonaktifkan klik ganda
};

Metode

MetodeParameterKembaliDeskripsi
getCroppedCanvas()options?HTMLCanvasElementDapatkan area potong sebagai canvas
setAspectRatio()ratio: numbervoidUbah rasio aspek
reset()-voidSetel ulang ke status asli
destroy()-voidHancurkan instance pemotong

Fungsi Utilitas

Penanganan File

// Muat gambar dari file
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);
  });
}

// Unduh blob sebagai file
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);
}

Pemrosesan Gambar

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

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

Konversi Format

// Format ukuran file untuk tampilan
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];
}

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

Kompatibilitas Browser

API yang Diperlukan

  • Canvas API: Untuk manipulasi gambar
  • File API: Untuk penanganan unggahan file
  • Blob API: Untuk pembuatan hasil
  • URL.createObjectURL: Untuk pratinjau gambar
  • Clipboard API: Untuk fungsionalitas salin (opsional)

Dukungan Browser

FiturChromeFirefoxSafariEdge
Fungsionalitas inti✅ 50+✅ 52+✅ 10+✅ 79+
Keluaran WebP✅ 32+✅ 65+✅ 14+✅ 79+
Clipboard API✅ 66+✅ 63+✅ 13.1+✅ 79+

Penanganan Kesalahan

Jenis Kesalahan Umum

// Kesalahan validasi file
class InvalidFileTypeError extends Error {
  constructor() {
    super("Jenis file tidak valid. Silakan pilih file gambar.");
  }
}

// Kesalahan memori
class ImageTooLargeError extends Error {
  constructor() {
    super("Gambar terlalu besar untuk diproses di browser ini.");
  }
}

// Kesalahan pemrosesan
class CropProcessingError extends Error {
  constructor(message: string) {
    super(`Pemrosesan pemotongan gagal: ${message}`);
  }
}

Pemulihan Kesalahan

// Penanganan kesalahan yang anggun
function handleCropError(error: Error): void {
  if (error instanceof InvalidFileTypeError) {
    // Tampilkan pesan kesalahan jenis file
    showErrorMessage("Silakan pilih file gambar yang valid");
  } else if (error instanceof ImageTooLargeError) {
    // Sarankan pengurangan ukuran gambar
    showErrorMessage("Gambar terlalu besar. Silakan gunakan gambar yang lebih kecil");
  } else {
    // Penanganan kesalahan umum
    showErrorMessage("Terjadi kesalahan. Silakan coba lagi");
  }
}

Pengoptimalan Kinerja

Manajemen Memori

// Bersihkan sumber daya
function cleanup(): void {
  // Cabut URL blob
  blobUrls.forEach((url) => URL.revokeObjectURL(url));

  // Hancurkan instance pemotong
  if (cropper) {
    cropper.destroy();
    cropper = null;
  }

  // Bersihkan referensi canvas
  canvasRefs.length = 0;
}

Penanganan Gambar Besar

// Proses gambar besar secara efisien
function processLargeImage(canvas: HTMLCanvasElement): HTMLCanvasElement {
  const maxDimension = 4096; // Batas browser
  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;
}
Apakah halaman ini membantu?