mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 13:29:56 +00:00
Code Issues Releases Wiki Activity

Docs update for list widget

Browse Source
This commit is contained in:
Jeremy Ruston 2013-11-05 08:52:46 +00:00
parent aa79b4aff1
commit 786f17d3b4
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
editions/tw5.com/tiddlers/widgets/ListWidget.tid
View File

@ -26,21 +26,20 @@ The content of the `<$list>` widget is an optional template to use for rendering
|editTemplate |An alternative template to use for DraftTiddlers in edit mode | |editTemplate |An alternative template to use for DraftTiddlers in edit mode |
|variable |The [[widget variable|WidgetVariables]] name to be assigned the title of each tiddler in the list. Defaults to ''currentTiddler'' | |variable |The [[widget variable|WidgetVariables]] name to be assigned the title of each tiddler in the list. Defaults to ''currentTiddler'' |
|emptyMessage |Message to be displayed when the list is empty | |emptyMessage |Message to be displayed when the list is empty |
|listview |Optional name of module responsible for animating/processing the list | |storyview |Optional name of module responsible for animating/processing the list |
|history |The title of the tiddler containing the navigation history | |history |The title of the tiddler containing the navigation history |
//`listview` and `history` are temporarily unimplemented //
!! Handling edit mode !! Handling edit mode
The `<$list>` widget can optionally render draft tiddlers through a different template tiddler than ordinary tiddlers -- see DraftMechanism for a discussion of how this capability is used. The `<$list>` widget can optionally render draft tiddlers through a different template tiddler than ordinary tiddlers -- see DraftMechanism for a discussion of how this capability is used.
!! `listview` attribute !! `storyview` attribute
The `listview` attribute gives the specifies the name of an optional module that can animate changes to the list (including navigation). The core ships with the following listview modules: The `storyview` attribute gives the specifies the name of an optional module that can animate changes to the list (including navigation). The core ships with the following storyview modules:
* `classic`: renders the list as an ordered sequence of tiddlers * `classic`: renders the list as an ordered sequence of tiddlers
* `zoomin`: just renders the current tiddler from the list, with a zoom animation for navigating between tiddlers * `zoomin`: just renders the current tiddler from the list, with a zoom animation for navigating between tiddlers
* `pop`: shrinks items in and out of place
!! Handling history and navigation !! Handling history and navigation