2.4.1 • Published 5 years ago

@zoxllc/material-ui-dropzone v2.4.1

Weekly downloads
22
License
MIT
Repository
github
Last release
5 years ago

material-ui-dropzone

Material-UI-dropzone is a React component using Material-UI and is based on the excellent react-dropzone library.

This components provide either a file-upload dropzone or a file-upload dropzone inside of a dialog. The file-upload dropzone features some snazzy "File Allowed/Not Allowed" effects, previews and alerts.

Installation

npm install --save material-ui-dropzone

Screenshots

This is the component:

When you drag a file onto the dropzone, you get a neat effect:

And if you drop in a wrong type of file, you'll get yelled at:

DropzoneArea Component

This components creates the dropzone, previews and snackbar notifications without a dialog

Usage

import React, {Component} from 'react'
import {DropzoneArea} from 'material-ui-dropzone'

class DropzoneAreaExample extends Component{
  constructor(props){
    super(props);
    this.state = {
      files: []
    };
  }
  handleChange(files){
    this.setState({
      files: files
    });
  }
  render(){
    return (
      <DropzoneArea 
        onChange={this.handleChange.bind(this)}
        />
    )  
  }
} 

export default DropzoneAreaExample;

DropzoneArea Component Properties

NameTypeDefaultDescription
acceptedFilesArray['image/*', 'video/*', 'application/*']A list of file mime types to accept. Does support wildcards.
filesLimitNumber3Maximum number of files that can be loaded into the dropzone
maxFileSizeNumber3000000Maximum file size (in bytes) that the dropzone will accept
dropzoneTextString'Drag and drop an image file here or click'Text in dropzone
dropzoneClassStringnullCustom CSS class name for dropzone container.
showPreviewsBooleanfalseShows previews BELOW the Dropzone
showPreviewsInDropzoneBooleantrueShows preview INSIDE the dropzone
showAlertsBooleantrueshows styled snackbar alerts when files are dropped, deleted or rejected.
dropzoneParagraphClassStringnullCustom CSS class name for text inside the container.
showFileNamesInPreviewBooleanfalseShows file name under the image
showFileNamesBooleanfalseShows file name under the dropzone image.
initialFilesArray[]A list of urls of already uploaded images. Please take care of CORS

DropzoneArea Component Events

NameReturn ParamsDescription
onChangefiles(array)Fired when the user drops files into dropzone or deletes a file. Returns all the files currently loaded into the dropzone.
onDropfiles(array)Fired when the user drops files into the dropzone. Returns the files dropped
onDropRejectedfiles(array)Fired when a file is rejected because of wrong file type, size or goes beyond the filesLimit. Returns the files that were rejected
onDeletefileFired when a file is deleted from the previews panel.

DropzoneArea Componet Get Alert Messages

NameParamsReturn ParamsDescriptionDefault message
getFileLimitExceedMessagefilesLimitStringGet alert message to display when files limit is exceedMaximum allowed number of files exceeded. Only ${filesLimit} allowed
getFileAddedMessagefileNameStringGet alert message to display when a new file is addedFile ${fileName} successfully added.
getFileRemovedMessagefileNameStringGet alert message to display when a file is removedFile ${fileName} removed.
getDropRejectMessagerejectedFile, acceptedFiles, maxFileSizeStringGet alert message to display when a file is removedFile ${rejectedFile.name} was rejected..

DropzoneDialog Component

This component provides the dropzone inside of a dialog.

Usage

import React, { Component } from 'react'
import {DropzoneDialog} from 'material-ui-dropzone'
import Button from '@material-ui/core/Button';

export default class DropzoneDialogExample extends Component {
    constructor(props) {
        super(props);
        this.state = {
            open: false,
            files: []
        };
    }

    handleClose() {
        this.setState({
            open: false
        });
    }

    handleSave(files) {
        //Saving files to state for further use and closing Modal.
        this.setState({
            files: files, 
            open: false
        });
    }

    handleOpen() {
        this.setState({
            open: true,
        });
    }

    render() {
        return (
            <div>
                <Button onClick={this.handleOpen.bind(this)}>
                  Add Image
                </Button>
                <DropzoneDialog
                    open={this.state.open}
                    onSave={this.handleSave.bind(this)}
                    acceptedFiles={['image/jpeg', 'image/png', 'image/bmp']}
                    showPreviews={true}
                    maxFileSize={5000000}
                    onClose={this.handleClose.bind(this)}
                />
            </div>
        );
    }
}

DropzoneDialog Component Properties

NameTypeDefaultDescription
openBooleanfalseRequired. Sets whether the dialog is open or closed
acceptedFilesArray['image/*', 'video/*', 'application/*']A list of file mime types to accept. Does support wildcards.
filesLimitNumber3Maximum number of files that can be loaded into the dropzone
maxFileSizeNumber3000000Maximum file size (in bytes) that the dropzone will accept
showPreviewsBooleanfalseShows previews BELOW the Dropzone
showPreviewsInDropzoneBooleantrueShows preview INSIDE the dropzone
showAlertsBooleantrueshows styled snackbar alerts when files are dropped, deleted or
maxWidthstringsmSets dialog width. Width grows with the size of the screen.
fullWidth.booleantrueIf true, the dialog stretches to maxWidth.

DropzoneDialog Component Events

NameReturn ParamsDescription
onSavefiles(array)Fired when the user clicks the Submit button.
onCloseeventFired when the modal is closed
onChangefiles(array)Fired when the user drops files into dropzone OR deletes a file. Returns all the files currently loaded into the dropzone.
onDropfiles(array)Fired when the user drops files into the dropzone. Returns the files dropped
onDropRejectedfiles(array)Fired when a file is rejected because of wrong file type, size or goes beyond the filesLimit. Returns the files that were rejected
onDeletefileFired when a file is deleted from the previews panel.

License

MIT