Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 1.32 KB

README.md

File metadata and controls

73 lines (49 loc) · 1.32 KB
Raw

stimulus-dropzone

A stimulus controller for simple drop zone.

Dependencies

  • @hotwired/stimulus 3.0+

Installation

Install from npm:

$ npm install @kanety/stimulus-dropzone --save

Usage

Register controller:

import { Application } from '@hotwired/stimulus';
import DropzoneController from '@kanety/stimulus-dropzone';

const application = Application.start();
application.register('dropzone', DropzoneController);

Import css:

@import '@kanety/stimulus-dropzone';

Build html as follows:

<div data-controller="dropzone">
  <input type="file">
  <p>Drop here</p>
</div>

Dropped files will be set in the input tag:

options

grow-width, grow-heigth

Grow drop zone size while dragging:

<div data-controller="dropzone"
     data-dropzone-grow-width-value="200px"
     data-dropzone-grow-height-value="300px">
  <input type="file">
  <p>Drop here</p>
</div>

Callbacks

Run callbacks when files are dropped:

let element = document.querySelector('[data-controller="dropzone"]');
element.addEventListener('dropzone:dropped', e => {
  // e.detail.files are dropped files
  console.log("dropped " + e.detail.files);
});

License

The library is available as open source under the terms of the MIT License.