Wondering what’s next for npm?Check out our public roadmap! »

    react-file-dropzone

    0.4.1 • Public • Published

    react-file-dropzone

    React component for Gmail or Facbook -like drag and drop file uploader. Drag files anywhere onto the window (or user defined "frame" prop)! Very extensible, provides many hooks so you can use it to develop any custom behavior that you desire.

    z2daheaool

    By default, there are no styles! You must include some CSS if you want to see anything!

    Demo/Example

    There's a very simple demo with example code and CSS avaiable here.

    If this doesn't look very fancy, it's because it's not meant to! You are encouraged to style it yourself. You can steal the CSS from the demo site as a base to go off if you wish, but by default there are no styles included, you get just a react component.

    Installation

    Why?

    I wanted that behavior like facebook, gmail, etc. have where a part of the page highlights immediately when you start dragging a file anywhere on the window. I couldn't find any React component that already did this, so, I made one.

    Usage

    • As a module: var FileDrop = require("react-file-dropzone");
    • Stand-alone: window.ReactFileDrop

    How it works

    First, you define the frame prop (default is the document), whenever the user begins dragging file(s) anywhere over this frame, the <div class="file-drop-target"> will be inserted into the DOM.
    Next, define an onDrop prop, whenever a user drops their files onto the target, this callback will be triggered.
    Lastly, you'll need to style it. Check out the Styling section below for details.

    Props

    onDrop - function(files, event)

    Callback when the user drops files onto the target

    onDragOver - function(event)

    Callback when the user is dragging over the target. Also adds the file-drop-dragging-over-target class to the file-drop-target

    onDragLeave - function(event)

    Callback when the user leaves the target. Removes the file-drop-dragging-over-target class from the file-drop-target

    dropEffect - String "copy" || "move" || "link" || "none" (default: "copy")

    Learn more about HTML5 dropEffects

    targetAlwaysVisible - Boolean (default: false)

    If you'd like the file-drop-target div to always be visible (otherwise, it's only visible when the user begins dragging over the frame)

    frame - document || window || HTMLElement (default: document)

    This is the "scope" or frame that the user must drag some file(s) over to kick things off.

    onFrameDragEnter - function(event)

    Callback when the user begins dragging over the frame

    onFrameDragLeave - function(event)

    Callback when the user stops dragging over the frame

    onFrameDrop - function(event)

    Callback when the user drops files anywhere over the frame

    onFrameDrop - function(event)

    Accept only specified mime types. Must be a valid MIME type, for example application/pdf, image/*, audio/aiff, audio/midi

    Styling

    By default, the component comes with no styles. You can grab the demo CSS to get you started.

    .file-drop

    The outer container element

    .file-drop > file-drop-target

    This is the target the user has to drag their files to. It will be inserted into the DOM whenever the user starts dragging over the frame, or if you set targetAlwaysVisible={true}

    .file-drop > .file-drop-target.file-drop-dragging-over-frame

    The file-drop-dragging-over-frame class will be added to the file-drop-target whenever the user begins dragging a file over the frame, and it will be removed when they leave

    .file-drop > .file-drop-target.file-drop-dragging-over-target-accept

    The file-drop-dragging-over-target class will be added to the file-drop-target whenever the user begins dragging a accepted file over the file-drop-target div, and it will be removed when they leave

    .file-drop > .file-drop-target.file-drop-dragging-over-target-reject

    The file-drop-dragging-over-target class will be added to the file-drop-target whenever the user begins dragging a rejected file over the file-drop-target div, and it will be removed when they leave

    Install

    npm i react-file-dropzone

    DownloadsWeekly Downloads

    190

    Version

    0.4.1

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar