Overview

The Blocklet Uploader is a comprehensive file upload solution designed for blocklets, built upon the robust and extensible Uppy file uploader. It consists of two primary packages that work together to provide a seamless experience, from the user interface in the browser to file processing on the server.

How It Works#

The standard workflow involves the user interacting with the @blocklet/uploader component in your application's frontend. This component then communicates with a backend endpoint, powered by @blocklet/uploader-server, which handles the actual file storage and processing.

It's important to note that @blocklet/uploader can function without a custom backend if a Media Kit blocklet is present, as it provides default upload handling. You only need to install and configure @blocklet/uploader-server when you require custom server-side logic, such as saving file metadata to a specific database after an upload completes.

Key Features#

• Powered by Uppy: Leverages a mature, battle-tested core for reliable uploads.
• Flexible Architecture: Decoupled frontend and backend packages allow for independent use and customization.
• Rich Plugin System: Supports standard Uppy plugins like ImageEditor, Webcam, and Url, plus custom blocklet-specific plugins.
• Remote Source Integration: Easily enable users to import files from external sources like Unsplash using the Companion middleware.
• Customizable Hooks: Provides onUploadFinish callbacks on both the client and server, giving you full control over post-upload processing.
• Automatic Media Kit Integration: Seamlessly detects and configures itself when a Media Kit blocklet is available.

Ready to start? Let's get the uploader integrated into your blocklet.