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

caption: navigator
created: 20131024141900000
modified: 20211127023932158
tags: Widgets MessageHandlerWidgets
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 links outside the story river: at the ''top'' or ''bottom'' of the story river|
|relinkOnRename|<<.from-version "5.1.14">> Determines if tags in other tiddlers are renamed if the tiddler title changes. ''yes'' or ''no''. default: ''no''|

! Widget Messages

The following [[Messages]] are handled by the navigator widget:

<ul>
<$list filter="[tag[navigator-message]]">
<li>
<$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

! Examples

See [[Creating SubStories]].
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 07:47:26 +00:00			`caption: navigator`
Better documentation for widget messages 2014-02-26 19:55:42 +00:00			`created: 20131024141900000`
Add NavigatorWidget example (#6285) * Add NavigatorWidget example * Moved NavigatorWidget example into the 'Creating SubStories' tiddler * Fixed link: NavigationMechanism => HistoryMechanism 2021-11-27 07:58:29 +00:00			`modified: 20211127023932158`
Added MessageHandlerWidgets and TriggeringWidgets tags (#6161) 2021-11-01 12:56:52 +00:00			`tags: Widgets MessageHandlerWidgets`
Better documentation for widget messages 2014-02-26 19:55:42 +00:00			`title: NavigatorWidget`
			`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`

More reference docs mangling 2014-09-11 14:52:47 +00:00			`The navigator widget manipulates the current store, the story list and history lists in response to various [[Messages]].`
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`

More reference docs mangling 2014-09-11 14:52:47 +00:00			`The navigator widget displays any contained content, and responds to Messages dispatched within it.`
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
			`\|!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 \|`
Refactor navigator widget configuration @felixhayashi sorry I should have realised earlier that it’s worth doing it this way so that we can have different settings for different story rivers. 2015-06-19 15:44:20 +00:00			`\|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 \|`
Fix miscellaneous docs typos (#7143) 2022-12-21 10:07:14 +00:00			`\|openLinkFromOutsideRiver\|Determines the location for opening new tiddlers from links outside the story river: at the ''top'' or ''bottom'' of the story river\|`
Update navigator widgets parameter docs (#4828) Update navigator widgets parameter docs 2020-08-27 14:36:13 +00:00			`\|relinkOnRename\|<<.from-version "5.1.14">> Determines if tags in other tiddlers are renamed if the tiddler title changes. ''yes'' or ''no''. default: ''no''\|`
Better documentation for widget messages 2014-02-26 19:55:42 +00:00
			`! Widget Messages`

More reference docs mangling 2014-09-11 14:52:47 +00:00			`The following [[Messages]] are handled by the navigator widget:`
Better documentation for widget messages 2014-02-26 19:55:42 +00:00
			`<ul>`
			`<$list filter="[tag[navigator-message]]">`
			`<li>`
Update NavigatorWidget.tid (#4733) 2020-06-27 12:11:41 +00:00			`<$link/>`
Better documentation for widget messages 2014-02-26 19:55:42 +00:00			`</li>`
			`</$list>`
			`</ul>`
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 07:47:26 +00:00
			`! 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`

Add NavigatorWidget example (#6285) * Add NavigatorWidget example * Moved NavigatorWidget example into the 'Creating SubStories' tiddler * Fixed link: NavigationMechanism => HistoryMechanism 2021-11-27 07:58:29 +00:00			`! Examples`

			`See [[Creating SubStories]].`