2.0.0 • Published 4 years ago

react-drop-region v2.0.0

Weekly downloads
32
License
MIT
Repository
-
Last release
4 years ago

Installation

npm install react-drop-region

or

yarn add react-drop-region

Usage

Live demo: CodeSandbox

import DropRegion from "react-drop-region";

export default function DropRegionDemo() {
  const [isHovering, setIsHovering] = useState(false);

  return (
    <DropRegion
      setIsHovering={isHovering => {
        setIsHovering(isHovering);
      }}
      handleAcceptedFiles={files => {
        console.log("Accepted files: ", files);
      }}
    >
      <div
        className="drop-region"
        style={{ height: 150, width: 300, border: "2px dashed hotpink" }}
      >
        {isHovering ? "Drop here" : "Drag and drop to upload"}
      </div>
    </DropRegion>
  );
}

Props

* indicates that the prop is required.

PropsTypeDefaultDescription
handleAcceptedFiles*function-returns accepted files as an array.
handleRejectedFilesfunction-returns rejected files as an array.
handleProgressfunction-is fired periodically as the files are being uploaded.
setIsHoveringfunction-returns true, if user is dragging over DropRegion.
onDropfunction-is invoked when upon drop event.
onDragEnterfunction-is invoked upon dragEnter event.
onDragLeavefunction-is invoked upon dragLeave or dragExit events.
onErrorfunction-is invoked, if an error occurs during uploading files.
readAsstringreadAsDataURLspecifies reading method.
allowMultiplebooleantrueif true, user may upload more than one file.
disablebooleanfalseif true, user cannot upload files.
allowKeyboardbooleantrueif true, user can open file dialog by pressing Enter or Space keys.
allowClickbooleantrueif true, user can open file dialog by clicking on DropRegion.
validTypesstring[][]pass accepted file types.
showPlaceholderbooleantruePlaceholder is shown while waiting for full image to load
customPlaceholderDOM ElementnullPass your custom placeholder component/element.