Package Home / Demo Guide

Demo Guide

The download bundle includes five standalone demos that cover the most common integration patterns.

How to use these files: start with the closest demo, confirm the markup and constructor options you need, then replace /api/upload with your backend endpoints.

overview.html

Minimal queue, previews, progress, and direct upload. Best starting point for most projects.

  • Default uploader markup
  • Basic uploadUrl setup
  • Shows the standard built-in queue and preview flow

Open overview demo

chunked-upload.html

Large-file upload with chunk endpoints, retry-safe stats, and task progress metrics.

  • chunked, chunkSize, chunkUrl, and chunkCompleteUrl
  • Live stats using onTaskProgress
  • Dynamic headers via headers(task)

Open chunked demo

validation.html

A realistic validation stack combining extensions, MIME patterns, size limits, duplicate protection, and custom rules.

  • allowedExtensions and allowedMimeTypes
  • validateMimeByMagic and preventDuplicates
  • customValidation(file, uploader)

Open validation demo

image-pipeline.html

Pre-upload image transforms including resize, compression, auto-orientation, watermarking, and hashing.

  • imageResize, imageCompress, and watermark
  • autoOrient and computeHash
  • Status output using onImageProcessed and onHashComputed

Open image pipeline demo

events-console.html

Lifecycle tracing demo that makes it easy to understand what fires and when.

  • Queue and task lifecycle callbacks
  • Overall progress logging
  • Helpful when building analytics or debugging integrations

Open events console demo

Recommended order

1. overview.html
2. validation.html
3. chunked-upload.html
4. image-pipeline.html
5. events-console.html