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

caption: linkcatcher
created: 20131024141900000
modified: 20220226121122574
tags: Widgets MessageHandlerWidgets TriggeringWidgets
title: LinkCatcherWidget
type: text/vnd.tiddlywiki

! Introduction

The link catcher widget traps [[WidgetMessage: tm-navigate]] dispatched within its child content by performing any or all of these actions:

* sending a different widget message
* setting a tiddler to the title of the navigated tiddler
* setting a tiddler to a specified value
* performing a series of ActionWidgets

! Content and Attributes

The content of the `<$linkcatcher>` widget is displayed normally.

|!Attribute |!Description |
|to |Optional title of the tiddler to be set to the title of the navigated tiddler |
|message |Optional identifier for a [[widget message|Messages]] to be sent when a navigation is caught  |
|set |Optional title of the tiddler to be set to a specified value when navigation occurs |
|setTo |Value to be assigned by the `set` attribute |
|actions |Actions to be performed when a link is caught. Within the action string, the variable "navigateTo" contains the title of the tiddler being navigated. <<.from-version "5.1.23">> the <<.def "modifier">> variable lists the modifier keys that are pressed when the action is invoked. The possible modifiers are ''ctrl'', ''ctrl-alt'', ''ctrl-shift'', ''alt'', ''alt-shift'', ''shift'' and ''ctrl-alt-shift'' |

<<.tip """<<.from-version "5.2.0">> For more complex use cases involving trapping the <<.param tm-navigate>> message consider the MessageCatcherWidget which provides greater flexibility""">>
LinkCatcherWidget: Add variable containing target tiddler 2017-07-07 11:16:14 +00:00			`caption: linkcatcher`
Update LinkCatcherWidget docs 2014-04-09 10:31:36 +00:00			`created: 20131024141900000`
Docs: mention MessageCatcher widget in LinkCatcher tiddler (#6485) 2022-02-26 18:59:45 +00:00			`modified: 20220226121122574`
Added MessageHandlerWidgets and TriggeringWidgets tags (#6161) 2021-11-01 12:56:52 +00:00			`tags: Widgets MessageHandlerWidgets TriggeringWidgets`
Update LinkCatcherWidget docs 2014-04-09 10:31:36 +00:00			`title: LinkCatcherWidget`
			`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`

Rename "tw-" messages to "tm-" 2014-08-28 20:43:44 +00:00			`The link catcher widget traps [[WidgetMessage: tm-navigate]] dispatched within its child content by performing any or all of these actions:`
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
			`* sending a different widget message`
			`* setting a tiddler to the title of the navigated tiddler`
			`* setting a tiddler to a specified value`
LinkCatcherWidget: Add variable containing target tiddler 2017-07-07 11:16:14 +00:00			`* performing a series of ActionWidgets`
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`

			The content of the `<$linkcatcher>` widget is displayed normally.

			`\|!Attribute \|!Description \|`
			`\|to \|Optional title of the tiddler to be set to the title of the navigated tiddler \|`
More reference docs mangling 2014-09-11 14:52:47 +00:00			`\|message \|Optional identifier for a [[widget message\|Messages]] to be sent when a navigation is caught \|`
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			`\|set \|Optional title of the tiddler to be set to a specified value when navigation occurs \|`
			\|setTo \|Value to be assigned by the `set` attribute \|
Add modifier variable to linkcatcher actionstring (#4758) * Add modifier variable to linkcatcher actionstring * Update LinkCatcherWidget.tid 2020-07-15 11:27:14 +00:00			`\|actions \|Actions to be performed when a link is caught. Within the action string, the variable "navigateTo" contains the title of the tiddler being navigated. <<.from-version "5.1.23">> the <<.def "modifier">> variable lists the modifier keys that are pressed when the action is invoked. The possible modifiers are ''ctrl'', ''ctrl-alt'', ''ctrl-shift'', ''alt'', ''alt-shift'', ''shift'' and ''ctrl-alt-shift'' \|`
LinkCatcherWidget: Add variable containing target tiddler 2017-07-07 11:16:14 +00:00
Docs: mention MessageCatcher widget in LinkCatcher tiddler (#6485) 2022-02-26 18:59:45 +00:00			`<<.tip """<<.from-version "5.2.0">> For more complex use cases involving trapping the <<.param tm-navigate>> message consider the MessageCatcherWidget which provides greater flexibility""">>`