Skip to main content

@rtorcato/browser-common / draganddrop

draganddrop

Functions​

enableFileDrop()​

enableFileDrop(element, onDrop): void

Defined in: draganddrop/index.ts:11

Adds drag-and-drop event listeners to an element for basic file drop support.

Example​

import { enableFileDrop } from '@rtorcato/browser-common/draganddrop'
enableFileDrop(dropzone, (files) => upload(files))

Parameters​

element​

HTMLElement

The element to attach listeners to.

onDrop​

(files) => void

Callback for when files are dropped.

Returns​

void

makeDraggable()​

makeDraggable(element, data, effectAllowed?): void

Defined in: draganddrop/index.ts:44

Sets up an element as draggable and attaches dragstart event.

Example​

import { makeDraggable } from '@rtorcato/browser-common/draganddrop'
makeDraggable(card, 'card-42')

Parameters​

element​

HTMLElement

The element to make draggable.

data​

string

The data to set for the drag event.

effectAllowed?​

"link" | "none" | "copy" | "copyLink" | "copyMove" | "linkMove" | "move" | "all" | "uninitialized"

The allowed drag effect (e.g., 'move', 'copy').

Returns​

void

enableTextDrop()​

enableTextDrop(element, onDrop): void

Defined in: draganddrop/index.ts:69

Adds a drop target for plain text data.

Example​

import { enableTextDrop } from '@rtorcato/browser-common/draganddrop'
enableTextDrop(zone, (text) => console.log(text))

Parameters​

element​

HTMLElement

The element to act as a drop target.

onDrop​

(text) => void

Callback for when text is dropped.

Returns​

void

disableDragAndDrop()​

disableDragAndDrop(element): void

Defined in: draganddrop/index.ts:101

Removes drag-and-drop event listeners from an element.

Example​

import { disableDragAndDrop } from '@rtorcato/browser-common/draganddrop'
disableDragAndDrop(dropzone)

Parameters​

element​

HTMLElement

The element to remove listeners from.

Returns​

void