TiddlyWiki5/editions/tw5.com/tiddlers/widgets/DropzoneWidget.tid

caption: dropzone
created: 20131024141900000
modified: 20170712153850528
tags: Widgets
title: DropzoneWidget
type: text/vnd.tiddlywiki

! Introduction

The dropzone widget creates an area into which the user can drag files and other objects. It also supports pasting via the clipboard, although browser support is currently limited.

It sends a [[WidgetMessage: tm-import-tiddlers]] carrying a JSON representation of the tiddlers to be imported up through its parents. This message usually trapped by the NavigatorWidget which adds the tiddlers to the store and updates the story to display them.

! Content and Attributes

|!Attribute |!Description |
|deserializer |<<.from-version "5.1.15">> Optional name of deserializer to be used (by default the deserializer is derived from the file extension) |

The list of available deserializers can be inspected by executing `Object.keys($tw.Wiki.tiddlerDeserializerModules).sort().join("\n")` in the browser JavaScript console.

The dropzone widget displays any contained content within the dropzone.

! Display

The dropzone widget creates an HTML `<div class="tc-dropzone">` to contain its content. During a drag operation the class `tc-dragover` is added. CSS is used to provide user feedback.

! Data types supported

The following data transfer types are supported:

* ''text/vnd.tiddler'' - a list of tiddlers in JSON format (this format is generated by the LinkWidget)
* ''text/plain'' - plain text
* ''text/uri-list'' - a list of URIs as a single tiddler
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`caption: dropzone`
Docs updates Starting to document the new drag and drop stuff 2017-03-29 09:19:42 +00:00			`created: 20131024141900000`
Allow manual selection of deserializer for dropping or importing files 2017-07-12 15:42:16 +00:00			`modified: 20170712153850528`
Docs updates Starting to document the new drag and drop stuff 2017-03-29 09:19:42 +00:00			`tags: Widgets`
			`title: DropzoneWidget`
			`type: text/vnd.tiddlywiki`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00
			`! Introduction`

			`The dropzone widget creates an area into which the user can drag files and other objects. It also supports pasting via the clipboard, although browser support is currently limited.`

Rename "tw-" messages to "tm-" 2014-08-28 20:43:44 +00:00			`It sends a [[WidgetMessage: tm-import-tiddlers]] carrying a JSON representation of the tiddlers to be imported up through its parents. This message usually trapped by the NavigatorWidget which adds the tiddlers to the store and updates the story to display them.`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00
			`! Content and Attributes`

Allow manual selection of deserializer for dropping or importing files 2017-07-12 15:42:16 +00:00			`\|!Attribute \|!Description \|`
Add missing version banners to updated docs 2017-07-18 15:15:46 +00:00			`\|deserializer \|<<.from-version "5.1.15">> Optional name of deserializer to be used (by default the deserializer is derived from the file extension) \|`
Allow manual selection of deserializer for dropping or importing files 2017-07-12 15:42:16 +00:00
			The list of available deserializers can be inspected by executing `Object.keys($tw.Wiki.tiddlerDeserializerModules).sort().join("\n")` in the browser JavaScript console.

			`The dropzone widget displays any contained content within the dropzone.`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00
			`! Display`

Change more "tw-" classes to "tc-" Part of #764 2014-08-28 17:21:08 +00:00			The dropzone widget creates an HTML `<div class="tc-dropzone">` to contain its content. During a drag operation the class `tc-dragover` is added. CSS is used to provide user feedback.
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00
			`! Data types supported`

			`The following data transfer types are supported:`

			`* ''text/vnd.tiddler'' - a list of tiddlers in JSON format (this format is generated by the LinkWidget)`
			`* ''text/plain'' - plain text`
			`* ''text/uri-list'' - a list of URIs as a single tiddler`