API Reference

Welcome to the API reference for the Blocklet Uploader packages. This section provides comprehensive details on all exported components, functions, props, and configuration options for both the frontend and backend libraries. This is your go-to resource for in-depth technical information.
The uploader is split into two main packages:
@blocklet/uploader: A flexible React component for your application's frontend.
@blocklet/uploader-server: A set of Express middleware for handling file uploads on your backend.
While they are designed to work together seamlessly, it's important to note that @blocklet/uploader can be used with any backend that supports the Tus resumable upload protocol. @blocklet/uploader-server provides a powerful, pre-configured solution for handling upload logic within your Blocklet, but its use is optional.

Select a package below to dive into its detailed API documentation.
Frontend: @blocklet/uploader
Explore the props, components, hooks, and utility functions available in the frontend React package for creating a rich file upload experience.
Backend: @blocklet/uploader-server
A detailed reference for all server-side middleware functions used for handling file storage, remote sources via Companion, and serving static or dynamic resources.
If you need a higher-level understanding of how these packages are built and how they integrate with other systems, please see our Concepts section.

Overview

Getting Started

Guides

API Reference

Concepts

API Reference

Frontend: @blocklet/uploader

Backend: @blocklet/uploader-server

Creating a Custom Plugin

Frontend: @blocklet/uploader