1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 05:19:57 +00:00

Update MessageCatcher docs to clarify usage (#5870)

This commit is contained in:
Saq Imtiaz 2021-07-11 23:39:24 +02:00 committed by GitHub
parent 30925ee7bf
commit b0604a9bf5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,5 +1,5 @@
created: 20210309133636211 created: 20210309133636211
modified: 20210309133636211 modified: 20210711193113104
tags: Widgets tags: Widgets
title: MessageCatcherWidget title: MessageCatcherWidget
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -15,9 +15,9 @@ The message catcher widget traps [[messages|Messages]] dispatched within its chi
The content of the `<$messagecatcher>` widget is displayed normally. The content of the `<$messagecatcher>` widget is displayed normally.
|!Attribute |!Description | |!Attribute |!Description |
|type |Name of the message be trapped, for example "tm-scroll" or "tm-navigate" | |//{any attributes starting with $}// |Each attribute name (excluding the $) specifies the name of a message, and the value specifies the action string to be invoked |
|actions |Action string to be invoked when a matching message is trapped | |type |Name of the message be trapped, for example "tm-scroll" or "tm-navigate". The `type` and `actions` attributes can be useful when the type of event needs to be specified via a variable or text reference |
|//{any attributes starting with $}// |Each attribute name (excluding the $) specifies the name of a message, and the value specifies the action string to be invoked | |actions |Action string to be invoked when a matching message is trapped. Must be used in conjunction with the `type` attribute |
! Variables ! Variables
@ -41,3 +41,4 @@ Click on [[this link]] to fire an action. See the browser JavaScript console for
</$messagecatcher> </$messagecatcher>
"""/> """/>