caption: list-links-draggable
created: 20170328204925306
modified: 20260206131823536
tags: Macros [[Core Macros]]
title: list-links-draggable Macro
type: text/vnd.tiddlywiki

The <<.def list-links-draggable>> [[macro|Macros]] renders the ListField of a tiddler as a list of links that can be reordered via [[drag and drop|Drag and Drop]].

!! Parameters

; tiddler
: The title of the tiddler containing the list
: <<.from-version 5.4.0>> If the tiddler parameter is not defined it defaults to: <<.var currentTiddler>>

; field
: The name of the field containing the list (defaults to `list`)

; emptyMessage
: Optional wikitext to display if there is no output (tiddler is not existed, field is not existed or empty)

; type
: The element tag to use for the list wrapper (defaults to `ul`)

; subtype
: The element tag to use for the list items (defaults to `li`)

; class
: Optional space separated classes to add to the wrapper element

; itemTemplate
: Optional title of a tiddler to use as the template for rendering list items

; displayField <<.from-version 5.4.0>>
: Optional name of the field to display when the list is rendered. Defaults to the "caption" field; if "caption" is not present, the "title" field is used instead

; startactions <<.from-version "5.4.0">>
: Optional action string that gets invoked when link ''dragging starts''
: <<.var actionTiddler>> variable is available in this action

; endactions <<.from-version "5.4.0">>
: Optional action string that gets invoked when link ''dragging ends'' 
: <<.var actionTiddler>> variable is available in this action

If the `itemTemplate` parameter is not provided then the list items are rendered as simple links. Within the `itemTemplate`, the [[currentTiddler Variable]] refers to the current list item.

<<.macro-examples "list-links-draggable">>