Getting Started


This guide will walk you through the essential steps to integrate a powerful file uploader into your blocklet. We'll cover both the frontend UI component and the optional backend server setup to get you up and running quickly.

The solution is split into two primary packages:

  • @blocklet/uploader: A React component that provides a rich user interface for uploading files.
  • @blocklet/uploader-server: An Express middleware for your blocklet's backend to handle file storage and processing.

It's important to note that @blocklet/uploader can work independently, especially when integrated with a Media Kit blocklet which provides the necessary backend endpoints. You only need to use @blocklet/uploader-server if you want to implement your own custom upload logic on your server.


To begin, choose the setup guide that matches your needs. We recommend starting with the frontend setup.

After completing these guides, you will have a fully functional file uploader. To explore more advanced features, such as customizing plugins or handling upload callbacks, proceed to the Guides section.