Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lifenautjoe/droppable
A javascript library to give file dropping super-powers to any HTML element.
https://github.com/lifenautjoe/droppable
drop drop-file drop-files droppable file-dropper file-select file-selector files select-file select-files typescript web
Last synced: 18 days ago
JSON representation
A javascript library to give file dropping super-powers to any HTML element.
- Host: GitHub
- URL: https://github.com/lifenautjoe/droppable
- Owner: lifenautjoe
- License: mit
- Created: 2018-03-23T16:14:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T12:02:45.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T15:13:47.120Z (about 1 month ago)
- Topics: drop, drop-file, drop-files, droppable, file-dropper, file-select, file-selector, files, select-file, select-files, typescript, web
- Language: TypeScript
- Homepage: https://lifenautjoe.github.io/droppable
- Size: 3.66 MB
- Stars: 203
- Watchers: 5
- Forks: 13
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
A javascript library to give file dropping super-powers to any HTML element.
[](https://travis-ci.org/lifenautjoe/droppable)  [](https://coveralls.io/github/lifenautjoe/droppable?branch=master)[](https://badge.fury.io/js/droppable)
## Table of Contents
- [Motivation](#motivation)
- [Features](#features)
- [Usecases](#usecases)
- [Demo](#demo)
- [Basic usage](#basic-usage)
- [Browser Compatibility](#browser-compatibility)
- [Installation](#installation)
* [npm](#npm)
* [Scripts](#scripts)
- [Advanced usage](#advanced-usage)
* [Create a droppable element](#create-a-droppable-element)
* [Listen for dropped files](#listen-for-dropped-files)
* [Remove listener for dropped files](#remove-listener-for-dropped-files)
* [Get the latest dropped files](#get-the-latest-dropped-files)
* [Trigger prompt for files](#trigger-prompt-for-files)
* [Enable prompt for files when clicked](#enable-prompt-for-files-when-clicked)
* [Disable prompt for files when clicked](#disable-prompt-for-files-when-clicked)
* [Enable multiple files drop](#enable-multiple-files-drop)
* [Disable multiple files drop](#disable-multiple-files-drop)
* [Enable append CSS class when files are dragged on element](#enable-append-css-class-when-files-are-dragged-on-element)
* [Disable append CSS class when files are dragged on element](#disable-append-css-class-when-files-are-dragged-on-element)
* [Destroy](#destroy)
- [FAQ](#faq)
* [My droppable element has a border around it when focused](#my-droppable-element-has-a-border-around-it-when-focused)
* [I want to add a style to my droppable element when focused](#i-want-to-add-a-style-to-my-droppable-element-when-focused)
- [Development](#development)
* [Clone the repository](#clone-the-repository)
## Motivation
Wouldn't it be great if you could drop files in any HTML element?
Well now you can! 🎉
## Features
* Restrict drop to single or multiple files
* CSS class added when files are being dragged on top of the HTML element (configurable)
* Clicking on the html element also prompts user for files (configurable)
* Zero dependencies
* Tiny! (~4 KB Minified)
* Accessibility support
## Usecases
When files get dropped or selected into your element you will retrieve them as [File](https://developer.mozilla.org/en-US/docs/Web/API/File) objects. This means **you can do anything you want with the dropped/selected files!**
Here are some concrete usecases.
* Upload the files (e.g. chat media/attachment, file chunking, file sharing)
* Edit the files (e.g. Text editor, image editor)
* Inspect the files (e.g. syntax validator, file stats)
* Encrypt the files ([Yes you can](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/encrypt))
## Demo
You can see the library in action [here](https://lifenautjoe.github.io/droppable/).
## Basic usage
````typescript
const Droppable = require('droppable');
const droppable = new Droppable({
element: document.querySelector('#my-droppable-element')
})
droppable.onFilesDropped((files) => {
console.log('Files were dropped:', files);
});
// Clean up when you're done!
droppable.destroy();
````
## Browser Compatibility
|  |  |  |  |  |  |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| ✔ | ✔ | 10+ ✔ | ✔ | ✔ | ✔ |
## Installation
### npm
```bash
npm install droppable
```
### Scripts
The library is also available as a standalone script in multiple formats (UMD, ES5, ES6 ...).
You can get the latest version from `/dist` or the stable one from the [releases page](https://github.com/lifenautjoe/droppable/releases).
## Advanced usage
### Create a droppable element
````typescript
const Droppable = require('droppable');
const droppable = new Droppable({
element: document.querySelector('#my-droppable-element')
});
````
### Listen for dropped files
```typescript
droppable.onFilesDropped((files) => {
console.log('Files were dropped:', files);
});
```
### Remove listener for dropped files
`onFilesDropped` returns a function which when called removes the event listener
```typescript
const eventRemover = droppable.onFilesDropped((files) => {
console.log('Files were dropped on the element:', files);
});
eventRemover();
```
### Get the latest dropped files
```typescript
const latestDroppedFiles = droppable.getLatestDroppedFiles();
```
### Trigger prompt for files
Sometimes you will want to prompt the users for files without them dropping files or clicking the element.
```typescript
droppable.promptForFiles();
```
### Enable prompt for files when clicked
**This is by default `true`**
The user will be prompted for files when the droppable element is clicked
```typescript
// On instantiation
const droppable = new Droppable({
element,
isClickable: true
})
// On runtime
droppable.setIsClickable(true);
```
### Disable prompt for files when clicked
The user won't be prompted for files when the droppable element is clicked
```typescript
// On instantiation
const droppable = new Droppable({
element,
isClickable: false
})
// On runtime
droppable.setIsClickable(false);
```
### Enable multiple files drop
**This is by default `true`**
The user will be able to drop or select multiple files.
```typescript
// On instantiation
const droppable = new Droppable({
element,
acceptsMultipleFiles: true
})
// On runtime
droppable.setAcceptsMultipleFiles(true);
```
### Disable multiple files drop
The user will be able to drop or select one single file.
```typescript
// On instantiation
const droppable = new Droppable({
element,
acceptsMultipleFiles: false
})
// On runtime
droppable.setAcceptsMultipleFiles(false);
```
### Enable append CSS class when files are dragged on element
**This is by default `true`**
The class `dragover` will be added to the droppable element when files are being dragged on it.
```typescript
// On instantiation
const droppable = new Droppable({
element,
appendStatusClasses: true
})
// On runtime
droppable.setAppendStatusClasses(true);
```
### Disable append CSS class when files are dragged on element
The class `dragover` won't be added to the droppable element when files are being dragged on it.
```typescript
// On instantiation
const droppable = new Droppable({
element,
appendStatusClasses: false
})
// On runtime
droppable.setAppendStatusClasses(false);
```
### Destroy
The library attaches several events to the HTML element made droppable.
The `destroy` function not only removes all of them but also the onFilesDropped listeners.
```typescript
droppable.destroy();
```
## FAQ
### My droppable element has a border around it when focused
The library makes the droppable elements accesible, this means that they can get focused by the user.
Your browser by default adds an outline to the focused items. To remove it, in your css:
```css
#your-droppable-item:focus{
outline: 0;
}
```
### I want to add a style to my droppable element when focused
In your css:
```css
#your-droppable-item:focus:not(:active){
// Here you can do anything! For example adding a shadow
box-shadow: 0 0 0 0.125em rgba(111, 14, 217, 0.25);
}
```
## Development
### Clone the repository
```bash
git clone [email protected]:lifenautjoe/droppable.git
```
### Use npm commands
* `npm t`: Run test suite
* `npm start`: Runs `npm run build` in watch mode
* `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
* `npm run test:prod`: Run linting and generate coverage
* `npm run build`: Generate bundles and typings, create docs
* `npm run lint`: Lints code
* `npm run commit`: Commit using conventional commit style \([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:\)
Author [Joel Hernandez](https://instagram.com/lifenautjoe)