w

Справочник API

Технический справочник для разработчиков, которые хотят интегрировать или расширить функциональность Image Cropper (Обрезка изображений).

Основные компоненты

Компонент ImageCropper

Главный компонент Vue, предоставляющий интерфейс для обрезки изображений.

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

Свойства (Props)

СвойствоТипПо умолчаниюОписание
aspectRationumber | 'free''free'Ограничение соотношения сторон
outputFormat'png' | 'jpeg' | 'webp''png'Формат выходного изображения
qualitynumber[][85]Качество JPEG (10-100)
maxWidthnumberundefinedМаксимальная ширина на выходе
maxHeightnumberundefinedМаксимальная высота на выходе

События (Events)

СобытиеПолезная нагрузкаОписание
crop-completeCropResultСрабатывает при завершении обрезки
image-loadedImageInfoСрабатывает при загрузке исходного изображения
errorErrorСрабатывает при возникновении ошибки

Определения типов

CropResult

interface CropResult {
  url: string; // URL Blob-объекта обрезанного изображения
  blob: Blob; // Данные blob изображения
  canvas: HTMLCanvasElement; // Элемент Canvas
  info: {
    width: number; // Выходная ширина в пикселях
    height: number; // Выходная высота в пикселях
    size: number; // Размер файла в байтах
    format: string; // Выходной формат
  };
}

ImageInfo

interface ImageInfo {
  width: number; // Исходная ширина
  height: number; // Исходная высота
  size: number; // Размер файла в байтах
  type: string; // MIME-тип
  name: string; // Исходное имя файла
}

CropSettings

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

Интеграция с Cropper.js

Параметры конфигурации

const cropperOptions = {
  aspectRatio: NaN, // Свободное соотношение сторон
  viewMode: 1, // Ограничить область обрезки холстом
  responsive: true, // Адаптивный cropper
  restore: false, // Не восстанавливать после изменения размера
  guides: true, // Показывать пунктирные линии
  center: true, // Показывать центральный индикатор
  highlight: false, // Не выделять область обрезки
  cropBoxMovable: true, // Разрешить перемещение области обрезки
  cropBoxResizable: true, // Разрешить изменение размера области обрезки
  toggleDragModeOnDblclick: false, // Отключить двойной клик
};

Методы

МетодПараметрыВозвращаетОписание
getCroppedCanvas()options?HTMLCanvasElementПолучить обрезанную область как холст
setAspectRatio()ratio: numbervoidИзменить соотношение сторон
reset()-voidСбросить в исходное состояние
destroy()-voidУничтожить экземпляр cropper

Утилиты

Работа с файлами

// Загрузка изображения из файла
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 как файла
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);
}

Обработка изображений

// Конвертация холста в blob
function canvasToBlob(canvas: HTMLCanvasElement, format: string, quality?: number): Promise<Blob> {
  return new Promise((resolve) => {
    canvas.toBlob(resolve, `image/${format}`, quality);
  });
}

// Получение размеров изображения
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;
  });
}

Конвертация форматов

// Форматирование размера файла для отображения
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];
}

// Валидация файла изображения
function isValidImageFile(file: File): boolean {
  return file.type.startsWith("image/");
}

Совместимость с браузерами

Необходимые API

  • Canvas API: Для манипуляций с изображениями
  • File API: Для обработки загрузки файлов
  • Blob API: Для генерации результатов
  • URL.createObjectURL: Для предпросмотра изображений
  • Clipboard API: Для функциональности копирования (опционально)

Поддержка браузерами

ФункцияChromeFirefoxSafariEdge
Основные функции✅ 50+✅ 52+✅ 10+✅ 79+
Вывод WebP✅ 32+✅ 65+✅ 14+✅ 79+
Clipboard API✅ 66+✅ 63+✅ 13.1+✅ 79+

Обработка ошибок

Общие типы ошибок

// Ошибки валидации файла
class InvalidFileTypeError extends Error {
  constructor() {
    super("Недопустимый тип файла. Пожалуйста, выберите файл изображения.");
  }
}

// Ошибки памяти
class ImageTooLargeError extends Error {
  constructor() {
    super("Изображение слишком велико для обработки в этом браузере.");
  }
}

// Ошибки обработки
class CropProcessingError extends Error {
  constructor(message: string) {
    super(`Ошибка обработки обрезки: ${message}`);
  }
}

Восстановление после ошибок

// Изящная обработка ошибок
function handleCropError(error: Error): void {
  if (error instanceof InvalidFileTypeError) {
    // Показать сообщение об ошибке типа файла
    showErrorMessage("Пожалуйста, выберите допустимый файл изображения");
  } else if (error instanceof ImageTooLargeError) {
    // Предложить уменьшить размер изображения
    showErrorMessage(
      "Изображение слишком велико. Пожалуйста, используйте изображение меньшего размера",
    );
  } else {
    // Общая обработка ошибок
    showErrorMessage("Произошла ошибка. Пожалуйста, попробуйте снова");
  }
}

Оптимизация производительности

Управление памятью

// Очистка ресурсов
function cleanup(): void {
  // Отзыв URL blob-объектов
  blobUrls.forEach((url) => URL.revokeObjectURL(url));

  // Уничтожение экземпляра cropper
  if (cropper) {
    cropper.destroy();
    cropper = null;
  }

  // Очистка ссылок на холст
  canvasRefs.length = 0;
}

Обработка больших изображений

// Эффективная обработка больших изображений
function processLargeImage(canvas: HTMLCanvasElement): HTMLCanvasElement {
  const maxDimension = 4096; // Лимит браузера
  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;
}
Была ли эта страница полезной?