@uppy/dashboard

What is @uppy/dashboard?

@uppy/dashboard is a versatile file uploader UI plugin for Uppy, a modular file uploader for web applications. It provides a drag-and-drop interface, file previews, and progress indicators, making it easy to integrate file uploading capabilities into your web application.

What are @uppy/dashboard's main functionalities?

Drag-and-Drop File Upload

This feature allows users to drag and drop files into a designated area for uploading. The code sample demonstrates how to set up the Uppy Dashboard with drag-and-drop functionality.

const Uppy = require('@uppy/core');
const Dashboard = require('@uppy/dashboard');

const uppy = Uppy();
uppy.use(Dashboard, {
  target: '#drag-drop-area',
  inline: true
});

File Previews

This feature provides previews of the files that are being uploaded. The code sample shows how to configure the Uppy Dashboard to display file previews and upload progress details.

const Uppy = require('@uppy/core');
const Dashboard = require('@uppy/dashboard');

const uppy = Uppy();
uppy.use(Dashboard, {
  target: '#file-preview-area',
  inline: true,
  showLinkToFileUploadResult: true,
  showProgressDetails: true
});

Progress Indicators

This feature shows progress indicators for file uploads. The code sample demonstrates how to set up the Uppy Dashboard to display detailed progress indicators for each file being uploaded.

const Uppy = require('@uppy/core');
const Dashboard = require('@uppy/dashboard');

const uppy = Uppy();
uppy.use(Dashboard, {
  target: '#progress-indicator-area',
  inline: true,
  showProgressDetails: true
});

Other packages similar to @uppy/dashboard

react-dropzone

react-dropzone is a simple React component for creating a file dropzone. It provides a basic drag-and-drop interface for file uploads but lacks the advanced features and customization options available in @uppy/dashboard.

fine-uploader

fine-uploader is a comprehensive JavaScript library for file uploads. It offers a wide range of features, including drag-and-drop, file previews, and progress indicators, similar to @uppy/dashboard. However, it is not as modular and may require more configuration.

dropzone

dropzone is a popular JavaScript library for drag-and-drop file uploads. It provides a straightforward API and a customizable UI, but it does not offer the same level of modularity and extensibility as @uppy/dashboard.

README

@uppy/dashboard

Dashboard is a universal UI plugin for Uppy:

• Drag and Drop, paste, select from local disk / my device
• UI for Webcam and remote sources: Google Drive, Dropbox, Instagram (all optional, added via plugins)
• File previews and info
• Metadata editor
• Progress: total and for individual files
• Ability to pause/resume or cancel (depending on uploader plugin) individual or all files

Read the docs | Try it

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import Dashboard from '@uppy/dashboard'

const uppy = new Uppy()
uppy.use(Dashboard, {
  target: 'body',
  inline: true,
})

Installation

$ npm install @uppy/dashboard

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit’s CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.

Changelog

4.1.0

Released: 2024-07-30

| Package | Version | Package | Version | | -------------------- | ------- | -------------------- | ------- | | @uppy/audio | 2.0.1 | @uppy/status-bar | 4.0.1 | | @uppy/aws-s3 | 4.0.2 | @uppy/store-default | 4.1.0 | | @uppy/compressor | 2.0.1 | @uppy/transloadit | 4.0.1 | | @uppy/core | 4.1.0 | @uppy/utils | 6.0.1 | | @uppy/dashboard | 4.0.2 | @uppy/webcam | 4.0.1 | | @uppy/remote-sources | 2.1.0 | uppy | 4.1.0 |

• @uppy/remote-sources: fix options type (Merlijn Vos / #5364)
• @uppy/transloadit: do not mark opts as mandatory (Antoine du Hamel / #5375)
• @uppy/compressor: mark quality as optional (Antoine du Hamel / #5374)
• @uppy/aws-s3: improve error when endpoint is not provided (Antoine du Hamel / #5361)
• @uppy/core,@uppy/store-default: export Store type (Merlijn Vos / #5373)
• @uppy/dashboard: make toggleAddFilesPanel args consistent (Evgenia Karunus / #5365)
• @uppy/dashboard: Dashboard - convert some files to typescript (Evgenia Karunus / #5359)
• @uppy/audio,@uppy/webcam: Don't use <h1> in Uppy markup (Evgenia Karunus / #5355)
• @uppy/status-bar: GoldenRetriever + hideUploadButton=true (Evgenia Karunus / #5350)
• meta: Bump docker/build-push-action from 6.3.0 to 6.4.1 (dependabot[bot] / #5360)