@rpldy/upload-drop-zone

Upload Drop Zone

Drop zone (container) component to initiate file and folder content uploads Supports individual files as well as recursively iterating over a dropped directory to upload its contents.

Uses html-dir-content to process the files/directories in the dnd events (DataTransferItem).

Can easily be combined with other D&D solutions.

Drop Zones can use different configuration overrides that supersede the options passed to the parent Uploady.

Note: Some options cannot be overriden by the button. For example, any prop that influences the file input directly (such as 'multiple')

The best place to get started is at our: React-Uploady Documentation Website

Installation

#Yarn: 
   $ yarn add @rpldy/uploady @rpldy/upload-drop-zone 

#NPM:
   $ npm i @rpldy/uploady @rpldy/upload-drop-zone 

Props

Name (* = mandatory)	Type	Default	Description
id	string	undefined	id attribute to pass to the container element
className	string	undefined	the class attribute to pass to the container element
onDragOverClassName	string	undefined	class name to add to the container when dragged over
dropHandler	DropHandlerMethod	undefined	override default handler that returns the drop result (ex: files). May return a promise
htmlDirContentParams	Object	undefined	will be passed as is to html-dir-content. See docs
shouldRemoveDragOver	ShouldRemoveDragOverMethod	undefined	callback to help identify when to remove the onDragOverClassName. Receives the dragleave event
children	React.Node	undefined	child element(s) to render inside the container
extraProps	Object	undefined	any other props to pass to the div component (with spread)

In addition, most UploadOptions props can be passed to UploadDropZone. In order to override configuration passed to the parent Uploady component. See Uploady documentation for detailed list of upload options.

Example

Simple example, shows how upload options can be passed to the drop-zone (grouped, maxGroupSize).

import Uploady from "@rpldy/uploady";
import UploadDropZone from "@rpldy/upload-drop-zone";

const App = () => (
    <Uploady destination={destination}>
        <UploadDropZone onDragOverClassName="drag-over"
                        grouped
                        maxGroupSize={3}
        >
            <span>Drag&Drop File(s) Here</span>            
        </UploadDropZone>
    </Uploady>);

See story showing how to use a 3rd library: react-dnd together with @rpldy/upload-drop-zone.

Changelog

1.1.0-rc.0 (2022-08-21)

PRE-RELEASE

Features

• [uploader] - support fast abort flow (for many items) using new threshold param: fastAbortThreshold

Internal

• [abort] - new package: adds the capability to abort/cancel running & pending uploads
• [raw-uploader] - new package: placeholder package, containing only types