How to use the messagecatcher widget to trap a tm-navigate event?

BurningTreeC · April 17, 2022, 9:14am

Hi all,

I’d like to catch the tm-navigate messages produced by links in tiddlers and do something different if the <modifier> variable is Shift
If the modifier variable isn’t Shift the event should be passed through

In the messagecatcher widget’s actions I have access to all needed variables for the tm-navigate message and so I thought I could just simply send a message like:

<$action-sendmessage $message="tm-navigate" navigateTo=<<navigateTo>> navigateFromTitle=<<event-navigateFromTitle>> navigateFromClientRect=<<event-navigateFromClientRect>> ... />

But that doesn’t work.
I cannot use the <$action-navigate/> widget because that doesn’t follow the rules that a tiddler is opened below/above the tiddler where the link was clicked

Do you have an idea how I can do what I want to do?

Thank you,
Simon

saqimtiaz · April 17, 2022, 9:21am

See [IDEA] Ability to propagate caught tm-navigate messages · Issue #6493 · Jermolene/TiddlyWiki5 · GitHub

Yaisog · April 17, 2022, 9:34am

Also see https://talk.tiddlywiki.org/t/executing-actions-on-navigation-clicks/2530/10

Have a nice Easter
Yaisog

jeremyruston · April 17, 2022, 12:08pm

TWPub does it like this:

github.com

TWPUB/TWPUB-Tools/blob/adbf6f34282e010f5259223dfbfd01068f82f99f/plugins/twpub-tools/$/core/ui/Navigator.tid#L19-L55

    
      
          \define navigate-handler()
          <!--
          
          
Traps navigate events within the story river
          
          
-->
          <$let
          	event-paramObject-shiftKey={{{ [<event-shiftKey>!is[blank]else<event-paramObject-shiftKey>] }}}
          	event-paramObject-altKey={{{ [<event-altKey>!is[blank]else<event-paramObject-altKey>] }}}
          	event-paramObject-var-currentTiddler={{{ [<event-navigateTo>!is[blank]else<event-paramObject-var-currentTiddler>] }}}
          >
          <$let
          	defaultStoryConfigurationTiddler={{{ [<event-paramObject-var-currentTiddler>]  :cascade[all[shadows+tiddlers]tag[$:/tags/DefaultStoryFilter]get[text]] }}}
          	storyConfigurationTiddler={{{ [<event-paramObject-storyConfigurationTiddler>!is[blank]] ~[<defaultStoryConfigurationTiddler>] }}}
          	event-paramObject-navigateFromClientLeft={{{ [<event-navigateFromClientLeft>!is[blank]else<event-paramObject-navigateFromClientLeft>] }}}
          	event-paramObject-navigateFromClientTop={{{ [<event-navigateFromClientTop>!is[blank]else<event-paramObject-navigateFromClientTop>] }}}
          	event-paramObject-navigateFromClientWidth={{{ [<event-navigateFromClientWidth>!is[blank]else<event-paramObject-navigateFromClientWidth>] }}}
          	event-paramObject-navigateFromClientHeight={{{ [<event-navigateFromClientHeight>!is[blank]else<event-paramObject-navigateFromClientHeight>] }}}
          	storyDefinitionTiddler={{{ [<storyConfigurationTiddler>get[story-definition]] }}}
          >

This file has been truncated. show original

BurningTreeC · April 17, 2022, 3:32pm

Thank you @jeremyruston , that’s a very sophisticated piece of code
I cannot see how this dispatches the tm-navigate message in case of a normal click
Either it’s too complex for me (what I think it is) or it’s somewhere hidden in the storyConfigurationTiddler (what I think it is)

But I’d really love to get an understanding how this works

jeremyruston · April 17, 2022, 5:21pm

In this case, the further processing of the tm-navigate message is actually done in wikitext.

BurningTreeC · April 18, 2022, 6:14am

And you set the HistoryList tiddler to the given parameters so that a navigation event occurs?

jeremyruston · April 18, 2022, 7:49pm

Hi @BurningTreeC

TWPub uses an expanded set of state tiddlers to keep track of navigation. There are some rough docs that may be helpful - permalinks aren’t currently implemented so I can’t link directly to it, but they are under the link “several experimental enhancements” that point to the tiddler $:/plugins/immateriel/twpub-tools/docs/tiddlywiki-experiments