1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-03 06:49:58 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/widgets/ActionSendMessageWidget.tid
Jermolene 3fea51a08b Reorganise docs updates for 5.1.5 additions
We’ll keep the docs for the new features in the prerelease edition
until the release of 5.1.5. This means that we can continue to build
the tw5.com edition without including the 5.1.5-specific content.
2014-10-25 14:24:01 +01:00

32 lines
1.3 KiB
Plaintext

caption: action-sendmessage
created: 20141008134309742
modified: 20141008162952455
tags: Widgets ActionWidgets
title: ActionSendMessageWidget
type: text/vnd.tiddlywiki
! Introduction
The ''action-sendmessage'' widget is an [[action widget|ActionWidgets]] that sends a [[message|WidgetMessages]] back up the widget tree. ActionWidgets are used within triggering widgets such as the ButtonWidget.
! Content and Attributes
The ''action-sendmessage'' widget is invisible. Any content within it is ignored.
|!Attribute |!Description |
|$message |The message to send (eg, [[WidgetMessage: tm-new-tiddler]]) |
|$param |Optional parameter string whose meaning is dependent on the message being sent |
|//{any attributes not starting with $}// |Multiple parameters that are attached to the message if the `$param` attribute is not provided |
! Examples
Here is an example of button that displays both a notification and a wizard, and creates a new tiddler with tags and text:
<$macrocall $name='wikitext-example-without-html'
src='<$button>
<$action-sendmessage $message="tm-modal" $param="SampleWizard"/>
<$action-sendmessage $message="tm-notify" $param="SampleNotification"/>
<$action-sendmessage $message="tm-new-tiddler" title="This is newly created tiddler" tags="OneTag [[Another Tag]]" text=<<now "Today is DDth, MMM YYYY">>/>
Click me!
</$button>'/>