This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

DraggableWidget

18th January 2019 at 8:46am
Widgets

The DraggableWidget creates a DOM element that can be dragged by the user. It only works on browsers that support drag and drop, which typically means desktop browsers, but there are workarounds.

The draggable element can be assigned a list of tiddlers that are used as the payload. If desired it can invoke actions when dragging starts and when it ends. See DragAndDropMechanism for an overview.

Content and Attributes

AttributeDescription
tiddlerOptional title of the payload tiddler for the drag
filterOptional filter defining the payload tiddlers for the drag
classOptional CSS classes to assign to the draggable element. The class tc-draggable is added automatically, and the class tc-dragging is applied while the element is being dragged
tagOptional tag to override the default "div" element
startactionsOptional action string that gets invoked when dragging starts
endactionsOptional action string that gets invoked when dragging ends

Either or both of the tiddler and filter attributes must be specified in order for there to be a payload to drag.

The actionTiddler Variable is accessible in both startactions and endactions. It holds the payload tiddler(s) specified through the tiddler and filter attributes as a Title List using double square brackets to quote titles that include whitespace.

Note that the actionTiddler Variable holds a Title List quoted with double square brackets. This is unlike the DroppableWidget which uses the same variable to pass a single unquoted title.

The LinkWidget incorporates the functionality of the DraggableWidget via the draggable attribute.