Guides

Welcome to the Guides section. Here you'll find practical, task-oriented walkthroughs to help you implement common features and customizations for the uploader. These guides build on the concepts introduced in the Getting Started section, providing step-by-step instructions for real-world scenarios.
These guides cover both the frontend @blocklet/uploader component and optional backend customizations with @blocklet/uploader-server. Remember, the frontend component can work independently, while the backend package is used for adding custom server-side upload handling and enabling remote sources.
Configuring Plugins
Learn how to enable, disable, and pass custom options to Uppy plugins like the Image Editor, Webcam, and URL importer.
Handling Uploads
Implement callbacks on both the frontend and backend to process files after a successful upload and access their metadata.
Integrating Remote Sources
Set up the Companion middleware on your backend to allow users to import files from remote sources like Unsplash and direct URLs.
Creating a Custom Plugin
Extend the Uploader's functionality by creating your own custom plugin tab using the provided VirtualPlugin component.
After working through these guides, you'll have a solid understanding of how to tailor the uploader to your specific needs. For more in-depth information, you can dive into the API Reference.

Overview

Getting Started

Guides

API Reference

Concepts

Guides

Configuring Plugins

Handling Uploads

Integrating Remote Sources

Creating a Custom Plugin

Backend Setup (@blocklet/uploader-server)

Configuring Plugins