1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-17 23:34:50 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/widgets/NavigatorWidget.tid
Jermolene 2d0ac7245f Docs and tweaks for #2904
@saqimtiaz I added a dash to separate the words in the variable names
for consistency with other core variables.
2017-06-29 08:47:26 +01:00

43 lines
1.4 KiB
Plaintext

caption: navigator
created: 20131024141900000
modified: 20170629074415261
tags: Widgets
title: NavigatorWidget
type: text/vnd.tiddlywiki
! Introduction
The navigator widget manipulates the current store, the story list and history lists in response to various [[Messages]].
! Content and Attributes
The navigator widget displays any contained content, and responds to Messages dispatched within it.
|!Attribute |!Description |
|story |Name of the tiddler containing the story list to be manipulated |
|history |Name of the tiddler containing the history list to be manipulated |
|openLinkFromInsideRiver |Determines the location for opening new tiddlers from links within the story river: at the ''top'' or ''bottom'' of the story river, or ''above'' or ''below'' the current tiddler |
|openLinkFromOutsideRiver|Determines the location for opening new tiddlers from linkes outside the story river: at the ''top'' or ''bottom'' of the story river|
! Widget Messages
The following [[Messages]] are handled by the navigator widget:
<ul>
<$list filter="[tag[navigator-message]]">
<li>
<$link to={{!!title}}>
<$view field="title"/>
</$link>
</li>
</$list>
</ul>
! Variables
The following [[Variables]] are assigned by the navigator widget:
* <<.vlink tv-story-list>>, giving the name of the tiddler containing the story list
* <<.vlink tv-history-list>>, giving the name of the tiddler containing the history list